
关于
使用 DBOS 持久化工作流构建可靠、容错的 Python 应用指南。适用于将 DBOS 添加到现有 Python 代码、创建工作流和步骤,或使用队列进行并发控制。
name: dbos-python description: "使用 DBOS 持久化工作流构建可靠、容错的 Python 应用程序指南。适用于向现有 Python 代码添加 DBOS、创建工作流和步骤,或使用队列进行并发控制。" risk: safe source: "https://docs.dbos.dev/" date_added: "2026-02-27"
DBOS Python 最佳实践
使用 DBOS 持久化工作流构建可靠、容错的 Python 应用程序指南。
何时使用
在以下情况参考这些指南:
- 向现有 Python 代码添加 DBOS
- 创建工作流和步骤
- 使用队列进行并发控制
- 实现工作流通信(事件、消息、流)
- 配置和启动 DBOS 应用程序
- 从外部应用程序使用 DBOSClient
- 测试 DBOS 应用程序
按优先级分类的规则
| 优先级 | 类别 | 影响 | 前缀 |
|--------|------|------|------|
| 1 | 生命周期 | 关键 | lifecycle- |
| 2 | 工作流 | 关键 | workflow- |
| 3 | 步骤 | 高 | step- |
| 4 | 队列 | 高 | queue- |
| 5 | 通信 | 中 | comm- |
| 6 | 模式 | 中 | pattern- |
| 7 | 测试 | 低-中 | test- |
| 8 | 客户端 | 中 | client- |
| 9 | 高级 | 低 | advanced- |
关键规则
DBOS 配置和启动
DBOS 应用程序必须在其 main 函数中配置和启动 DBOS:
import os
from dbos import DBOS, DBOSConfig
@DBOS.workflow()
def my_workflow():
pass
if __name__ == "__main__":
config: DBOSConfig = {
"name": "my-app",
"system_database_url": os.environ.get("DBOS_SYSTEM_DATABASE_URL"),
}
DBOS(config=config)
DBOS.launch()
工作流和步骤结构
工作流由步骤组成。任何执行复杂操作或访问外部服务的函数必须是一个步骤:
@DBOS.step()
def call_external_api():
return requests.get("https://api.example.com").json()
@DBOS.workflow()
def my_workflow():
result = call_external_api()
return result
关键约束
- 不要在步骤中调用
DBOS.start_workflow或DBOS.recv - 不要使用线程启动工作流 - 使用
DBOS.start_workflow或队列 - 工作流必须是确定性的 - 非确定性操作放在步骤中
- 不要在工作流或步骤中创建/更新全局变量
使用方法
阅读各规则文件获取详细说明和示例:
references/lifecycle-config.md
references/workflow-determinism.md
references/queue-concurrency.md
参考资料
- https://docs.dbos.dev/
- https://github.com/dbos-inc/dbos-transact-py
限制
- 仅在任务明确匹配上述范围时使用此技能。
- 不要将输出视为环境特定验证、测试或专家审查的替代品。
- 如果缺少所需输入、权限、安全边界或成功标准,请停下来寻求澄清。
兼容工具
Claude CodeCursor
标签
数据工程
