API 参考¶
本章节由 mkdocstrings 从源码 docstring 与 Pydantic 字段自动生成,覆盖 plaita 的核心模块。
公共 API 速查
日常使用只需从顶层导入:from plaita import Flow, Node, FlowExecution, FlowCallback, NodeRegistry, get_default_registry, parse, parse_and_run, types。
顶层包通过 __getattr__ 懒加载到下述各模块(见 架构 - 分层约束)。
模块索引¶
| 模块 | 内容 |
|---|---|
plaita.core.flow |
Flow、parse、parse_and_run |
plaita.core.executor |
FlowExecution、ExecutionMode、三种策略 |
plaita.core.context |
ExecutionContext、默认 event bus provider |
plaita.core.runner |
NodeRunner(超时/重试/错误策略) |
plaita.core.callback |
FlowCallback、CallbackManager、LoggerCallback |
plaita.core.errors |
异常类(含细分子类)、ErrorStrategy、ErrorHandler |
plaita.core.expression |
ExpressionRegistry、ExpressionEvaluator |
plaita.node |
Node、NodeRegistry、内置节点(CodeNode 需显式注册) |
plaita.event.core |
EventBus、Event、EventSubscription |
plaita.storage.base |
ExecutionStorage、FlowStorage、ExecutionState |
plaita.server.flow_worker |
FlowWorker(需 server extra) |
可选模块¶
下列模块需要对应 extra,访问顶层符号时缺失会抛可操作的 ImportError:
| 符号 | 模块 | extra |
|---|---|---|
FlowWorker |
plaita.server.flow_worker |
server |
RedisExecutionStorage / RedisFlowStorage |
plaita.storage.redis |
redis |
RedisEventBus |
plaita.event.redis |
redis |
CodeNode |
plaita.node.code |
code |
HTTP |
plaita.node.http |
http |