ForcePilot/backend/package/yuxi/channels/contract/dtos/queue.py
Kris b88c0ae29e feat(channels): 批量新增多渠道网关限界上下文基础代码与契约
新增完整的 channels 限界上下文模块,包含契约层、领域核心层、应用服务、管道编排、插件体系、基础设施组合根等全层级代码,新增飞书与微信 iLink 渠道插件基础结构,补充各类 DTO、端口协议与领域服务实现。
2026-07-02 03:22:12 +08:00

79 lines
2.0 KiB
Python
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

"""队列 DTO。
定义队列端口的命令与值对象,包括入队命令、任务 ID 与任务状态。所有 DTO
均为 ``dataclass(frozen=True)``,仅依赖标准库,用于异步任务的入队与
状态追踪。
"""
from __future__ import annotations
from dataclasses import dataclass
from datetime import datetime
from enum import StrEnum
from typing import Any
from yuxi.channels.contract.errors import ValidationError
@dataclass(frozen=True)
class EnqueueCmd:
"""入队命令。
由队列端口方法引用,描述一次异步任务入队请求,携带任务名称、负载、
计划执行时间与幂等键,用于异步任务调度。
字段:
task_name: 任务名称。
payload: 任务负载。
scheduled_at: 计划执行时间(可选)。
idempotency_key: 幂等键(可选)。
"""
task_name: str
payload: dict[str, Any]
scheduled_at: datetime | None = None
idempotency_key: str | None = None
def __post_init__(self) -> None:
"""校验必填字段非空。
``task_name`` 必须非空,在构造时即抛出 ``ValidationError``
adapter 不再做该校验INV-8
"""
if not self.task_name:
raise ValidationError("task_name", "must not be empty")
@dataclass(frozen=True)
class JobId:
"""任务 ID。
标识一次异步任务的唯一 ID用于任务状态查询与结果关联。
字段:
value: 任务 ID 字符串。
"""
value: str
class JobStatus(StrEnum):
"""任务状态。
标识异步任务的执行状态,用于任务状态查询与结果聚合。继承
``str, Enum`` 以支持 JSON 序列化与字符串比较。
取值:
QUEUED: 已入队。
RUNNING: 执行中。
COMPLETED: 已完成。
FAILED: 已失败。
CANCELLED: 已取消。
"""
QUEUED = "queued"
RUNNING = "running"
COMPLETED = "completed"
FAILED = "failed"
CANCELLED = "cancelled"