ForcePilot/backend/package/yuxi/channels/contract/errors/client.py
Kris 8eead29de0 refactor: 批量清理冗余空行,优化部分枚举使用方式
1.  移除所有适配器文件中多余的空导入行
2.  调整ValidationError继承,移除不必要的ValueError继承
3.  修正多处ChannelType使用方式,从.value改为直接使用枚举实例
4.  优化飞书插件部分硬编码渠道类型为枚举实例
5.  更新wechat_ilink插件清单与适配器配置
6.  新增飞书目录适配器缓存清理支持判断与iLink生命周期适配器凭据轮换支持判断
7.  优化配置处理器历史查询逻辑,区分键不存在与无历史记录场景
2026-07-04 00:14:56 +08:00

183 lines
4.9 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.

"""客户端错误类型定义。
定义 ``ClientError`` 抽象基类及其 4 个具体子类,表示由调用方引起的错误
4xx 语义):参数校验失败、认证失败、资源不存在、权限不足。
"""
from __future__ import annotations
from typing import Any
from yuxi.channels.contract.errors.base import Error
class ClientError(Error):
"""客户端错误抽象基类。
表示由调用方引起的错误4xx 语义)。子类包括 ``ValidationError`` /
``AuthError`` / ``NotFoundError`` / ``PermissionDeniedError``。
"""
error_code = "CLIENT_ERROR"
class ValidationError(ClientError):
"""字段校验失败错误。"""
error_code = "VALIDATION_ERROR"
def __init__(
self,
field: str,
message: str,
*,
trace_id: str | None = None,
) -> None:
super().__init__(message, trace_id=trace_id)
self.field = field
def to_dict(self) -> dict[str, Any]:
data = super().to_dict()
data["field"] = self.field
return data
class AuthError(ClientError):
"""认证失败错误。
调用方身份认证失败时抛出,如 token 无效、签名错误HTTP 401
"""
error_code = "AUTH_ERROR"
def __init__(
self,
reason: str,
*,
trace_id: str | None = None,
) -> None:
super().__init__(f"Authentication failed: {reason}", trace_id=trace_id)
self.reason = reason
def to_dict(self) -> dict[str, Any]:
data = super().to_dict()
data["reason"] = self.reason
return data
class NotFoundError(ClientError):
"""资源不存在错误。
调用方请求的资源不存在时抛出HTTP 404
"""
error_code = "NOT_FOUND"
def __init__(
self,
resource: str,
id: str,
*,
trace_id: str | None = None,
) -> None:
super().__init__(f"{resource} not found: {id}", trace_id=trace_id)
self.resource = resource
self.id = id
def to_dict(self) -> dict[str, Any]:
data = super().to_dict()
data["resource"] = self.resource
data["id"] = self.id
return data
class PermissionDeniedError(ClientError):
"""权限不足错误。
调用方无权限执行请求的操作时抛出HTTP 403。命名为 ``PermissionDeniedError``
以避免与 Python 内置 ``PermissionError`` 冲突。
"""
error_code = "PERMISSION_DENIED"
def __init__(
self,
reason: str,
*,
trace_id: str | None = None,
) -> None:
super().__init__(f"Permission denied: {reason}", trace_id=trace_id)
self.reason = reason
def to_dict(self) -> dict[str, Any]:
data = super().to_dict()
data["reason"] = self.reason
return data
class ServiceAccountNotFoundError(NotFoundError):
"""渠道账户未绑定服务账号错误。
渠道账户未关联服务账号(``User.user_type='service'``时抛出HTTP 404
``details`` 包含 ``channel_type`` 与 ``account_id``,便于定位缺失绑定的
渠道账户。
"""
error_code = "CHANNEL_SERVICE_ACCOUNT_NOT_FOUND"
def __init__(
self,
channel_type: str,
account_id: str,
*,
trace_id: str | None = None,
) -> None:
super().__init__(
"service_account",
f"{channel_type}:{account_id}",
trace_id=trace_id,
)
self.channel_type = channel_type
self.account_id = account_id
def to_dict(self) -> dict[str, Any]:
data = super().to_dict()
data["channel_type"] = self.channel_type
data["account_id"] = self.account_id
return data
class ChannelAccessDeniedError(PermissionDeniedError):
"""渠道访客无权访问 Agent 错误。
渠道访客在当前渠道访问级别下无权访问目标 Agent 时抛出HTTP 403
``details`` 包含 ``agent_slug``、``channel_access_level``,可选携带
``unified_identity_id`` 用于跨渠道身份关联排查。
"""
error_code = "CHANNEL_ACCESS_DENIED"
def __init__(
self,
agent_slug: str,
channel_access_level: str,
*,
unified_identity_id: str | None = None,
trace_id: str | None = None,
) -> None:
super().__init__(
f"access denied to agent '{agent_slug}' at level '{channel_access_level}'",
trace_id=trace_id,
)
self.agent_slug = agent_slug
self.channel_access_level = channel_access_level
self.unified_identity_id = unified_identity_id
def to_dict(self) -> dict[str, Any]:
data = super().to_dict()
data["agent_slug"] = self.agent_slug
data["channel_access_level"] = self.channel_access_level
if self.unified_identity_id is not None:
data["unified_identity_id"] = self.unified_identity_id
return data