refactor: support position and param meta info

Author: lss233

framework/web/api/workflow/routes.py

@@ -52,7 +52,7 @@ async def get_workflow(group_id: str, workflow_id: str):
             'type_name': block_registry.get_block_type_name(block.__class__),
             'name': block.name,
             'config': builder.nodes_by_name[block.name].spec.kwargs,
-            'position': block.position if hasattr(block, 'position') else {'x': 0, 'y': 0}
+            'position': builder.nodes_by_name[block.name].position if hasattr(builder.nodes_by_name[block.name], 'position') else {'x': 0, 'y': 0}
         })
 
     wires = []
@@ -107,7 +107,9 @@ async def create_workflow(group_id: str, workflow_id: str):
                 builder.use(block_class, name=block_def.name, **block_def.config)
             else:
                 builder.chain(block_class, name=block_def.name, **block_def.config)
-                
+            
+            builder.update_position(block_def.name, block_def.position)
+            
         # 添加连接
         for wire in workflow_def.wires:
             source_block = next(b for b in builder.blocks if b.name == wire.source_block)
@@ -156,6 +158,7 @@ async def update_workflow(group_id: str, workflow_id: str):
             else:
                 builder.chain(block_class, name=block_def.name, **block_def.config)
 
+            builder.update_position(block_def.name, block_def.position)
         # 添加连接
         for wire in workflow_def.wires:
             source_block = next(b for b in builder.blocks if b.name == wire.source_block)

framework/workflow/core/block/__init__.py

@@ -1,5 +1,19 @@
 from .base import Block, ConditionBlock, LoopBlock, LoopEndBlock
 from .registry import BlockRegistry
 from .schema import BlockInput, BlockOutput, BlockConfig
+from .param import ParamMeta
+from .input_output import Input, Output
 
-__all__ = ["Block", "ConditionBlock", "LoopBlock", "LoopEndBlock", "BlockRegistry", "BlockInput", "BlockOutput", "BlockConfig"]
+__all__ = [
+    "Block",
+    "ConditionBlock",
+    "LoopBlock",
+    "LoopEndBlock",
+    "BlockRegistry",
+    "BlockInput",
+    "BlockOutput",
+    "BlockConfig",
+    "ParamMeta",
+    "Input",
+    "Output"
+]

framework/workflow/core/block/param.py

@@ -0,0 +1,14 @@
+from typing import Optional
+
+class ParamMeta:
+    def __init__(self, label: Optional[str] = None, description: Optional[str] = None):
+        self.label = label
+        self.description = description
+        
+    def __repr__(self):
+        return f"ParamMeta(label={self.label}, description={self.description})"
+    
+    def __str__(self):
+        return self.__repr__()
+    
+

framework/workflow/core/block/registry.py

@@ -1,9 +1,72 @@
 from inspect import Parameter, signature
-from typing import Dict, List, Tuple, Type, Optional
+from typing import Dict, List, Tuple, Type, Optional, get_origin, get_args, Annotated, Union
 import warnings
 from framework.workflow.core.block import Block
+from framework.workflow.core.block.param import ParamMeta
 from .schema import BlockConfig, BlockInput, BlockOutput
 
+def extract_block_param(param):
+    """
+    提取 Block 参数信息，包括类型字符串、标签、是否必需、描述和默认值。
+    """
+    param_type = param.annotation
+    required = True
+    label = param.name
+    description = None
+    default = param.default if param.default != Parameter.empty else None
+    
+    if get_origin(param_type) is Annotated:
+        args = get_args(param_type)
+        if len(args) > 0:
+            actual_type = args[0]
+            metadata = args[1] if len(args) > 1 else None
+
+            if isinstance(metadata, ParamMeta):
+                label = metadata.label
+                description = metadata.description
+
+            # 递归调用 extract_block_param 处理实际类型
+            block_config = extract_block_param(Parameter(name=param.name, kind=Parameter.POSITIONAL_OR_KEYWORD, annotation=actual_type, default=default))
+            type_string = block_config.type
+            required = block_config.required  # 继承 required 属性
+        else:
+            type_string = "Any"
+    elif get_origin(param_type) is Union:
+        args = get_args(param_type)
+        # 检查 Union 中是否包含 NoneType
+        if type(None) in args:
+            required = False
+            # 移除 NoneType，并递归处理剩余的类型
+            non_none_args = [arg for arg in args if arg is not type(None)]
+            if len(non_none_args) == 1:
+                block_config = extract_block_param(Parameter(name=param.name, kind=Parameter.POSITIONAL_OR_KEYWORD, annotation=non_none_args[0], default=default))
+                type_string = block_config.type
+            else:
+                # 如果 Union 中包含多个非 NoneType，则返回 Union 类型
+                type_string = f"Union[{', '.join(get_type_name(arg) for arg in non_none_args)}]"
+        else:
+            # 如果 Union 中不包含 NoneType，则直接返回 Union 类型
+            type_string = f"Union[{', '.join(get_type_name(arg) for arg in args)}]"
+    else:
+        type_string = get_type_name(param_type)
+        
+    return BlockConfig(
+        name=param.name,  # 设置名称
+        description=description,
+        type=type_string,
+        required=required,
+        default=default,  # 设置默认值
+        label=label
+    )
+
+def get_type_name(type_obj):
+    """
+    获取类型的名称。
+    """
+    if hasattr(type_obj, '__name__'):
+        return type_obj.__name__
+    return str(type_obj)
+
 class BlockRegistry:
     """Block 注册表，用于管理所有已注册的 block"""
 
@@ -102,21 +165,9 @@ def extract_block_info(self, block_type: Type[Block]) -> Tuple[Dict[str, BlockIn
             if param.name in builtin_params:
                 continue
 
-            param_type = param.annotation
-            # 解 Optional[T] 类型
-            if hasattr(param_type, '__args__') and param_type.__name__ == 'Optional':
+            block_config = extract_block_param(param)
 
-                actual_type = param_type.__args__[0]
-            else:
-                actual_type = param_type
-
-            configs[param.name] = BlockConfig(
-                name=param.name,
-                description='',  # 暂时没有描述信息
-                type=str(actual_type.__name__),
-                required=param.default == Parameter.empty,  # 没有默认值则为必需
-                default=param.default if param.default != Parameter.empty else None
-            )
+            configs[param.name] = block_config
         return inputs, outputs, configs
 
     def get_builtin_params(self) -> List[str]:

framework/workflow/core/block/schema.py

@@ -22,7 +22,8 @@ class BlockOutput(BaseModel):
 class BlockConfig(BaseModel):
     """Block配置项定义"""
     name: str
-    description: str
+    description: Optional[str] = None
     type: str
     required: bool = True
-    default: Optional[Any] = None
+    default: Optional[Any] = None
+    label: Optional[str] = None

framework/workflow/core/workflow/builder.py

@@ -40,6 +40,7 @@ class Node:
     is_loop: bool = False  # 添加 is_loop 标记
     parent: 'Node' = None
     spec: BlockSpec = None
+    position: Optional[Dict[str, int]] = None
 
     def __post_init__(self):
         self.next_nodes = self.next_nodes or []
@@ -339,6 +340,11 @@ def build(self, container: DependencyContainer) -> Workflow:
             block.container = container
 
         return Workflow(self.name, self.blocks, self.wires)
+    
+    def update_position(self, name: str, position: Tuple[int, int]):
+        """更新节点的位置"""
+        node = self.nodes_by_name[name]
+        node.position = position
 
     def save_to_yaml(self, file_path: str, container: DependencyContainer):
         """将工作流保存为 YAML 格式"""
@@ -356,7 +362,8 @@ def serialize_node(node: Node) -> dict:
             block_data = {
                 'type': registry.get_block_type_name(node.block.__class__),
                 'name': node.block.name,
-                'params': node.spec.kwargs
+                'params': node.spec.kwargs,
+                'position': node.position
             }
 
             if node.is_parallel:
@@ -443,7 +450,7 @@ def get_block_class(type_name: str) -> Type[Block]:
                     builder.use(block_class, name=block_data['name'], **params)
                 else:
                     builder.chain(block_class, name=block_data['name'], **params)
-        
+            builder.update_position(block_data['name'], block_data['position'])
         # 第二遍：建立连接
         for block_data in workflow_data['blocks']:
             if 'connected_to' in block_data:

framework/workflow/implementations/blocks/im/messages.py

@@ -1,14 +1,13 @@
 import asyncio
-from typing import Any, Dict, Optional
+from typing import Any, Dict, Optional, Annotated
+
+from pydantic import Field
 from framework.im.adapter import IMAdapter
 from framework.im.manager import IMManager
 from framework.im.message import IMMessage
 from framework.im.sender import ChatSender
 from framework.ioc.container import DependencyContainer
-from framework.workflow.core.block import Block
-from framework.workflow.core.block.input_output import Input
-from framework.workflow.core.block.input_output import Output
-
+from framework.workflow.core.block import Block, Input, Output, ParamMeta
 
 class GetIMMessage(Block):
     """获取 IM 消息"""
@@ -30,7 +29,7 @@ class SendIMMessage(Block):
     outputs = {}
     container: DependencyContainer
 
-    def __init__(self, im_name: Optional[str] = None):
+    def __init__(self, im_name: Annotated[Optional[str], ParamMeta(label="IM 适配器名称")] = None):
         self.im_name = im_name
 
     def execute(self, msg: IMMessage) -> Dict[str, Any]:

framework/workflow/implementations/blocks/im/states.py

@@ -1,12 +1,10 @@
 import asyncio
-from typing import Any, Dict, Optional
+from typing import Annotated, Any, Dict
 from framework.im.adapter import EditStateAdapter, IMAdapter
 from framework.im.message import IMMessage
 from framework.im.sender import ChatSender
 from framework.ioc.container import DependencyContainer
-from framework.workflow.core.block import Block
-from framework.workflow.core.block.input_output import Input
-from framework.workflow.core.block.input_output import Output
+from framework.workflow.core.block import Block, Input, ParamMeta
 
 # Toggle edit state
 class ToggleEditState(Block):
@@ -15,7 +13,7 @@ class ToggleEditState(Block):
     outputs = {}
     container: DependencyContainer
 
-    def __init__(self, is_editing: bool):
+    def __init__(self, is_editing: Annotated[bool, ParamMeta(label="是否编辑", description="是否切换到编辑状态")]):
         self.is_editing = is_editing
 
     def execute(self, sender: ChatSender) -> Dict[str, Any]:

framework/workflow/implementations/blocks/llm/chat.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict, List, Optional
+from typing import Annotated, Any, Dict, List, Optional
 import re
 from framework.llm.format.message import LLMChatMessage
 from framework.llm.format.request import LLMChatRequest
@@ -7,9 +7,7 @@
 from framework.ioc.container import DependencyContainer
 from framework.llm.llm_registry import LLMAbility
 from framework.logger import get_logger
-from framework.workflow.core.block import Block
-from framework.workflow.core.block.input_output import Input
-from framework.workflow.core.block.input_output import Output
+from framework.workflow.core.block import Block, Input, Output, ParamMeta
 from framework.config.global_config import GlobalConfig
 from framework.im.message import IMMessage, TextMessage
 from framework.workflow.core.execution.executor import WorkflowExecutor
@@ -89,7 +87,7 @@ class ChatCompletion(Block):
     outputs = {"resp": Output("resp", "LLM 对话响应", LLMChatResponse, "LLM 对话响应")}
     container: DependencyContainer
 
-    def __init__(self, model_name: Optional[str] = None):
+    def __init__(self, model_name: Annotated[Optional[str], ParamMeta(label="模型 ID", description="要使用的模型 ID")] = None):
         self.model_name = model_name
         self.logger = get_logger("ChatCompletionBlock")
 

framework/workflow/implementations/blocks/memory/chat_memory.py

@@ -1,10 +1,8 @@
-from typing import Any, Dict, List, Optional
+from typing import Annotated, Any, Dict, List, Optional
 from framework.im.message import IMMessage
 from framework.im.sender import ChatSender
 from framework.ioc.container import DependencyContainer
-from framework.workflow.core.block import Block
-from framework.workflow.core.block.input_output import Input
-from framework.workflow.core.block.input_output import Output
+from framework.workflow.core.block import Block, ParamMeta, Input, Output
 from framework.memory.memory_manager import MemoryManager
 from framework.memory.registry import ScopeRegistry, ComposerRegistry, DecomposerRegistry
 from framework.llm.format.response import LLMChatResponse
@@ -15,7 +13,7 @@ class ChatMemoryQuery(Block):
     outputs = {"memory_content": Output("memory_content", "记忆内容", str, "记忆内容")}
     container: DependencyContainer
 
-    def __init__(self, scope_type: Optional[str] = None):
+    def __init__(self, scope_type: Annotated[Optional[str], ParamMeta(label="级别", description="要查询记忆的级别")]):
         self.scope_type = scope_type
 
 
@@ -49,7 +47,7 @@ class ChatMemoryStore(Block):
     outputs = {}
     container: DependencyContainer
 
-    def __init__(self, scope_type: Optional[str] = None):
+    def __init__(self, scope_type: Annotated[Optional[str], ParamMeta(label="级别", description="要查询记忆的级别")]):
         self.scope_type = scope_type
 
     def execute(self, user_msg: IMMessage, llm_resp: LLMChatResponse) -> Dict[str, Any]: