feat: 独立工作流 Block #1440
Merged
feat: 独立工作流 Block #1440
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Updated the duration calculation for simulating typing in the TelegramAdapter to ensure a minimum pause of 2 seconds, improving the user experience during message sending.
- Refactored the workflow builder to replace blocks with nodes, enhancing the structure and clarity of the workflow definition. - Introduced a new method to store wire specifications, allowing for better management of connections between nodes. - Updated the API routes to accommodate the new node-based structure, ensuring compatibility with existing functionality. - Improved error handling and initialization processes for blocks and connections during workflow creation and updates.
Sourcery 代码审查指南此 Pull Request 重构了工作流模块的构建过程，将模块实例化延迟到构建阶段，从而提高了工作流的灵活性和性能。它还包括新的聊天工作流、消息组合的改进以及 Telegram 适配器的调整。 Node 和 BlockSpec 的更新类图classDiagram
class BlockSpec {
-block_class: Type[Block]
-name: Optional[str]
-kwargs: Dict[str, Any]
-wire_from: List[str]
+__post_init__()
}
class Node {
-spec: BlockSpec
-name: Optional[str]
-next_nodes: List[Node]
-merge_point: Node
-parallel_nodes: List[Node]
-is_parallel: bool
-condition: Callable
-is_conditional: bool
-is_loop: bool
-parent: Node
-position: Optional[Dict[str, int]]
+__post_init__()
+ancestors() List[Node]
+is_ancestor_of(node: Node) bool
}
Node -- BlockSpec : has a
WorkflowBuilder 的更新类图classDiagram
class WorkflowBuilder {
-name: str
-description: str
-head: Node
-current: Node
-nodes: List[Node]
-nodes_by_name: Dict[str, Node]
-wire_specs: List[Tuple[str, str, str, str]]
+__init__(name: str)
+_generate_unique_name(base_name: str) str
+_parse_block_spec(block_spec: Union[Type[Block], tuple]) BlockSpec
+_get_available_inputs(node: Node) List[str]
+_find_matching_ports(source_node: Node, target_node: Node, available_inputs: List[str]) List[Tuple[str, str]]
+_store_wire_spec(source_name: str, target_name: str, source_node: Optional[Node], target_node: Optional[Node])
+_create_node(spec: BlockSpec, is_parallel: bool = False) Node
+chain(block_class: Type[Block], name: str = None, **kwargs) WorkflowBuilder
+parallel(block_specs: List[Union[Type[Block], tuple]]) WorkflowBuilder
+end_parallel() WorkflowBuilder
+condition(condition_func: Callable) WorkflowBuilder
+if_then(condition: Callable[[Dict[str, Any]], bool], name: str = None) WorkflowBuilder
+end_if() WorkflowBuilder
+loop(condition: Callable[[Dict[str, Any]], bool], name: str = None, iteration_var: str = "index") WorkflowBuilder
+end_loop() WorkflowBuilder
+build(container: DependencyContainer) Workflow
+force_connect(source_name: str, target_name: str, source_output: str, target_input: str)
+_find_parallel_nodes(start_node: Node) List[Node]
+update_position(name: str, position: Tuple[int, int])
+metadata: Dict[str, Any]
+save_to_yaml(file_path: str, container: DependencyContainer)
+load_from_yaml(file_path: str, container: DependencyContainer) WorkflowBuilder
}
文件级别变更
提示和命令与 Sourcery 互动
自定义您的体验访问您的 仪表板 以：
获取帮助Original review guide in EnglishReviewer's Guide by SourceryThis pull request refactors the workflow block construction process to defer Block instantiation until the build phase, improving workflow flexibility and performance. It also includes new chat workflows, improvements to message composition, and adjustments to the Telegram adapter. Updated class diagram for Node and BlockSpecclassDiagram
class BlockSpec {
-block_class: Type[Block]
-name: Optional[str]
-kwargs: Dict[str, Any]
-wire_from: List[str]
+__post_init__()
}
class Node {
-spec: BlockSpec
-name: Optional[str]
-next_nodes: List[Node]
-merge_point: Node
-parallel_nodes: List[Node]
-is_parallel: bool
-condition: Callable
-is_conditional: bool
-is_loop: bool
-parent: Node
-position: Optional[Dict[str, int]]
+__post_init__()
+ancestors() List[Node]
+is_ancestor_of(node: Node) bool
}
Node -- BlockSpec : has a
Updated class diagram for WorkflowBuilderclassDiagram
class WorkflowBuilder {
-name: str
-description: str
-head: Node
-current: Node
-nodes: List[Node]
-nodes_by_name: Dict[str, Node]
-wire_specs: List[Tuple[str, str, str, str]]
+__init__(name: str)
+_generate_unique_name(base_name: str) str
+_parse_block_spec(block_spec: Union[Type[Block], tuple]) BlockSpec
+_get_available_inputs(node: Node) List[str]
+_find_matching_ports(source_node: Node, target_node: Node, available_inputs: List[str]) List[Tuple[str, str]]
+_store_wire_spec(source_name: str, target_name: str, source_node: Optional[Node], target_node: Optional[Node])
+_create_node(spec: BlockSpec, is_parallel: bool = False) Node
+chain(block_class: Type[Block], name: str = None, **kwargs) WorkflowBuilder
+parallel(block_specs: List[Union[Type[Block], tuple]]) WorkflowBuilder
+end_parallel() WorkflowBuilder
+condition(condition_func: Callable) WorkflowBuilder
+if_then(condition: Callable[[Dict[str, Any]], bool], name: str = None) WorkflowBuilder
+end_if() WorkflowBuilder
+loop(condition: Callable[[Dict[str, Any]], bool], name: str = None, iteration_var: str = "index") WorkflowBuilder
+end_loop() WorkflowBuilder
+build(container: DependencyContainer) Workflow
+force_connect(source_name: str, target_name: str, source_output: str, target_input: str)
+_find_parallel_nodes(start_node: Node) List[Node]
+update_position(name: str, position: Tuple[int, int])
+metadata: Dict[str, Any]
+save_to_yaml(file_path: str, container: DependencyContainer)
+load_from_yaml(file_path: str, container: DependencyContainer) WorkflowBuilder
}
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Codecov ReportAttention: Patch coverage is
✅ All tests successful. No failed tests found.
Additional details and impacted files@@ Coverage Diff @@
## master #1440 +/- ##
==========================================
+ Coverage 67.09% 67.15% +0.05%
==========================================
Files 148 148
Lines 6632 6661 +29
==========================================
+ Hits 4450 4473 +23
- Misses 2182 2188 +6 ☔ View full report in Codecov by Sentry. |
…tion storage - Introduced methods to retrieve available inputs and find matching ports between nodes, improving the connection process. - Updated the _store_wire_spec method to automatically match input and output ports, streamlining the workflow creation. - Refactored existing connection storage calls to utilize the new matching logic, enhancing clarity and reducing manual specification.
- Introduced a new function to remove <think> tags from message text, enhancing message composition clarity. - Updated DefaultMemoryComposer to utilize the new function when composing messages, ensuring cleaner output.
- Renamed workflows in YAML files for better understanding: "DeepSeek R系列聊天" to "聊天 - 深度思考" and "默认 - 角色扮演" to "聊天 - 角色扮演". - Cleared parameters in the msg_sender_lakgf8 block to simplify configuration.
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @lss233 - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider adding a method to the
Workflowclass to encapsulate the block instantiation and wiring logic currently inWorkflowBuilder.build(). - The
_store_wire_specmethod could be simplified by directly using thesource_nodeandtarget_nodeparameters instead of looking them up by name.
Here's what I looked at during the review
- 🟡 General issues: 2 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| if output.data_type == input.data_type: | ||
| matches.append((out_name, in_name)) | ||
| # 一旦找到匹配就从可用输入中移除 | ||
| target_inputs.pop(in_name) |
There was a problem hiding this comment.
issue (bug_risk): Avoid mutating dictionary during iteration in _find_matching_ports.
Removing an item from target_inputs while iterating over its items can lead to unpredictable behavior. Consider iterating over a copy of the keys or using a different approach to avoid mutation during iteration.
| position: | ||
| x: 100 | ||
| y: 138 | ||
| connected_to: |
There was a problem hiding this comment.
nitpick (bug_risk): Duplicate connection entries detected in YAML workflow.
There are duplicate connection entries from the 'get_message' block to 'ToggleEditState_81bvwg' with the same mapping. Confirm that the duplicates are intended and do not result in unintended side effects.
kirara_ai/web/api/workflow/routes.py
Outdated
Comment on lines
51
to
73
| # 构建工作流定义 | ||
| blocks = [] | ||
| for block in builder.blocks: | ||
| position = builder.nodes_by_name[block.name].position | ||
| for node in builder.nodes: | ||
| blocks.append( | ||
| { | ||
| "type_name": block_registry.get_block_type_name(block.__class__), | ||
| "name": block.name, | ||
| "config": builder.nodes_by_name[block.name].spec.kwargs, | ||
| "position": position if position else {"x": 0, "y": 0}, | ||
| "type_name": block_registry.get_block_type_name(node.spec.block_class), | ||
| "name": node.name, | ||
| "config": node.spec.kwargs, | ||
| "position": node.position if node.position else {"x": 0, "y": 0}, | ||
| } | ||
| ) | ||
|
|
||
| wires = [] | ||
| for wire in builder.wires: | ||
| for source_name, source_output, target_name, target_input in builder.wire_specs: | ||
| wires.append( | ||
| { | ||
| "source_block": wire.source_block.name, | ||
| "source_output": wire.source_output, | ||
| "target_block": wire.target_block.name, | ||
| "target_input": wire.target_input, | ||
| "source_block": source_name, | ||
| "source_output": source_output, | ||
| "target_block": target_name, | ||
| "target_input": target_input, | ||
| } | ||
| ) | ||
|
|
There was a problem hiding this comment.
suggestion (code-quality): Convert for loop into list comprehension [×2] (list-comprehension)
Suggested change
| # 构建工作流定义 | |
| blocks = [] | |
| for block in builder.blocks: | |
| position = builder.nodes_by_name[block.name].position | |
| for node in builder.nodes: | |
| blocks.append( | |
| { | |
| "type_name": block_registry.get_block_type_name(block.__class__), | |
| "name": block.name, | |
| "config": builder.nodes_by_name[block.name].spec.kwargs, | |
| "position": position if position else {"x": 0, "y": 0}, | |
| "type_name": block_registry.get_block_type_name(node.spec.block_class), | |
| "name": node.name, | |
| "config": node.spec.kwargs, | |
| "position": node.position if node.position else {"x": 0, "y": 0}, | |
| } | |
| ) | |
| wires = [] | |
| for wire in builder.wires: | |
| for source_name, source_output, target_name, target_input in builder.wire_specs: | |
| wires.append( | |
| { | |
| "source_block": wire.source_block.name, | |
| "source_output": wire.source_output, | |
| "target_block": wire.target_block.name, | |
| "target_input": wire.target_input, | |
| "source_block": source_name, | |
| "source_output": source_output, | |
| "target_block": target_name, | |
| "target_input": target_input, | |
| } | |
| ) | |
| blocks = [ | |
| { | |
| "type_name": block_registry.get_block_type_name( | |
| node.spec.block_class | |
| ), | |
| "name": node.name, | |
| "config": node.spec.kwargs, | |
| "position": node.position if node.position else {"x": 0, "y": 0}, | |
| } | |
| for node in builder.nodes | |
| ] | |
| wires = [ | |
| { | |
| "source_block": source_name, | |
| "source_output": source_output, | |
| "target_block": target_name, | |
| "target_input": target_input, | |
| } | |
| for source_name, source_output, target_name, target_input in builder.wire_specs | |
| ] |
|
|
||
| # 首先实例化所有 Block | ||
| for node in self.nodes: | ||
| try: |
There was a problem hiding this comment.
issue (code-quality): Explicitly raise from a previous error (raise-from-previous-error)
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
工作流 Block 只会在 build 时构造，fixes: #1433
好的，这是翻译成中文的 pull request 总结：
Sourcery 总结
重构工作流块构建过程，将 Block 实例化推迟到构建阶段，从而提高工作流的灵活性和性能
新特性：
Bug 修复：
增强：
Original summary in English
好的，这是翻译成中文的 pull request 总结：
Sourcery 总结
重构工作流块的构建方式，将块的初始化推迟到构建阶段，从而提高工作流的灵活性和性能
新特性：
Bug 修复：
增强：
Original summary in English
Summary by Sourcery
Refactor workflow block construction to defer Block initialization until the build phase, improving workflow flexibility and performance
New Features:
Bug Fixes:
Enhancements: