zhou
13f6110b18
- 将 Strategy 从字符串字面量改为枚举类型，提供 SEQUENTIAL、THREAD 和 ASYNC 选项 - 添加策略归一化函数 _normalize_strategy，支持字符串和枚举类型的输入 - 重构 run 函数接受新的 Strategy 枚举类型，默认值改为 Strategy.SEQUENTIAL - 添加 verbose 模式支持，在任务执行时打印生命周期信息 - 实现命令行运行器 CliRunner，提供命令行界面和参数解析功能 - 为 TaskSpec 添加 verbose 字段，控制子进程命令的详细输出 - 重构 pymake CLI 实现，使用新的命令行运行器架构 - 更新测试用例中的 depends_on 参数语法
124 lines
3.1 KiB
Python
124 lines
3.1 KiB
Python
"""PyFlowX —— 轻量、类型安全的 DAG 任务调度器。
|
|
|
|
公共 API
|
|
--------
|
|
* :class:`TaskSpec` —— 不可变任务描述符（唯一需要配置的东西）。
|
|
* :class:`Graph` —— 由一组 spec 构建的 DAG；负责校验、分层、可视化。
|
|
* :func:`run` —— 以 ``sequential`` / ``thread`` / ``async`` 策略执行图。
|
|
* :class:`RunReport` —— 类型化、可查询的运行结果。
|
|
* :class:`Context` —— 整体上下文注入的标注标记。
|
|
* 状态后端：:class:`StateBackend`、:class:`MemoryBackend`、:class:`JSONBackend`。
|
|
|
|
快速上手
|
|
--------
|
|
import pyflowx as px
|
|
|
|
def extract() -> list[int]: return [1, 2, 3]
|
|
def double(extract: list[int]) -> list[int]: return [x * 2 for x in extract]
|
|
|
|
graph = px.Graph.from_specs([
|
|
px.TaskSpec("extract", extract),
|
|
px.TaskSpec("double", double, ("extract",)),
|
|
])
|
|
report = px.run(graph, strategy="sequential")
|
|
print(report["double"]) # [2, 4, 6]
|
|
|
|
命令行任务示例
|
|
--------------
|
|
import pyflowx as px
|
|
from pyflowx.conditions import IS_WINDOWS, BuiltinConditions
|
|
|
|
graph = px.Graph.from_specs([
|
|
# 使用命令列表
|
|
px.TaskSpec("list_files", cmd=["ls", "-la"]),
|
|
# 使用 shell 命令
|
|
px.TaskSpec("check_git", cmd="git status"),
|
|
# 条件执行：仅在 Windows 上运行
|
|
px.TaskSpec(
|
|
"win_only",
|
|
cmd=["dir"],
|
|
conditions=(IS_WINDOWS,)
|
|
),
|
|
# 条件执行：仅在 git 已安装时运行
|
|
px.TaskSpec(
|
|
"git_check",
|
|
cmd=["git", "--version"],
|
|
conditions=(BuiltinConditions.HAS_APP_INSTALLED("git"),)
|
|
),
|
|
])
|
|
report = px.run(graph)
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from .conditions import (
|
|
IS_LINUX,
|
|
IS_MACOS,
|
|
IS_POSIX,
|
|
IS_WINDOWS,
|
|
BuiltinConditions,
|
|
Condition,
|
|
Constants,
|
|
)
|
|
from .context import Context, build_call_args, describe_injection
|
|
from .errors import (
|
|
CycleError,
|
|
DuplicateTaskError,
|
|
InjectionError,
|
|
MissingDependencyError,
|
|
PyFlowXError,
|
|
StorageError,
|
|
TaskFailedError,
|
|
TaskTimeoutError,
|
|
)
|
|
from .executors import Strategy, run
|
|
from .graph import Graph
|
|
from .report import RunReport
|
|
from .cli import CliExitCode, CliRunner
|
|
from .storage import JSONBackend, MemoryBackend, StateBackend
|
|
from .task import TaskCmd, TaskEvent, TaskResult, TaskSpec, TaskStatus
|
|
|
|
__version__ = "0.1.2"
|
|
|
|
__all__ = [
|
|
# 核心类型
|
|
"TaskSpec",
|
|
"TaskStatus",
|
|
"TaskResult",
|
|
"TaskEvent",
|
|
"Context",
|
|
"TaskCmd",
|
|
"Graph",
|
|
"RunReport",
|
|
# 执行
|
|
"run",
|
|
"Strategy",
|
|
# CLI 运行器
|
|
"CliRunner",
|
|
"CliExitCode",
|
|
# 状态后端
|
|
"StateBackend",
|
|
"MemoryBackend",
|
|
"JSONBackend",
|
|
# 错误
|
|
"PyFlowXError",
|
|
"DuplicateTaskError",
|
|
"MissingDependencyError",
|
|
"CycleError",
|
|
"TaskFailedError",
|
|
"TaskTimeoutError",
|
|
"InjectionError",
|
|
"StorageError",
|
|
# 条件判断
|
|
"Condition",
|
|
"Constants",
|
|
"BuiltinConditions",
|
|
"IS_WINDOWS",
|
|
"IS_LINUX",
|
|
"IS_MACOS",
|
|
"IS_POSIX",
|
|
# 辅助（高级）
|
|
"build_call_args",
|
|
"describe_injection",
|
|
]
|