Files
zhenxun_bot/zhenxun/services/ai/utils/runtime.py
T
0b32d69c9c ♻️ refactor(tools): 重构工具装饰器系统并优化沙箱与文档注释 (#2147)
* ♻️ refactor(ai): 重构 AI 服务模块并完善文档注释

- 【重构】统一清理并优化所有 AI 服务模块文件的导入语句,将其移至文件顶部
- 【重构】重构 `hooks.py` 中的 `Hooks` 派发逻辑,使用通用管道函数消除重复代码,并引入 `HookPoint` 描述符
- 【重构】重构工具装饰器实现,新增 `toolkit` 类装饰器,优化 `BaseToolkit` 配置合并与前缀处理
- 【功能】Docker 沙箱容器创建时支持自动注入系统代理环境变量并配置 `ExtraHosts`
- 【功能】Jupyter 服务启动前自动清理旧进程并初始化临时目录权限
- 【修复】优化 Pydantic 结构化输出校验失败时的错误信息提取,提供更详细的字段级错误反馈
- 【修复】在 `api.py` 中避免将 `ModelRetry` 和 `ControlFlowExit` 异常错误地包装为 `LLMException`
- 【文档】为 AI 服务、沙箱、工具链、工作流等核心模块补充完整的 Docstring 和类型注释

* 📝 docs(ai): 补全核心模块文档注释并清理冗余代码

- 补全 `run/context`、`run/hooks` 和 `tools/engine/registry` 中类与方法的中文文档注释
- 清理 `tools/providers/builtin/sandbox` 中未使用的 `PythonPluginProtocol` 协议及相关导入
- 规范化部分代码的格式与尾随逗号

* ♻️ refactor!(flow): 重构 Task 为 AgentTask 并优化工作流元数据定义

- 【Breaking Change】将 `Task` 重命名为 `AgentTask` 以避免命名冲突
- 更新 Agent、Team、Workflow 等模块中的类型声明与相关逻辑
- 引入 `AutoNodeMeta` 强类型元数据,替换工作流装饰器中的裸字典定义
- 将 `StepMeta`、`ConditionMeta` 和 `RouterMeta` 统一移动至 `types.py`
- 优化 `RunnableNode` 对上游 `AgentTask` 的处理与拼接逻辑
- 调整团队协作策略中 `FinishAction` 的返回值为完整结果对象

* ♻️ refactor(workflow): 移除人工确认机制并重构错误策略

- 移除工作流节点的人工确认(HITL)与挂起继续机制
- 删除 `auto` 自动化工作流及相关装饰器文件
- 将错误处理策略类从 `types.py` 拆分并移动到新文件 `policies.py`
- 优化节点执行失败时的异常信息格式化输出
- 移除 `WorkflowRunResult` 和 `StepOutput` 中与挂起相关的状态字段

* 🚨 auto fix by pre-commit hooks

---------

Co-authored-by: webjoin111 <455457521@qq.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2026-07-05 11:47:21 +08:00

172 lines
5.8 KiB
Python

from typing import Any
from nonebot.adapters import Bot, Event
from zhenxun.services.ai.utils.scope import ScopeBuilder
class ContextUtils:
"""
从底层依赖容器 (deps) 中提取运行环境信息的纯静态工具类。
"""
@staticmethod
def extract_user_id(deps: Any) -> str | None:
"""从依赖容器中提取当前用户的 ID"""
if not deps:
return None
if hasattr(deps, "user_id") and getattr(deps, "user_id") is not None:
return str(getattr(deps, "user_id"))
event = getattr(deps, "event", None)
if event:
try:
return str(event.get_user_id())
except Exception:
return (
str(getattr(event, "user_id", ""))
or str(getattr(event, "sender_id", ""))
or None
)
return None
@staticmethod
def extract_group_id(deps: Any) -> str | None:
"""从依赖容器中提取当前群聊的 ID"""
if not deps:
return None
if hasattr(deps, "group_id") and getattr(deps, "group_id") is not None:
return str(getattr(deps, "group_id"))
event = getattr(deps, "event", None)
if event:
return str(getattr(event, "group_id", "")) or None
return None
@staticmethod
def extract_platform(deps: Any) -> str:
"""从依赖容器的 Bot 实例中提取当前聊天平台名称"""
if not deps:
return "unknown"
if hasattr(deps, "platform") and getattr(deps, "platform") is not None:
return str(getattr(deps, "platform"))
bot = getattr(deps, "bot", None)
if bot:
from zhenxun.utils.platform import PlatformUtils
return PlatformUtils.get_platform(bot)
return "unknown"
@staticmethod
def extract_concurrency_lock_id(
context: Any, scope: Any, default_session_id: str
) -> str:
"""根据并发隔离范围 scope 动态计算并返回当前会话的并发锁 ID"""
from zhenxun.services.ai.flow.base import ConcurrencyScope
scope = scope or ConcurrencyScope.GROUP
ns = getattr(getattr(context, "session", None), "namespace", "global")
ns_suffix = f"_{ns}" if ns and ns != "global" else ""
if scope == ConcurrencyScope.GLOBAL:
return f"lock_global{ns_suffix}"
elif scope == ConcurrencyScope.GROUP:
gid = ContextUtils.extract_group_id(getattr(context, "deps", None))
uid = ContextUtils.extract_user_id(getattr(context, "deps", None))
return (
f"lock_group_{gid}{ns_suffix}" if gid else f"lock_user_{uid}{ns_suffix}"
)
elif scope == ConcurrencyScope.USER:
uid = ContextUtils.extract_user_id(getattr(context, "deps", None))
return (
f"lock_user_{uid}{ns_suffix}"
if uid
else f"lock_default_user{ns_suffix}"
)
else:
return f"lock_session_{default_session_id}"
@staticmethod
def generate_session_meta(
bot: Bot,
event: Event,
scope_builder: ScopeBuilder | None = None,
prefix: str = "",
namespace: str | None = None,
agent_name: str | None = None,
) -> Any:
"""根据事件和隔离级别,自动提取生成基于路径作用域的 SessionMetadata"""
from zhenxun.services.ai.context.memory.types import (
Isolation,
SessionMetadata,
)
from zhenxun.services.ai.run.context import NoneBotDeps
if scope_builder is None:
scope_builder = Isolation.AGENT_USER()
deps = NoneBotDeps(bot=bot, event=event)
selector = scope_builder.resolve(
deps=deps,
prefix=prefix,
default_namespace=namespace,
default_agent=agent_name,
)
parts = selector.get_scope_parts()
session_id = selector.scope_prefix
scope_prefix = selector.scope_prefix
all_scopes = {"/"}
current_path = ""
for part in parts:
current_path += f"/{part}"
all_scopes.add(current_path)
accessible_scopes = list(all_scopes)
accessible_scopes.sort(key=lambda x: len(x.split("/")))
return SessionMetadata(
session_id=session_id,
scope_prefix=scope_prefix,
accessible_scopes=accessible_scopes,
selector=selector,
isolation_level=scope_builder,
)
class PermissionUtils:
"""运行时权限校验通用工具类"""
@staticmethod
async def check_superuser(context: Any) -> bool:
"""异步校验当前运行上下文中的用户是否为超级用户"""
bot = context.get_bot()
event = context.get_event()
if bot and event:
from nonebot.permission import SUPERUSER
return await SUPERUSER(bot, event)
return False
@staticmethod
async def check_admin_level(context: Any, min_level: int) -> bool:
"""异步校验当前用户在全局或当前群聊中的管理权限等级是否达到最低要求"""
if await PermissionUtils.check_superuser(context):
return True
user_id = context.get_user_id()
group_id = context.get_group_id()
if not user_id:
return False
from zhenxun.services.cache.runtime_cache import LevelUserMemoryCache
global_user, group_users = await LevelUserMemoryCache.get_levels(
user_id, group_id
)
user_level = global_user.user_level if global_user else 0
if group_id and group_users:
user_level = max(user_level, group_users.user_level)
return user_level >= min_level