使用自定义目录收集器

默认情况下，pytest 使用 pytest.Package 收集目录，对于带有 __init__.py 文件的目录，以及 pytest.Dir 对于其他目录。如果你想自定义目录的收集方式，你可以编写自己的 pytest.Directory 收集器，并使用 pytest_collect_directory 钩入它。

目录清单文件的简单示例

假设你想自定义在每个目录的基础上完成收集的方式。这里有一个示例 conftest.py 插件，它允许目录包含一个 manifest.json 文件，该文件定义了如何为目录完成收集。在此示例中，只支持一个简单的文件列表，但是你可以想象添加其他键，例如排除项和 glob。

# content of conftest.py
import json

import pytest


class ManifestDirectory(pytest.Directory):
    def collect(self):
        # The standard pytest behavior is to loop over all `test_*.py` files and
        # call `pytest_collect_file` on each file. This collector instead reads
        # the `manifest.json` file and only calls `pytest_collect_file` for the
        # files defined there.
        manifest_path = self.path / "manifest.json"
        manifest = json.loads(manifest_path.read_text(encoding="utf-8"))
        ihook = self.ihook
        for file in manifest["files"]:
            yield from ihook.pytest_collect_file(
                file_path=self.path / file, parent=self
            )


@pytest.hookimpl
def pytest_collect_directory(path, parent):
    # Use our custom collector for directories containing a `mainfest.json` file.
    if path.joinpath("manifest.json").is_file():
        return ManifestDirectory.from_parent(parent=parent, path=path)
    # Otherwise fallback to the standard behavior.
    return None

你可以创建一个 manifest.json 文件和一些测试文件

{
    "files": [
        "test_first.py",
        "test_second.py"
    ]
}

# content of test_first.py
def test_1():
    pass

# content of test_second.py
def test_2():
    pass

# content of test_third.py
def test_3():
    pass

现在你可以执行测试规范

customdirectory $ pytest
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-8.x.y, pluggy-1.x.y
rootdir: /home/sweet/project/customdirectory
configfile: pytest.ini
collected 2 items

tests/test_first.py .                                                [ 50%]
tests/test_second.py .                                               [100%]

============================ 2 passed in 0.12s =============================

请注意 test_three.py 未执行，因为它未在清单中列出。

你可以验证你的自定义收集器是否出现在收集树中

customdirectory $ pytest --collect-only
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-8.x.y, pluggy-1.x.y
rootdir: /home/sweet/project/customdirectory
configfile: pytest.ini
collected 2 items

<Dir customdirectory>
  <ManifestDirectory tests>
    <Module test_first.py>
      <Function test_1>
    <Module test_second.py>
      <Function test_2>

======================== 2 tests collected in 0.12s ========================