CelestialFlow ——一个轻量级、可并行、基于图结构的 Python 任务调度框架

中文 | English | 日本語

CelestialFlow 是一个轻量级但功能完全的任务流框架，适合需要 复杂依赖关系、灵活执行模型、跨设备运行 与 可观测执行链路 的中/大型 Python 任务系统。

• 相比 Airflow/Dagster 更轻、更快开始
• 相比 multiprocessing/threading 更结构化，可直接表达 loop / complete graph 等复杂依赖模式

框架的基本单元为 任务节点（统一继承自内部基类 BaseTaskNode），目前对外暴露三种具体节点实现，可独立运行，也可互相连接成图：

• TaskExecutor — 通用任务执行器
• TaskSplitter — 将一个输入拆分为多个子任务
• TaskRouter — 根据条件将任务路由到不同下游

三种节点都支持以下执行模式：

• 线性（serial）
• 多线程（thread）
• 协程（async）

TaskExecutor 实现了对任务的结果缓存、任务去重、进度条显示、多执行模式比较等功能，单独使用也很好用。

节点之间通过 TaskGraph 互相连接，形成具有上游与下游依赖关系的任务图。下游节点会自动接收上游执行完成的结果作为输入，从而形成明确的数据流。TaskGraph 同时提供 TaskChain / TaskCross / TaskGrid / TaskLoop / TaskWheel / TaskComplete 等预置拓扑结构，方便快速搭建常见依赖模式。

在图级别上，通过 graph_mode 统一控制图中所有节点的运行方式：

• 线性（serial layout）：当前节点执行完毕再启动下一节点（下游节点可提前接收任务但不会立即执行）。
• 多线程（thread layout）：当前节点在主进程的独立线程中启动，适合 I/O 密集型任务和不可 pickle 的函数（如 lambda）。
• 协程（async layout）：当前节点以协程方式启动，适合 I/O 密集型异步任务。

graph_mode × execution_mode 共可组合出 9 种执行模式，覆盖绝大多数场景。

TaskGraph 能构建完整的 有向图结构（Directed Graph），不仅支持传统的有向无环图（DAG），也能灵活表达 树形（Tree）、环形（loop） 乃至于 完全图（Complete Graph） 形式的任务依赖。

在执行与调度之外，CelestialFlow 进一步引入 CelestialTree（简称: ctree）事件追踪系统，为每一个任务及其衍生行为（成功、失败、重试、拆分、路由等）记录明确的因果关系。借助 ctree，可以从任意一个初始任务出发，完整还原其在 TaskGraph 中的传播路径与执行轨迹，使任务系统可以进行完整的追溯、分析、解释。自 3.2.4 起，ctree 默认使用本地超简化实现，不强制依赖 celestialtree 外部包；如需 gRPC 远程追踪能力，可再额外安装。

在此基础上，CelestialFlow 提供事件追踪、状态上报、持久化回放等功能。Web 可视化界面由独立项目 celestialflow-web 提供，二者通过 HTTP 协议协作。

项目结构（Project Structure）

flowchart LR

    %% ===== TaskGraph =====
    subgraph TG[TaskGraph]
        direction LR

        S1[TaskExecutor A]
        S2[TaskSplitter B]
        S3[TaskExecutor C]
        S4[TaskRouter D]

        S1 --> S2 --> S3 --> S1
        S1 --> S4

    end

    %% 美化 TaskGraph 外框
    style TG fill:#e8f2ff,stroke:#6b93d6,stroke-width:2px,color:#0b1e3f,rx:10px,ry:10px

    %% 统一美化格式
    classDef blueNode fill:#ffffff,stroke:#6b93d6,rx:6px,ry:6px;

    %% 美化 TaskNodes
    class S1,S2,S3,S4 blueNode;

    %% ===== Links =====
    TG --> CFB[CelestialFlow Web]
    CFB --> TG

    style CFB fill:#ffeaf0,stroke:#d66b8c,stroke-width:2px,rx:10px,ry:10px

快速开始（Quick Start）

安装 CelestialFlow:

# 推荐使用 `uv` 管理依赖与环境
uv pip install celestialflow

# 不过也可以直接使用 `pip`
pip install celestialflow

如果你只使用 CelestialFlow 的核心调度、可观测性与持久化能力，上面的安装已经足够。

如果你还需要启用 CelestialTree 事件追踪能力，则需要额外安装 celestialtree：

# 对已发布包使用者
uv pip install celestialtree

# 如果你是 clone 仓库后的开发者/贡献者
uv sync --group dev

一个简单的可运行代码:

from celestialflow import TaskExecutor, TaskGraph


def add(x, y):
    return x + y


def square(x):
    return x**2


if __name__ == "__main__":
    # 定义两个任务节点
    executor_1 = TaskExecutor(
        name="Adder",
        func=add,
        execution_mode="thread",
        max_workers=4,
    )
    executor_2 = TaskExecutor(
        name="Squarer",
        func=square,
        execution_mode="thread",
        max_workers=4,
    )

    # 构建任务图结构
    graph = TaskGraph(name="DemoGraph", graph_mode="thread")
    graph.set_nodes(nodes=[executor_1, executor_2])
    graph.connect([executor_1], [executor_2])

    # 初始化任务并启动
    graph.run({"Adder": [(1, 2), (3, 4), (5, 6)]})

注意不要在.ipynb中运行。

👉 想查看完整Quick Start，请见Quick Start

深入阅读（Further Reading）

若你想了解框架的整体结构与核心组件，下面的参考文档会对你有帮助：

• BaseTaskNode.md
• TaskExecutor.md
• TaskGraph.md
• TaskMetrics.md
• TaskQueue.md
• TaskReport.md
• TaskStructure.md
• BaseObserver.md
• Go Worker.md

推荐阅读顺序:

flowchart TD
    classDef core fill:#e6efff,stroke:#3b82f6,color:#1e3a8a;
    classDef runtime fill:#e9f8ef,stroke:#22c55e,color:#14532d;
    classDef structure fill:#fff6e6,stroke:#f59e0b,color:#78350f;
    classDef execution fill:#f3e8ff,stroke:#a855f7,color:#581c87;

    BTN[BaseTaskNode.md] --> TE[TaskExecutor.md] --> TG[TaskGraph.md]
    TE --> OB[BaseObserver.md]
    TE --> TME[TaskMetrics.md]

    TG --> TQ[TaskQueue.md]
    TG --> TR[TaskReport.md]
    TG --> TSR[TaskStructure.md]

    TG --> GW[Go Worker.md]

    class BTN,TE,TG core;
    class TME runtime;
    class TSR structure;
    class TQ,GW execution;
    class TR execution;

以下五篇可以作为补充阅读:

• UtilHash.md
• UtilTypes.md
• UtilErrors.md
• Lifecycle.md
• Log.md

如果你更喜欢通过完整案例理解框架的运行方式，可以参考这篇利用 TaskGraph 从零开始构建项目的教程：

📘案例教程

如果你对3.0.7版本加入的ctree_client与其功能感兴趣, 可以看看这一篇:

📚CelestialTreeClient

你可以继续运行更多的演示代码，这里记录了各个演示文件与其中的演示函数说明：

🎮demo/ 总览

如果你想运行测试代码，可以先查看如下文档内容：

🧪tests/ 总览

如果你想查看 bench 内容，这些数据也是框架中部分设计取舍的依据：

⚡bench/ 总览

环境要求（Requirements）

CelestialFlow 基于 Python 3.12+，默认运行时仅依赖极简的核心组件。

• tqdm 已不再是默认运行时依赖（自 3.2.7 起移除）。如需在 demo 中体验 TaskProgress 进度条，可自行 uv pip install tqdm。

• celestialtree 也不再是必需依赖（自 3.2.4 起）：事件追踪默认使用本地超简化实现，可零外部依赖运行。如需 gRPC 远程追踪能力，请额外安装 celestialtree，或在源码仓库中执行 uv sync --group dev。

• 旧版 demo / bench 中的 Redis 节点已在 3.2.4 移除，本项目运行时不再依赖 Redis。

• 如需使用可视化的 Web 服务，请前往独立项目 celestialflow-web 安装并运行 celestialflow-web --host 0.0.0.0 --port 5000。

文件结构（File Structure）

📁 CelestialFlow	(664MB 611KB 462B)
    📁 bench           	(296KB 101B)
        📁 [1项排除的目录]                  	(194KB 222B)
        🐍 bench_datastructures.py          	(6KB 690B)
        🐍 bench_execution_mode.py          	(2KB 707B)
        🐍 bench_futures_memory.py          	(2KB 269B)
        🐍 bench_gil_vs_nogil.py            	(10KB 101B)
        🐍 bench_graph_mode.py              	(6KB 774B)
        🐍 bench_hash.py                    	(7KB 67B)
        🐍 bench_hash_container.py          	(3KB 1009B)
        🐍 bench_hash_memory.py             	(3KB 642B)
        🐍 bench_http_grpc.py               	(2KB 536B)
        🐍 bench_ipc_queue.py               	(7KB 104B)
        🐍 bench_lock_overhead.py           	(9KB 421B)
        🐍 bench_mpqueue_vs_shared_memory.py	(13KB 127B)
        🐍 bench_observer.py                	(7KB 860B)
        🐍 bench_persistence_spout.py       	(4KB 340B)
        🐍 bench_queue.py                   	(5KB 857B)
        🐍 bench_requests.py                	(6KB 813B)
        🐍 bench_tqdm.py                    	(1KB 235B)
        🐍 bench_utils.py                   	(543B)
    📁 demo            	(146KB 197B)
        📁 [1项排除的目录]  	(100KB 9B)
        🐍 demo_executor.py 	(1KB 495B)
        🐍 demo_funnel.py   	(2KB 289B)
        🐍 demo_graph.py    	(3KB 222B)
        🐍 demo_network.py  	(3KB 756B)
        🐍 demo_nodes.py    	(4KB 212B)
        🐍 demo_observer.py 	(4KB 270B)
        🐍 demo_redis.py    	(9KB 131B)
        🐍 demo_structure.py	(11KB 737B)
        🐍 demo_utils.py    	(6KB 148B)
    📁 docs            	(1MB 914KB 89B)
        📁 en[已折叠]   	(632KB 604B)
        📁 ja[已折叠]   	(718KB 778B)
        📁 zh-CN[已折叠]	(586KB 755B)
    📁 experiments     	(3KB 21B)
        🐍 experiment_networkx.py	(1KB 908B)
        🐍 experiment_tqdm.py    	(1KB 137B)
    📁 img             	(5MB 871KB 242B)
        📷 file_structure.svg  	(4MB 918KB 1000B)
        📷 logo(old).png       	(836KB 542B)
        📷 logo.png            	(122KB 747B)
        📷 scc_condensation.svg	(17KB 1B)
    📁 src             	(1MB 822KB 642B)
        📁 celestialflow[已折叠]         	(1MB 822KB 642B)
    📁 tests           	(4MB 290KB 989B)
        📁 benchmark[已折叠]    	(45KB 270B)
        📁 funnel[已折叠]       	(96KB 339B)
        📁 graph[已折叠]        	(768KB 424B)
        📁 node[已折叠]         	(451KB 840B)
        📁 observability[已折叠]	(188KB 1001B)
        📁 persistence[已折叠]  	(393KB 151B)
        📁 runtime[已折叠]      	(1MB 290KB 858B)
        📁 [1项排除的目录]      	(487KB 637B)
        🐍 conftest.py          	(1KB 38B)
    📁 [12项排除的目录]	(650MB 21KB 212B)
    ❓ .env            	(468B)
    ❓ .gitignore      	(1KB 315B)
    📝 AGENTS.md       	(1KB 434B)
    ❓ LICENSE         	(1KB 65B)
    ❓ Makefile        	(149B)
    ⚙️ pyproject.toml  	(2KB 668B)
    📝 README.md       	(17KB 298B)
    🔒 uv.lock         	(120KB 752B)

celestial-flow 3.3.0

(该视图由我的另一个项目CelestialVault中inst_file.FileTree.print_tree()生成。转换为图片则借助Carbon。)

版本日志（Version Log）

• 3.3.0
  • feat:
    • 现在 TaskExecutor 中完全删除了 func_name 参数
      • 在有 executor_name 表达节点后, 这层暴露是不必要的
      • 同时也是为了与 CelestialGraw 的状态做统一
    • 在向 reporter 发送状态时, 包含图的 class_name 信息
    • 移除 OrderGraph 中的 from_edges 方法
  • refactor:
    • [IMPORTANT] 重构原有的 executor/stage 结构
      • 原本为 executor -> stage -> splitter/router, 三层结构过于复杂
      • 现在删除 stage 层, 添加 BaseTaskNode, 作为 graph 唯一识别的节点, 而 executor 视为与 splitter/router 同级别的节点
      • 当前结构为 BaseTaskNode -> executor/splitter/router
    • 重构 render_structure_list(原 format_structure_list_from_graph) 的实现
      • 现在使用广度优先, 而不是原先的递归
      • 同时输入参数直接使用 list[str] 形式的节点名称列表, 这意味着不再显示 func_name execution_mode 等信息
    • 修改原本对于 collect_runtime_snapshot 奇怪的调用方式
      • 现在reporter端会在 _push_status 中直接调用 collect_runtime_snapshot
    • 删除 TaskExecutor 中的 get_summary, 这层包装实际上是多余的
      • 同时所有的 event_client.emit 也不再附带 summary 信息
    • 删除 OrderGraph 中的 _node 参数
      • 之前这个参数提供: 所有节点名称; 节点的插入顺序
      • 现在前者由 _out 提供, 后者不再重视
    • LifecycleInlet 中的 task_in 改名为 task_input, 保持与 log 端一致
  • fix:
    • 修复 execution_mode = async 时, worker崩溃被忽略的问题
    • 修复任务重试日志中 retry_times 的含义模糊, 现在使用 fail_times
    • 修复 reporter 的 _push_* 方法中, 不处理返回值的问题
    • 修复 TaskReporter._pull_injection 中, 对拉取的任务列表错误 put_task 的问题

更多过往日志可看:

change_log.md

Star 历史趋势（Star History）

如果对项目感兴趣的话，欢迎star。如果有问题或者建议的话, 欢迎提交Issues或者在Discussion中告诉我。

许可（License）

This project is licensed under the MIT License - see the LICENSE file for details.

作者（Author）

Author: Mr-xiaotian Email: mingxiaomingtian@gmail.com Project Link: https://github.com/Mr-xiaotian/CelestialFlow