Pytest测试收集机制深度解析：定制化你的测试发现策略

引言

在Python测试框架Pytest中，测试收集是一个核心功能，它决定了哪些文件、类和函数会被识别为测试用例。本文将深入探讨Pytest的测试收集机制，并展示如何根据项目需求进行灵活定制。

基础测试收集规则

Pytest默认遵循以下命名规则进行测试收集：

• 测试文件：test_*.py或*_test.py
• 测试类：以Test开头的类
• 测试函数：以test_开头的函数

忽略特定测试路径

使用--ignore选项

在大型项目中，有时需要排除某些目录或模块不被收集为测试：

pytest --ignore=tests/foobar/test_foobar_03.py --ignore=tests/hello/

使用--ignore-glob选项

支持Unix shell风格的通配符模式：

pytest --ignore-glob='*_01.py'

选择性取消测试收集

可以使用--deselect选项在收集阶段排除特定测试项：

pytest --deselect tests/foobar/test_foobar_01.py::test_a

处理重复路径

默认情况下，Pytest会忽略命令行中指定的重复路径：

pytest path_a path_a  # 只收集一次

使用--keep-duplicates选项可以改变这一行为：

pytest --keep-duplicates path_a path_a  # 收集两次

目录递归控制

通过pytest.ini配置文件可以限制Pytest的递归搜索行为：

[pytest]
norecursedirs = .svn _build tmp*

自定义命名约定

可以完全自定义测试发现模式：

[pytest]
python_files = check_*.py
python_classes = Check
python_functions = *_check

对于多模式匹配，用空格分隔：

[pytest]
python_files = test_*.py example_*.py

命令行参数作为Python包

--pyargs选项让Pytest将参数解释为Python包名：

pytest --pyargs unittest2.test.test_skipping -q

查看收集结果

使用--collect-only选项可以预览测试收集结果而不实际运行测试：

pytest --collect-only

高级自定义收集

使用conftest.py动态忽略

import sys

collect_ignore = ["setup.py"]
if sys.version_info[0] > 2:
    collect_ignore.append("pkg/module_py2.py")

使用通配符忽略

import sys

collect_ignore = ["setup.py"]
if sys.version_info[0] > 2:
    collect_ignore_glob = ["*_py2.py"]

控制类级别的测试收集

从Pytest 2.6开始，可以通过设置__test__ = False来阻止类被收集为测试：

class TestClass:
    __test__ = False  # 不会被收集为测试类

对于抽象测试类，可以使用mixin模式自动处理：

class NotATest:
    def __init_subclass__(cls):
        cls.__test__ = NotATest not in cls.__bases__

class AbstractTest(NotATest):
    pass

class RealTest(AbstractTest):  # 会被收集为测试类
    def test_example(self):
        assert 1 + 1 == 2

总结

Pytest提供了极其灵活的测试收集机制，允许开发者根据项目需求进行各种定制。从简单的路径排除到复杂的动态收集控制，Pytest都能满足需求。掌握这些技巧可以帮助你构建更高效、更有针对性的测试套件。

通过合理配置测试收集策略，你可以：

• 加快测试收集速度
• 排除不相关的测试
• 创建更适合项目结构的测试组织方式
• 实现跨Python版本的测试兼容性

这些功能使得Pytest成为Python生态中最强大、最灵活的测试框架之一。