mirror of
https://github.com/jxxghp/MoviePilot.git
synced 2026-11-04 22:36:34 +08:00
Merge pull request #7050 from DDSRem-Dev/codex-comment-migration
docs: 统一全项目中文注释和结构化契约说明
This commit is contained in:
@@ -1,4 +1,6 @@
|
||||
"""插件运行时目录的应用层端口。"""
|
||||
"""
|
||||
插件运行时目录的应用层端口。
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
@@ -18,14 +20,26 @@ PLUGIN_MUTATION_SYSTEM_CONFIG_KEYS = frozenset(
|
||||
|
||||
|
||||
class PluginRuntime(Protocol):
|
||||
"""声明入口层消费的插件宿主能力。"""
|
||||
"""
|
||||
声明入口层消费的插件宿主能力。
|
||||
"""
|
||||
|
||||
def mutation(self, operation: str) -> ContextManager[None]:
|
||||
"""为完整插件可变事务取得停机准入 lease。"""
|
||||
"""
|
||||
为完整插件可变事务取得停机准入租约。
|
||||
|
||||
:param operation: 本次插件修改操作的名称,用于停机准入诊断
|
||||
:return: 进入时登记修改准入、退出时释放准入的上下文管理器
|
||||
"""
|
||||
...
|
||||
|
||||
def __getattr__(self, name: str) -> Any:
|
||||
"""允许兼容门面按既有 V3 方法名访问插件宿主能力。"""
|
||||
"""
|
||||
允许兼容门面按既有 V3 方法名访问插件宿主能力。
|
||||
|
||||
:param name: 兼容门面需要访问的宿主能力名称
|
||||
:return: 与既有能力名对应的运行时属性或可调用对象
|
||||
"""
|
||||
|
||||
|
||||
PluginRuntimeProvider = Callable[[], PluginRuntime]
|
||||
@@ -33,12 +47,16 @@ ExistingPluginRuntimeProvider = Callable[[], PluginRuntime | None]
|
||||
|
||||
|
||||
def _unconfigured_runtime() -> PluginRuntime:
|
||||
"""拒绝在启动组合根完成前隐式创建 Runtime 管理器。"""
|
||||
"""
|
||||
拒绝在启动组合根完成前隐式创建 Runtime 管理器。
|
||||
"""
|
||||
raise RuntimeError("插件运行时尚未由启动组合根装配")
|
||||
|
||||
|
||||
def _missing_existing_runtime() -> None:
|
||||
"""表示当前生命周期尚未物化插件运行时。"""
|
||||
"""
|
||||
表示当前生命周期尚未物化插件运行时。
|
||||
"""
|
||||
return None
|
||||
|
||||
|
||||
@@ -51,26 +69,34 @@ def configure_plugin_runtime(
|
||||
*,
|
||||
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]:
|
||||
"""仅为会改变插件运行态所有权的系统配置取得 mutation lease。"""
|
||||
"""
|
||||
仅为会改变插件运行态所有权的系统配置取得修改准入租约。
|
||||
"""
|
||||
if key is None:
|
||||
return nullcontext()
|
||||
try:
|
||||
|
||||
Reference in New Issue
Block a user