Ryven: 基于流程的Python可视化脚本编辑器

Ryven简介

Ryven是一个用Python编写的实验性节点编辑器,为Python提供了基于流程的可视化脚本编程接口。它实现了一个基于Qt的可视化界面,允许用户通过连接节点来构建执行任意Python代码的图形。Ryven提供了一个强大的系统来开发执行Python代码的节点,以及一个用于构建使用这些节点的图形的编辑器。

Ryven Logo

Ryven具有许多配置选项,并提供了一个无头模式,可以在没有任何GUI的情况下运行图形。它的核心是ryvencore库,此外还有一些相关的GitHub仓库:

ryvencore: 后端/核心库
ryven-blender, ryven-unreal: Ryven的Blender和UE4插件(已弃用)
PythonOCC nodes for Ryven: 用于PythonOCC(3D CAD)的Ryven节点(进行中,已弃用)
ironflow: 基于ryvencore的pyiron在jupyter中的节点接口(进行中)

ryvencore-qt库为ryvencore添加了基于Qt的GUI类(位于./ryvencore-qt/),而Ryven编辑器则将它们组装成一个功能齐全的跨平台应用程序(位于./ryven-editor/).

安装与配置

安装Ryven非常简单。只要您已经安装了Python和pip,就可以通过PyPI安装Ryven:

pip install ryven

此外,还有一个conda-forge包可供使用:

conda install -c conda-forge ryven

安装完成后,可以通过在命令行中输入ryven来启动Ryven。如果您将Ryven安装到Python虚拟环境(或conda环境)中,则需要先激活该环境。

值得注意的是,Ryven本身只带有一些小的示例节点。您应该使用Ryven来开发节点,或者如果有适合您用例的第三方节点包,可以使用它们。示例节点确实只是示例,没有任何稳定性保证,因此您不应该依赖它们。

安装时,ryven将在用户主目录中创建一个~/.ryven/目录,具有以下结构:

~/.ryven
├── nodes
│   ├── your_nodes_pkg_1
│       ├── nodes.py
│       └── gui.py
│   └── ...
├── saves
│   ├── your_project_1.json
│   └── ...
└── ryven.cfg

ryven.cfg文件包含Ryven的全局配置。

Ryven可以通过四种方式进行配置:

从命令行,例如: ryven --nodes your_nodes_pkg_1 --no-animations
从配置文件,例如在~/.ryven/ryven.cfg中:

nodes = your_nodes_pkg_1 no_animations = True

3. 当它集成到另一个Python应用程序中时,通过参数:
   ```python
   import ryven
   ryven.run_ryven(nodes=['your_nodes_pkg_1'], no_animations=True)

使用启动对话框中的GUI
- 您还可以在对话框中将手动配置转换为命令行参数(或配置文件)

输入ryven --help可以获取可用选项的列表。

要以无头方式(没有任何GUI)部署Ryven项目,请使用ryven-console命令。

编辑器使用指南

以下是Ryven编辑器的快速入门指南:

通过在命令行运行ryven来打开Ryven
您应该会看到启动对话框
创建一个新项目
导入一些示例节点
- File -> Import Example Nodes并选择<installation_dir>/example_nodes/std/nodes.py
您现在应该在左侧看到节点列表
将它们拖放到场景中,并用鼠标连接它们
所有内容都在运行时执行;试试这个:
- 将两个val节点拖入场景
- 用+节点将它们连接在一起
- 在result节点中显示结果
- 现在用生成实数的滑块节点替换其中一个

您可以通过右键单击在场景内获得交互式节点列表预览。还可以用右键按住并拖动来平移,通过ctrl + 滚轮来缩放。

开发节点

Ryven节点包实际上就是一个典型的Python包,其中至少包含一个nodes.py文件,并调用Ryven节点API来公开节点定义。

以下是开发节点包的快速入门指南:

导航到~/.ryven/nodes/并创建以下结构的子目录:

~/.ryven/nodes
└── your_nodes_pkg_1
    ├── __init__.py
    ├── nodes.py
    └── gui.py

在nodes.py中定义您的节点。例如,让我们定义两个基本节点:一个生成随机数,另一个打印它们:

from ryven.node_env import *
from random import random

class RandNode(Node):
    """生成缩放的随机浮点值"""

    title = 'Rand'
    tags = ['random', 'numbers']
    init_inputs = [NodeInputType()]
    init_outputs = [NodeOutputType()]

    def update_event(self, inp=-1):
        self.set_output_val(0, 
            Data(random() * self.input(0).payload)
        )

class PrintNode(Node):
    title = 'Print'
    init_inputs = [NodeInputType()]

    def update_event(self, inp=-1):
        print(self.input(0))

export_nodes([
    RandNode,
    PrintNode,
])

在gui.py中为节点添加GUI:

from qtpy.QtWidgets import QSlider
from qtpy.QtCore import Qt

from ryven.gui_env import *

from . import nodes

class RandSliderWidget(NodeInputWidget, QSlider):
    """一个标准的Qt滑块小部件,每当滑块值改变时
    都会更新它所附加的节点输入"""  
    
    def __init__(self, params):
        NodeInputWidget.__init__(self, params)
        QSlider.__init__(self)
        
        self.setOrientation(Qt.Horizontal)
        self.setMinimumWidth(100)
        self.setMinimum(0)
        self.setMaximum(100)
        self.setValue(50)
        self.valueChanged.connect(self.value_changed)
    
    def value_changed(self, val):
        # 更新此小部件所附加的节点输入
        self.update_node_input(Data(val))
    
    def get_state(self) -> dict:
        # 返回小部件的状态
        return {'value': self.value()}
    
    def set_state(self, state: dict):
        # 设置小部件的状态
        self.setValue(state['value'])
    

@node_gui(nodes.RandNode)
class RandNodeGui(NodeGUI):
    color = '#fcba03'
    
    # 注册输入小部件类
    input_widget_classes = { 'slider': RandSliderWidget }
    
    # 将滑块小部件附加到第一个节点输入
    # 在输入引脚_下方_显示
    init_input_widgets = {
        0: {'name': 'slider', 'pos': 'below'}
    }

现在,您可以在Ryven中导入您的节点包(File -> Import Nodes),将节点放置在图中,并将它们连接起来。添加一个val节点并将其连接到Rand节点,以向其输入提供数据。如果您在val节点的小部件中输入一个数字并按回车键,它会将数字发送到Rand节点,后者会发送一个缩放的随机数到Print节点,最后Print节点会将其打印到标准输出。

注意,默认情况下,标准输出是编辑器内的控制台,您可以通过拖动编辑器窗口底部的蓝色手柄来访问它。

Ryven的主要特性

Ryven具有许多强大的特性,使其成为一个灵活而强大的可视化编程工具:

无头模式: 可以在没有GUI依赖的情况下以高性能运行项目
复杂的节点系统: 允许有状态的节点和小部件
跨平台: 可以在任何Qt运行的地方运行(对于GUI),或者只需要Python(无头模式)
渲染流程图像: 可以将流程图渲染为PNG图像
内置执行流支持: 类似于UE蓝图的功能,这在大多数其他节点编辑器中是没有的
自定义Qt小部件支持: 可以为节点添加自定义的Qt小部件
多种主题: 包括亮色主题
节点右键操作系统: 提供丰富的节点操作选项
变量系统: 具有观察者机制,可以构建自动适应数据变化的节点
基本Python日志支持: 方便进行调试和日志记录

Ryven Editor

许可证

Ryven采用双重许可:

本仓库采用MIT许可证 (LICENSE-MIT 或 http://opensource.org/licenses/MIT)
底层库ryvencore采用LGPL-2.1许可证 (LICENSE-LGPL-2.1 或 https://www.gnu.org/licenses/lgpl-2.1.html)

除非您另有明确说明,否则您有意提交以包含在作品中的任何贡献均应按上述方式获得许可,不附加任何额外条款或条件。

结语

Ryven作为一个强大而灵活的Python可视化编程工具,为开发者提供了一种直观的方式来构建和执行复杂的Python脚本。通过其基于流程的图形界面,用户可以轻松地创建、连接和管理各种节点,从而实现复杂的逻辑和数据处理流程。无论是对于快速原型设计、教育目的,还是复杂的数据处理任务,Ryven都提供了一个理想的平台。

随着开源社区的不断贡献和改进,Ryven有望在未来变得更加强大和易用。对于那些寻求一种创新方式来可视化和简化Python编程的人来说,Ryven无疑是一个值得探索的工具。我们鼓励读者亲自尝试Ryven,探索其丰富的功能,并可能为这个令人兴奋的项目做出贡献。

🚀 立即开始您的Ryven之旅,体验Python可视化编程的魅力吧!