zhou
32ca8c1208
CI / Lint, Typecheck & Test (push) Successful in 1m57s
1. 新建 docs/ Sphinx 文档结构 (conf.py + 8 个 rst 章节), napoleon 支持 Google/NumPy docstring, rtd 主题, 自动生成 API 参考与错误家族文档 2. 新建 .readthedocs.yaml 配置, pyproject.toml 加 docs 依赖 3. 删除 runner.py 的 _apply_verbose_to_graph 死代码及对应测试 (功能已移入 executors.run 统一处理) 4. 更新 README: CLI 示例改为 pf 统一入口, 模块结构表补全 cli/pf.py/cli/configs/cli/_ops 等模块 5. 修复版本不一致 (pyproject.toml 0.3.5 → 0.4.5) 6. 加文档徽章链接到 ReadTheDocs
107 lines
1.9 KiB
ReStructuredText
107 lines
1.9 KiB
ReStructuredText
API 参考
|
|
========
|
|
|
|
任务描述
|
|
--------
|
|
|
|
.. autoclass:: pyflowx.TaskSpec
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|
|
:exclude-members: args, kwargs
|
|
|
|
.. autoclass:: pyflowx.RetryPolicy
|
|
:members:
|
|
:undoc-members:
|
|
|
|
.. autoclass:: pyflowx.TaskHooks
|
|
:members:
|
|
:undoc-members:
|
|
|
|
.. autoclass:: pyflowx.TaskStatus
|
|
:members:
|
|
:undoc-members:
|
|
|
|
图构建
|
|
------
|
|
|
|
.. autoclass:: pyflowx.Graph
|
|
:members:
|
|
:undoc-members:
|
|
:exclude-members: from_specs, from_yaml
|
|
|
|
.. autoclass:: pyflowx.GraphDefaults
|
|
:members:
|
|
:undoc-members:
|
|
|
|
.. autofunction:: pyflowx.compose
|
|
.. autofunction:: pyflowx.task_template
|
|
|
|
执行
|
|
----
|
|
|
|
.. autofunction:: pyflowx.run
|
|
|
|
.. autoclass:: pyflowx.RunReport
|
|
:members:
|
|
:undoc-members:
|
|
|
|
.. autoclass:: pyflowx.TaskResult
|
|
:members:
|
|
:undoc-members:
|
|
|
|
YAML 编排
|
|
---------
|
|
|
|
.. autofunction:: pyflowx.load_yaml
|
|
.. autofunction:: pyflowx.parse_yaml_string
|
|
.. autofunction:: pyflowx.run_yaml
|
|
.. autofunction:: pyflowx.run_cli
|
|
.. autofunction:: pyflowx.build_cli_parser
|
|
|
|
函数注册
|
|
--------
|
|
|
|
.. autofunction:: pyflowx.register_fn
|
|
.. autofunction:: pyflowx.get_fn
|
|
.. autofunction:: pyflowx.has_fn
|
|
|
|
命令执行
|
|
--------
|
|
|
|
.. autofunction:: pyflowx.run_command
|
|
|
|
CLI 运行器
|
|
----------
|
|
|
|
.. autoclass:: pyflowx.CliRunner
|
|
:members:
|
|
:undoc-members:
|
|
|
|
状态后端
|
|
--------
|
|
|
|
.. autoclass:: pyflowx.StateBackend
|
|
:members:
|
|
:undoc-members:
|
|
|
|
.. autoclass:: pyflowx.MemoryBackend
|
|
:members:
|
|
:undoc-members:
|
|
|
|
.. autoclass:: pyflowx.JSONBackend
|
|
:members:
|
|
:undoc-members:
|
|
|
|
错误家族
|
|
--------
|
|
|
|
.. autoexception:: pyflowx.PyFlowXError
|
|
.. autoexception:: pyflowx.DuplicateTaskError
|
|
.. autoexception:: pyflowx.MissingDependencyError
|
|
.. autoexception:: pyflowx.CycleError
|
|
.. autoexception:: pyflowx.TaskFailedError
|
|
.. autoexception:: pyflowx.TaskTimeoutError
|
|
.. autoexception:: pyflowx.InjectionError
|
|
.. autoexception:: pyflowx.StorageError
|