如何校验Python CLI版本与requirements.txt指定版本匹配并告警

直接用Python生态现成的成熟工具实现即可，完全没必要自己手写requirements.txt解析和版本比对逻辑，避免踩格式兼容、版本排序的坑。

轻量低依赖方案（推荐CLI场景使用） #

这个方案不需要引入重型依赖，解析规则完全对齐pip，适合工具类项目使用：

1. 获取当前CLI实际版本
   用Python标准库importlib.metadata读取当前环境安装的pretext版本，不需要硬编码版本号，结果100%准确，支持Python 3.8及以上所有版本：

from importlib.metadata import version
current_version = version("pretext")

2. 解析requirements.txt中的版本约束
   直接用packaging库的解析能力，这个库是pip的核心依赖，只要用户环境装了pip（能安装你的CLI就必然有pip）就存在，不需要额外安装；如果怕极端环境缺失，直接把packaging加到你CLI的依赖里即可，整个包只有几十KB，没有额外传递依赖。

from packaging.requirements import Requirement
from packaging.version import parse as parse_version

def get_project_required_version(req_file_path="requirements.txt"):
    with open(req_file_path, "r", encoding="utf-8") as f:
        for raw_line in f:
            line = raw_line.strip()
            # 跳过空行、注释行
            if not line or line.startswith("#"):
                continue
            try:
                req = Requirement(line)
                # 匹配pretext包的依赖项
                if req.name.lower() == "pretext":
                    # 样板文件固定生成==匹配规则，直接取固定版本号即可
                    for spec in req.specifier:
                        if spec.operator == "==":
                            return spec.version
            except Exception:
                # 遇到格式不合法的行直接跳过，不阻断CLI运行
                continue
    return None

3. 版本比对与告警
   不要用字符串直接比对版本号，会出现1.10.0 < 1.2.0这类逻辑错误，用packaging.version做语义化版本比对：

import warnings

required_version = get_project_required_version()
if required_version:
    if parse_version(current_version) != parse_version(required_version):
        warnings.warn(
            f"当前运行的PreTeXt CLI版本为{current_version}，与项目requirements.txt中指定的{required_version}不匹配，"
            "可能出现项目构建异常，建议执行 `pip install -r requirements.txt` 安装版本匹配的依赖后重试。"
        )

把这段逻辑放在CLI的入口函数最前面，用户执行任何子命令都会先做检测，覆盖所有使用场景。

复杂场景方案 #

如果后续需要支持requirements.txt的所有语法（比如-r引用其他依赖文件、环境标记、可编辑安装、行内注释等边缘格式），直接用pip-requirements-parser库，这个库的解析逻辑100%对齐pip官方行为，不会出现识别结果和pip不一致的问题，用法也很简单：

from pip_requirements_parser import RequirementsFile

req_file = RequirementsFile.from_file("requirements.txt")
for req in req_file.requirements:
    if req.name and req.name.lower() == "pretext":
        # 提取版本约束做后续比对即可
        pass

落地注意事项 #

• 版本不匹配时只弹警告，不要直接阻断CLI运行，给用户自主选择的空间
• 如果在requirements.txt里没找到pretext的依赖项，直接静默跳过即可，不要抛错影响正常使用
• 不要自己手写解析逻辑，requirements.txt的格式细节非常多，自己维护解析逻辑的成本远高于引入成熟库

内容的提问来源于stack exchange，提问作者Steven Clontz