如何在pytest中优雅跳过未安装可选依赖时的测试用例？

嗨，我来帮你优化这个实现！你的思路方向是对的，但确实有更简洁、更贴合pytest生态的做法——不用自己手动解析pyproject.toml和版本要求，直接利用Python标准库和成熟的工具库来搞定，代码更健壮也更易维护。

优化后的最终实现 #

首先，我们需要一个工具库来处理版本要求的解析与检查，packaging是Python生态中处理这类需求的标准库（pytest自身的很多依赖检查也用它）。先安装它：

pip install packaging

然后是装饰器的完整实现：

from functools import wraps
from packaging.requirements import Requirement
from packaging.version import Version, InvalidVersion
import importlib.metadata
import pytest

# 兼容Python 3.10及以下版本（3.11+内置tomllib）
try:
    import tomllib
except ImportError:
    import toml as tomllib
from pathlib import Path

def requires_optional_dependency(extra_name):
    """
    pytest测试装饰器：仅当指定的可选依赖组所有包都满足版本要求时运行测试，否则跳过
    """
    def decorator(test_func):
        @wraps(test_func)
        def wrapper(*args, **kwargs):
            # 1. 获取当前环境已安装的所有包及其版本
            installed_packages = {}
            for dist in importlib.metadata.distributions():
                pkg_name = dist.metadata["Name"].lower()
                installed_packages[pkg_name] = dist.version

            # 2. 从pyproject.toml读取目标可选依赖组的要求
            try:
                with Path("pyproject.toml").open("rb") as f:
                    pyproject_data = tomllib.load(f)
                extra_requirements = pyproject_data["project"]["optional-dependencies"][extra_name]
            except FileNotFoundError:
                pytest.skip(f"未找到pyproject.toml文件，无法获取可选依赖配置")
            except KeyError:
                pytest.skip(f"pyproject.toml中不存在名为 {extra_name} 的可选依赖组")

            # 3. 逐一检查每个依赖是否满足要求
            missing_or_invalid = []
            for req_str in extra_requirements:
                try:
                    req = Requirement(req_str)
                except ValueError:
                    # 处理无法解析的依赖（如git链接、本地路径）
                    pytest.skip(f"无法解析依赖要求 {req_str}，跳过测试")

                pkg_name_lower = req.name.lower()
                # 检查包是否已安装
                if pkg_name_lower not in installed_packages:
                    missing_or_invalid.append(f"{req.name} 未安装")
                    continue

                # 检查版本是否符合要求
                installed_version = installed_packages[pkg_name_lower]
                try:
                    installed_version_obj = Version(installed_version)
                except InvalidVersion:
                    missing_or_invalid.append(f"{req.name} 安装版本 {installed_version} 格式无效")
                    continue

                if req.specifier and not req.specifier.contains(installed_version_obj, prereleases=True):
                    missing_or_invalid.append(
                        f"{req.name} 版本不满足：需要 {req.specifier}，当前为 {installed_version}"
                    )

            # 4. 如果有不满足的情况，跳过测试
            if missing_or_invalid:
                skip_reason = "可选依赖不满足：" + "，".join(missing_or_invalid)
                pytest.skip(skip_reason)

            # 5. 所有依赖都满足，执行测试
            return test_func(*args, **kwargs)
        return wrapper
    return decorator

使用方式 #

和你预想的完全一致，直接给测试函数加装饰器即可：

@requires_optional_dependency("extra_name")
def test_something():
    # 你的测试逻辑
    assert True

为什么这个实现更优雅？ #

1. 贴合pytest生态：使用pytest.skip()标记跳过的测试，会被pytest的测试报告正确统计，而不是抛出未处理的异常。
2. 标准依赖检查：用packaging库解析版本要求，自动处理所有常见的版本规范（>=1.0、~=2.1、!=3.0等），比自己写版本比较逻辑靠谱得多。
3. 现代API：用Python 3.8+内置的importlib.metadata获取已安装包信息，替代老旧的pkg_resources，性能和兼容性更好。
4. 边界情况处理：覆盖了pyproject.toml不存在、可选依赖组不存在、依赖格式无法解析、版本号无效等多种异常场景，鲁棒性更强。
5. 代码可读性：结构清晰，注释明确，后续维护成本低。

简化场景的替代方案 #

如果你的需求很简单，只需要检查某个特定包是否安装（不需要版本检查或整个组的检查），可以用更轻量的实现：

import importlib
import pytest

def requires_package(package_name):
    try:
        importlib.import_module(package_name)
        return True
    except ImportError:
        return False

# 直接用pytest的skipif标记
@pytest.mark.skipif(not requires_package("package_name"), reason="需要package_name依赖")
def test_simple():
    pass

注意事项 #

• 把packaging加入你的开发依赖组（比如pyproject.toml的dev可选依赖），确保所有开发者环境都有这个包。
• 如果你的包是在可编辑模式下安装的（pip install -e .），也可以通过importlib.metadata直接读取包自身的可选依赖，无需解析pyproject.toml，不过解析toml的方式在未安装包的开发场景下更通用。

备注：内容来源于stack exchange，提问作者Sam