Cadence-Python 开源项目教程

项目介绍

Cadence-Python 是一个用于 Cadence Workflow Service 的 Python 框架。Cadence 是一个分布式、可扩展、持久且高性能的执行引擎，旨在以编程方式构建和管理长时间运行的应用程序。Cadence-Python 允许开发者创建具有隐式保存状态的 Python 函数，这样即使进程或机器发生故障，函数的状态也不会丢失。

项目快速启动

安装 Cadence-Python

首先，确保你已经安装了 Docker，然后下载并启动 Cadence 服务：

wget https://raw.githubusercontent.com/uber/cadence/master/docker/docker-compose.yml
docker-compose up

接下来，注册一个示例域：

docker run --network=host --rm ubercadence/cli:master --do sample-domain register -rd 1

安装 Cadence-Python 客户端：

pip install cadence-client==1.0.1

编写第一个工作流

创建一个 Python 脚本 hello_world.py，并添加以下内容：

import sys
import logging
from cadence.activity_method import activity_method
from cadence.workerfactory import WorkerFactory
from cadence.workflow import workflow_method
from cadence.workflow_client import WorkflowClient

logging.basicConfig(level=logging.DEBUG)

TASK_LIST = "HelloActivity-python-tasklist"
DOMAIN = "sample-domain"

# 活动接口
class GreetingActivities:
    @activity_method(task_list=TASK_LIST, schedule_to_close_timeout_seconds=2)
    def compose_greeting(self, greeting: str, name: str) -> str:
        raise NotImplementedError

# 活动实现
class GreetingActivitiesImpl:
    def compose_greeting(self, greeting: str, name: str):
        return f"{greeting}, {name}!"

# 工作流接口
class GreetingWorkflow:
    @workflow_method
    def get_greeting(self, name: str) -> str:
        raise NotImplementedError

# 工作流实现
class GreetingWorkflowImpl(GreetingWorkflow):
    def __init__(self):
        self.greeting_activities = GreetingActivitiesImpl()

    def get_greeting(self, name: str):
        return self.greeting_activities.compose_greeting("Hello", name)

# 注册活动和工作流
factory = WorkerFactory(DOMAIN)
worker = factory.new_worker(TASK_LIST)
worker.register_activities_implementation(GreetingActivitiesImpl(), "GreetingActivities")
worker.register_workflow_implementation_type(GreetingWorkflowImpl)
factory.start()

# 启动工作流
client = WorkflowClient.new_client(domain=DOMAIN)
greeting_workflow: GreetingWorkflow = client.new_workflow_stub(GreetingWorkflow)
result = greeting_workflow.get_greeting("Python")
print(result)

print("Stopping workers...")
worker.stop()
print("Workers stopped.")
sys.exit(0)

运行脚本：

python hello_world.py

应用案例和最佳实践

应用案例

Cadence-Python 适用于需要确保函数运行到完成的场景，例如：

• 涉及多个微服务的业务逻辑
• CI/CD 管道
• 数据管道
• RPA（机器人流程自动化）
• ETL（提取、转换、加载）
• 营销自动化/客户旅程/客户参与
• Zapier/IFTTT 类终端用户自动化
• 聊天机器人
• 多步骤表单
• 调度器/Cron 作业

最佳实践

• 错误处理：确保在工作流和活动中正确处理错误和异常。
• 状态管理：利用 Cadence 的持久化状态管理功能，确保在故障发生时能够恢复状态。
• 监控和日志：实施监控和日志记录，以便及时发现和解决问题。

典型生态项目

Cadence-Python 可以与其他项目和工具集成，以构建更复杂的应用程序。以下是一些典型的生态项目：

• Docker：用于部署和管理 Cadence 服务。
• Kubernetes：用于容器编排和管理，提供高可用性和可扩展性。
• Prometheus