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

80 lines
2.5 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.

"""能力声明与证明协议。
定义能力声明、能力证明值对象与能力证明 Protocol。能力校验分为两层
静态声明(``CapabilityDeclaration``)与运行时证明(``CapabilityProof``)。
出站中间件判断是否调用富消息渲染时,必须同时检查静态声明与运行时证明,
两者均为真才调用FR-08 增强)。
"""
from __future__ import annotations
from dataclasses import dataclass
from datetime import datetime
from typing import Protocol, runtime_checkable
from yuxi.channels.contract.dtos.capability import ChannelCapabilities
from yuxi.channels.contract.errors import NotImplementedError
@dataclass(frozen=True)
class CapabilityDeclaration:
"""能力声明。
描述插件的静态能力声明,封装 ``ChannelCapabilities``,用于清单注册
与能力校验的声明层。
字段:
capabilities: 渠道能力集合(静态声明)。
"""
capabilities: ChannelCapabilities
@dataclass(frozen=True)
class CapabilityProof:
"""能力证明。
描述单项能力的运行时证明结果,包括能力名称、是否证明通过、证明时间戳
与缓存 TTL用于能力校验的证明层。
字段:
capability_name: 能力名称。
proven: 是否证明通过。
proof_timestamp: 证明时间戳。
cache_ttl: 缓存 TTL默认 300s
"""
capability_name: str
proven: bool
proof_timestamp: datetime
cache_ttl: int = 300
@runtime_checkable
class CapabilityProver(Protocol):
"""能力证明 Protocol。
由插件实现,对单项能力进行运行时证明。证明为异步方法,以支持需要远程
调用的能力验证场景。
缓存约束FR-08 增强):
- 能力证明结果 **可以** 缓存,默认 TTL 300s见 ``CapabilityProof.cache_ttl``)。
- 缓存失效时重新证明。
降级约束FR-08 增强 / FR-21
- 静态声明支持但运行时证明不支持时,**必须** 记录告警日志并走降级路径。
- 契约测试 **必须** 强制清单声明的能力与运行时投递能力一致,不一致时
阻止合入主干。
"""
async def proveCapability(self, capability_name: str) -> CapabilityProof:
"""证明单项能力。
参数:
capability_name: 能力名称。
返回:
能力证明结果,包含是否通过、时间戳与缓存 TTL。
"""
raise NotImplementedError(operation="proveCapability")