跳转至

共享 CLI 版本命令设计

日期:2026-07-21

目标

添加 mineru-kit version 和 mineru-kit --version,使其具有与现有 mineru 入口点完全相同的文本输出、JSON 输出和退出行为。

设计

将现有版本命令实现从 mineru/cli/main.py 提取到一个轻量共享模块 mineru/cli/version_command.py。该模块负责:

  • VersionInfo 结果类型;
  • MinerU 和 Python 版本收集;
  • 纯文本渲染;
  • version --json Typer 命令回调;
  • 根级 --version 选项的立即执行回调。

两个根应用都导入并注册同一个 version_cmd 回调。两个根回调都使用同一个立即执行的 show_version 选项回调。主 mineru 回调继续为常规命令准备遥测;立即执行的版本输出会在遥测准备之前退出,与当前行为一致。MinerU Kit 回调没有额外副作用。

共享模块使用现有的 CliContext 和 run_cli 路径,使 version --json 保留当前的序列化行为。它只导入轻量级 CLI 运行时代码,不导入任一根命令树。

命令注册

主 CLI 继续在其有序命令列表末尾注册 version。MinerU Kit 在其有序命令列表中 models 之后添加 version,并直接注册共享回调:

app.command("version")(version_cmd)

两个根应用都暴露一个立即执行的 --version 选项,并使用现有帮助文本 Show the version and exit.

输出契约

纯文本输出保持为:

MinerU version: <version>
Python version: <version>

JSON 输出仍为包含 mineru_version 和 python_version 字段的单个对象。两个可执行文件的产品标签均保持为 MinerU version。

错误和导入边界

版本收集只读取本地包版本和当前 Python 版本。它不执行网络访问,也不加载解析器、模型、旧版路由器或服务端实现。现有 mineru-kit 的延迟导入边界保持不变。

验证

测试验证:

  1. 现有 mineru version、mineru version --json 和 mineru --version 行为保持不变。
  2. MinerU Kit 在最终顶层命令位置暴露 version,并在根帮助中暴露 --version。
  3. mineru-kit version 与 mineru version 完全一致。
  4. mineru-kit --version 与其 version 子命令一致。
  5. 两个 JSON 子命令输出相同的单个 JSON 对象。
  6. 导入 mineru.kit.main 仍然避免旧版路由器和服务端实现。
  7. 受跟踪的单元测试套件保持通过。

本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 mi/MinerU