Pytest 5.x+ 迁移：使用自定义标记实现条件测试执行

pytest 5.x+ 版本移除了 `pytest.config`，导致旧版中通过命令行参数控制测试跳过/运行的方法失效。本文将指导用户如何优雅地将现有基于装饰器的条件测试逻辑迁移到 pytest 5.x+，通过利用自定义标记（`pytest.mark`）和 `pytest.ini` 配置，结合 `-m` 命令行选项，实现对特定标记测试的灵活选择性执行或跳过，无需大规模修改现有测试代码。

引言：Pytest 5.x+ 中 pytest.config 的变迁与挑战

在 Pytest 4.x 及更早版本中，开发者常通过 pytest.config.getoption() 方法结合自定义命令行参数来控制测试的执行逻辑，例如条件性地跳过或运行某些测试集。这种方式尤其适用于集成测试或需要特定环境才能运行的测试。一个典型的实现如下所示：

# common.py (Pytest 4.x 示例)
import pytest

integration = pytest.mark.skipif(
    not pytest.config.getoption('--integration', False),
    reason="需要 --integration 命令行参数才能运行"
)

# test_something.py
from .common import integration

@integration
def test_my_integration_feature():
    assert 1 == 1

@integration
def test_another_integration_feature():
    assert 2 == 2

然而，随着 Pytest 升级到 5.x+ 版本，pytest.config 属性被移除，导致上述代码会抛出 AttributeError: module 'pytest' has no attribute 'config' 错误。这给依赖此类机制的项目带来了迁移挑战，尤其是在存在大量已使用这种装饰器语法的测试时，如何平滑过渡成为关键问题。

解决方案：利用自定义标记 (pytest.mark) 实现条件测试

Pytest 5.x+ 版本推荐使用内置的标记（marker）系统结合 -m 命令行选项来管理和过滤测试。这种方法不仅功能强大，而且与旧版的装饰器语法兼容，使得迁移过程更为顺畅。核心思路是定义一个自定义标记，并将其应用于需要特殊处理的测试。

1. 定义自定义标记

首先，我们需要在 pytest.ini（或 pyproject.toml）配置文件中注册我们的自定义标记。这有助于 Pytest 识别该标记，并在运行测试时提供更好的提示，避免出现未知标记的警告。

在项目根目录下创建或修改 pytest.ini 文件，添加 markers 部分：

# pytest.ini
[pytest]
markers =
    integration: 标记集成测试

这里，integration 是我们定义的标记名称，冒号后面是对该标记的简要描述。

2. 将标记应用于测试

接下来，修改你的 common.py 文件或直接在测试文件中使用新的 pytest.mark 装饰器。由于我们希望保持与现有装饰器语法的兼容性，可以这样定义 integration 装饰器：

# common.py (Pytest 5.x+ 兼容)
import pytest

# 定义一个名为 'integration' 的标记
integration = pytest.mark.integration

# test_something.py
from .common import integration

@integration
def test_my_integration_feature():
    """这是一个集成测试。"""
    assert 1 == 1

@integration
def test_another_integration_feature():
    """这是另一个集成测试。"""
    assert 2 == 2

def test_regular_feature():
    """这是一个常规测试，没有集成标记。"""
    assert True

现在，@integration 装饰器不再依赖 pytest.config，而是直接应用了 integration 标记。

实践示例

让我们通过一个完整的例子来演示如何在 Pytest 5.x+ 中使用自定义标记来选择性地运行测试。

Rose.ai

一个云数据平台，帮助用户发现、可视化数据

74

查看详情

项目结构：

my_project/
├── pytest.ini
├── common.py
└── test_example.py

文件内容：

pytest.ini:

[pytest]
markers =
    integration: 标记集成测试

common.py:

import pytest

integration = pytest.mark.integration

test_example.py:

from .common import integration

@integration
def test_case_1_integration():
    print("Running integration test 1")
    assert 1 == 1

def test_case_2_unit():
    print("Running unit test 2")
    assert "hello" == "hello"

@integration
def test_case_3_integration():
    print("Running integration test 3")
    assert [1, 2] == [1, 2]

运行与验证：

1. 运行所有测试： 不带任何标记过滤选项，Pytest 将运行所有收集到的测试。

   $ pytest -v
   ============================= test session starts ==============================
   platform linux -- Python 3.x.x, pytest-x.x.x, pluggy-x.x.x
   rootdir: /path/to/my_project, configfile: pytest.ini
   collected 3 items
   
   test_example.py::test_case_1_integration PASSED                         [ 33%]
   Running integration test 1
   test_example.py::test_case_2_unit PASSED                                [ 66%]
   Running unit test 2
   test_example.py::test_case_3_integration PASSED                         [100%]
   Running integration test 3
   
   ============================== 3 passed in 0.00s ===============================

   登录后复制

2. 只运行带有 integration 标记的测试： 使用 -m integration 选项，Pytest 会只选择那些被 @integration 装饰器标记的测试。

   $ pytest -v -m integration
   ============================= test session starts ==============================
   platform linux -- Python 3.x.x, pytest-x.x.x, pluggy-x.x.x
   rootdir: /path/to/my_project, configfile: pytest.ini
   collected 3 items / 1 deselected / 2 selected
   
   test_example.py::test_case_1_integration PASSED                         [ 50%]
   Running integration test 1
   test_example.py::test_case_3_integration PASSED                         [100%]
   Running integration test 3
   
   ======================= 2 passed, 1 deselected in 0.00s ========================

   登录后复制

3. 只运行没有 integration 标记的测试（即跳过集成测试）： 使用 -m 'not integration' 选项，Pytest 会选择那些没有被 @integration 标记的测试。

   $ pytest -v -m 'not integration'
   ============================= test session starts ==============================
   platform linux -- Python 3.x.x, pytest-x.x.x, pluggy-x.x.x
   rootdir: /path/to/my_project, configfile: pytest.ini
   collected 3 items / 2 deselected / 1 selected
   
   test_example.py::test_case_2_unit PASSED                                [100%]
   Running unit test 2
   
   ======================= 1 passed, 2 deselected in 0.00s ========================

   登录后复制

通过上述示例，我们可以看到，无需修改已有的装饰器语法，仅需调整 integration 装饰器的定义和 pytest.ini 配置，即可在 Pytest 5.x+ 中实现与旧版相同甚至更灵活的测试过滤机制。

注意事项与最佳实践

• 标记注册的重要性： 尽管不注册标记也能使用，但注册可以避免 Pytest 发出警告，并使你的测试配置更清晰。
• -m 选项的强大功能： -m 选项支持复杂的布尔表达式，例如 pytest -m "integration and not slow" 或 pytest -m "api or database"，这使得测试过滤非常灵活。
• 与旧版装饰器的兼容性： 这种方法完美兼容原有的 @integration 装饰器语法，意味着你无需修改大量的测试文件，只需调整装饰器的定义即可。
• 避免过度使用： 虽然标记系统强大，但过度细化标记可能导致管理复杂性增加。合理规划标记的粒度和用途至关重要。

总结

Pytest 5.x+ 版本对 pytest.config 的移除虽然带来了迁移挑战，但通过其强大的自定义标记系统和 -m 命令行选项，我们能够以更优雅、更符合 Pytest 最佳实践的方式实现测试的条件执行与跳过。这种方法不仅解决了旧版 pytest.config 的兼容性问题，还提供了更灵活、更可维护的测试管理机制，是 Pytest 5.x+ 及更高版本中处理此类需求的推荐方案。

以上就是Pytest 5.x+ 迁移：使用自定义标记实现条件测试执行的详细内容，更多请关注php中文网其它相关文章！