Files
DDSRem 2de976f6b3 Merge pull request #7050 from DDSRem-Dev/codex-comment-migration
docs: 统一全项目中文注释和结构化契约说明
2026-10-17 19:26:29 +08:00

109 lines
3.1 KiB
Python

"""
插件运行时目录的应用层端口。
"""
from __future__ import annotations
from collections.abc import Callable
from contextlib import nullcontext
from typing import Any, ContextManager, Protocol
from app.schemas.types import SystemConfigKey
PLUGIN_MUTATION_SYSTEM_CONFIG_KEYS = frozenset(
{
SystemConfigKey.UserInstalledPlugins,
SystemConfigKey.PluginInstances,
SystemConfigKey.PluginFolders,
}
)
class PluginRuntime(Protocol):
"""
声明入口层消费的插件宿主能力。
"""
def mutation(self, operation: str) -> ContextManager[None]:
"""
为完整插件可变事务取得停机准入租约。
:param operation: 本次插件修改操作的名称,用于停机准入诊断
:return: 进入时登记修改准入、退出时释放准入的上下文管理器
"""
...
def __getattr__(self, name: str) -> Any:
"""
允许兼容门面按既有 V3 方法名访问插件宿主能力。
:param name: 兼容门面需要访问的宿主能力名称
:return: 与既有能力名对应的运行时属性或可调用对象
"""
PluginRuntimeProvider = Callable[[], PluginRuntime]
ExistingPluginRuntimeProvider = Callable[[], PluginRuntime | None]
def _unconfigured_runtime() -> PluginRuntime:
"""
拒绝在启动组合根完成前隐式创建 Runtime 管理器。
"""
raise RuntimeError("插件运行时尚未由启动组合根装配")
def _missing_existing_runtime() -> None:
"""
表示当前生命周期尚未物化插件运行时。
"""
return None
_runtime_provider: PluginRuntimeProvider = _unconfigured_runtime
_existing_runtime_provider: ExistingPluginRuntimeProvider = _missing_existing_runtime
def configure_plugin_runtime(
provider: PluginRuntimeProvider,
*,
existing_provider: ExistingPluginRuntimeProvider | None = None,
) -> None:
"""
由启动组合根注册插件运行时创建端口和无副作用探测端口。
"""
global _runtime_provider, _existing_runtime_provider
_runtime_provider = provider
_existing_runtime_provider = existing_provider or _missing_existing_runtime
def get_plugin_manager() -> PluginRuntime:
"""
返回当前组合根提供的插件运行时能力。
"""
return _runtime_provider()
def get_existing_plugin_manager() -> PluginRuntime | None:
"""
返回已物化插件运行时;尚未创建时不触发隐式构造。
"""
return _existing_runtime_provider()
def plugin_system_config_mutation(
key: str | SystemConfigKey | None,
) -> ContextManager[None]:
"""
仅为会改变插件运行态所有权的系统配置取得修改准入租约。
"""
if key is None:
return nullcontext()
try:
normalized_key = key if isinstance(key, SystemConfigKey) else SystemConfigKey(key)
except ValueError:
return nullcontext()
if normalized_key not in PLUGIN_MUTATION_SYSTEM_CONFIG_KEYS:
return nullcontext()
return get_plugin_manager().mutation(f"更新插件系统配置 {normalized_key.value}")