refactor(types): declare progress snapshot fields

2026-11-02 13:28:32 +08:00 · 2026-10-16 16:53:39 +08:00
parent 931a16307a
commit e71b225597
6 changed files with 26 additions and 16 deletions
--- a/app/runtime/progress.py
+++ b/app/runtime/progress.py
@@ -1,11 +1,22 @@
+from collections.abc import Mapping
 from enum import Enum
-from typing import Optional, Union
+from typing import Optional, TypedDict, Union

 from app.runtime.cache import AsyncTTLCache, TTLCache
 from app.runtime.localization import LocaleHelper
 from app.schemas.types import ProgressKey


+class ProgressSnapshot(TypedDict, total=False):
+    """进度缓存的已声明字段；允许历史或部分快照缺少键。"""
+
+    enable: bool
+    value: float
+    text: str
+    text_i18n: str
+    data: dict[str, object]
+
+
 class ProgressHelper:
    """
    处理进度辅助类
@@ -43,7 +54,7 @@ class ProgressHelper:
    def end(
            self,
            text: Optional[str] = "",
-            data: Optional[dict] = None,
+            data: Optional[Mapping[str, object]] = None,
            value: Optional[Union[float, int]] = 100,
    ) -> None:
        """
@@ -66,7 +77,7 @@ class ProgressHelper:
            self,
            value: Optional[Union[float, int]] = None,
            text: Optional[str] = None,
-            data: Optional[dict] = None,
+            data: Optional[Mapping[str, object]] = None,
    ) -> None:
        """
        更新进度
@@ -84,14 +95,14 @@ class ProgressHelper:
            current['data'].update(data)
        self._progress[self._key] = current

-    def get(self, locale: Optional[str] = None) -> Optional[dict]:
+    def get(self, locale: Optional[str] = None) -> Optional[ProgressSnapshot]:
        """
        获取当前进度，并按语言补充前端展示字段。

        :param locale: 目标语言，未传入时使用当前请求上下文语言
        :return: 当前进度字典
        """
-        current = self._progress.get(self._key)
+        current: ProgressSnapshot | None = self._progress.get(self._key)
        if not current:
            return current

@@ -158,7 +169,7 @@ class AsyncProgressHelper:
    async def end(
            self,
            text: Optional[str] = "",
-            data: Optional[dict] = None,
+            data: Optional[Mapping[str, object]] = None,
            value: Optional[Union[float, int]] = 100,
    ) -> None:
        """
@@ -187,7 +198,7 @@ class AsyncProgressHelper:
            self,
            value: Optional[Union[float, int]] = None,
            text: Optional[str] = None,
-            data: Optional[dict] = None,
+            data: Optional[Mapping[str, object]] = None,
    ) -> None:
        """
        更新进度
@@ -205,14 +216,14 @@ class AsyncProgressHelper:
            current['data'].update(data)
        await self._progress.set(self._key, current)

-    async def get(self, locale: Optional[str] = None) -> Optional[dict]:
+    async def get(self, locale: Optional[str] = None) -> Optional[ProgressSnapshot]:
        """
        获取当前进度，并按语言补充前端展示字段。

        :param locale: 目标语言，未传入时使用当前请求上下文语言
        :return: 当前进度字典
        """
-        current = await self._progress.get(self._key)
+        current: ProgressSnapshot | None = await self._progress.get(self._key)
        if not current:
            return current

--- a/docs/code-quality.md
+++ b/docs/code-quality.md
@@ -75,7 +75,7 @@ uv run --locked --no-sync python scripts/architecture/complexity.py
 回调和返回值类型；全仓错误计数为零并不保证单独纳入 strict frontier 后也为零。

 2026-10-16 开始逐文件清理类型债务，`app/domain/title.py` 通过局部可空类型声明保留
-既有搜索解析行为，并纳入严格清单；当前清单共 85 个文件（84 个生产文件和 1 个脚本）。
+既有搜索解析行为，并纳入严格清单；当前清单共 86 个文件（85 个生产文件和 1 个脚本）。
 每个治理提交聚焦一个生产文件及其必要测试、门禁配置、真实下降基线和指标文档。
 验收同时检查完整严格清单与全宿主 Linux 分析，避免 `follow_imports = skip` 隐藏依赖
 签名冲突；不通过忽略诊断或放宽类型合同接受回退。最新文件清单以 `mypy.ini` 为准，
--- a/docs/refactor/optimization-checklist.md
+++ b/docs/refactor/optimization-checklist.md
@@ -106,9 +106,9 @@ ARCH-201 至 ARCH-204 均达到实现、验证、提交、推送和远端门禁
 | Model/Oper 事务债务 | 0 | 自建 Session、自动事务装饰器、直接 commit/rollback 等基线均为零 |
 | Module Contract | 215 specs / 211 methods / 263 calls | 动态方法名为 0；分类事实富化通过显式合同进入插件调度，旧 YAML 分类方法已移除；download 新增 custom_words 可选参数，旧 provider 签名通过显式合同兼容 |
 | Event Contract | 53 | 均已有 payload model，但当前全部是 diagnostic enforcement |
-| Python 源码量 | 372,243 行 | 本次重新扫描物理行数，排除 `app/plugins/**`；74 个文件超过 1,000 行，12 个超过 2,000 行；源码尺寸仅作观察 |
+| Python 源码量 | 372,254 行 | 本次重新扫描物理行数，排除 `app/plugins/**`；74 个文件超过 1,000 行，12 个超过 2,000 行；源码尺寸仅作观察 |
 | 长方法 | 309 个超过 80 行 | 本次 AST 扫描排除 `app/plugins/**`；61 个超过 150 行，17 个超过 250 行；新增函数仍受 C901/嵌套深度门禁约束 |
-| 全量 mypy 历史债务 | 8,900 / 468 文件 | 通知排版补齐 Slack 消息块类型，历史债务减少 2 项；工作流资源过滤改用领域对象调用过滤链，恢复的节点输出在消费前归一化，并收紧可空资源列表的类型低水位；消息媒体交互类型债务已清零，canonical Facade 与 endpoint 类型边界已补齐，低水位只允许继续下降；微信 ClawBot 入站 item_list 媒体解析改为按子项键名分派后，类型错误减少 4 项；站点解析器分享率改用浮点初值，类型错误减少 20 项；本次下载与文件安全修复再减少 3 项；Transmission 进度回退值归一化再减少 2 项，逐文件逐错误码无增长 |
+| 全量 mypy 历史债务 | 8,890 / 467 文件 | 通知排版补齐 Slack 消息块类型，历史债务减少 2 项；工作流资源过滤改用领域对象调用过滤链，恢复的节点输出在消费前归一化，并收紧可空资源列表的类型低水位；消息媒体交互类型债务已清零，canonical Facade 与 endpoint 类型边界已补齐，低水位只允许继续下降；微信 ClawBot 入站 item_list 媒体解析改为按子项键名分派后，类型错误减少 4 项；站点解析器分享率改用浮点初值，类型错误减少 20 项；本次下载与文件安全修复再减少 3 项；Transmission 进度回退值归一化再减少 2 项，逐文件逐错误码无增长 |
 | Ruff 历史诊断 | 100 | 低水位门禁通过，但规则集只覆盖 `E4/E7/E9/F/I` |
 | 覆盖率固定基线 | Application 80.00%，Domain 80.00% | Chain、Runtime、Agent、Adapter、Startup 未进入包级覆盖率门禁 |

--- a/mypy.ini
+++ b/mypy.ini
@@ -35,6 +35,7 @@ files =
    app/runtime/localization.py,
    app/runtime/settings.py,
    app/runtime/reload.py,
+    app/runtime/progress.py,
    app/runtime/observability/__init__.py,
    app/runtime/thread.py,
    app/runtime/tasks.py,
--- a/tests/fixtures/architecture/mypy-baseline.json
+++ b/tests/fixtures/architecture/mypy-baseline.json
@@ -2400,10 +2400,6 @@
    "no-any-return": 6,
    "type-arg": 4
  },
-  "app/runtime/progress.py": {
-    "no-any-return": 4,
-    "type-arg": 6
-  },
  "app/runtime/rate.py": {
    "assignment": 1,
    "no-untyped-call": 8,
--- a/tests/test_scheduler_progress.py
+++ b/tests/test_scheduler_progress.py
@@ -182,6 +182,7 @@ def test_scheduler_records_cancelled_async_job_as_failed():
        raise asyncio.CancelledError

    async def run_task():
+        """等待取消传播到调度外壳并完成失败终态收口。"""
        job = scheduler._prepare_job(job_id)
        with pytest.raises(asyncio.CancelledError):
            await scheduler._run_coro_job(task, job_id, job)
@@ -245,6 +246,7 @@ def test_async_progress_end_rebuilds_terminal_snapshot_after_read_failure():
        """模拟读取失败但仍可写入的进度后端。"""

        def __init__(self):
+            """初始化用于观察终态写入的缓存槽位。"""
            self.value = None

        async def get(self, _key):