Pytest误收集非测试类TestSuite的问题排查与解决

你配置的--doctest-modules参数会让pytest扫描所有可导入的Python模块（并非仅testpaths指定的tests目录），用于查找文档字符串中的测试用例。而module/suite.py中的TestSuite类名称符合python_classes = Test*的匹配规则，pytest会尝试将其识别为测试类收集。但该类定义了自定义__init__构造方法，不符合pytest对测试类的要求（pytest默认要求测试类不能有带参数的__init__，否则无法正常实例化收集），因此触发警告。

以下几种方案可以解决该问题：

方案一：限制doctest的扫描范围 #

修改pytest.ini中的addopts，让--doctest-modules仅作用于指定目录，避免扫描module目录：

[pytest]
addopts = --doctest-modules tests/
testpaths = tests
python_files = test_*.py
python_classes = Test*

或者直接添加--ignore参数排除module目录：

[pytest]
addopts = --doctest-modules --ignore=module/
testpaths = tests
python_files = test_*.py
python_classes = Test*

方案二：标记业务类为非测试类 #

在module/suite.py的TestSuite类中添加__test__ = False属性，明确告知pytest跳过该类的收集：

class TestSuite:
    __test__ = False
    def __init__(self, ...):
        # 原有构造方法逻辑
        pass

方案三：收紧测试类匹配规则 #

如果业务类经常出现Test前缀，可以修改python_classes为更严格的匹配规则，比如仅匹配以Test开头且后缀为Case的类：

[pytest]
addopts = --doctest-modules
testpaths = tests
python_files = test_*.py
python_classes = Test*Case

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