pytest注解应用指南

无界猴

9个月前更新

034163

在pytest测试框架中，注解（通常称为装饰器）用于为测试函数、类或方法提供额外的信息或元数据。这些装饰器可以影响测试的执行方式、报告方式以及测试的组织结构。以下是对pytest注解使用的小结：

一、常用注解及其用途

@pytest.mark.parametrize

用于参数化测试，允许为测试函数提供多个参数集，pytest将为每个参数集运行一次测试。
示例：

import pytest

@pytest.mark.parametrize("input,expected", [(1, 2), (3, 4), (5, 6)])
def test_addition(input, expected):
    assert input + 1 == expected

在这个例子中，test_addition函数将使用三组不同的参数（(1, 2), (3, 4), (5, 6)）分别运行三次。

@pytest.mark.skip和@pytest.mark.skipif

用于跳过测试。
@pytest.mark.skip无条件跳过测试。
@pytest.mark.skipif根据条件跳过测试。
示例：

import pytest
import sys

@pytest.mark.skip(reason="Not ready yet")
def test_not_ready():
    assert True

@pytest.mark.skipif(sys.version_info < (3, 6), reason="Python 3.6+ required")
def test_python_version():
    assert True

在第一个例子中，test_not_ready函数将被无条件跳过。在第二个例子中，如果Python版本低于3.6，test_python_version函数将被跳过。

@pytest.mark.xfail和@pytest.mark.xfailif（注意：@pytest.mark.xfailif不是pytest内置的，但可以通过类似逻辑实现条件性的xfail）

用于标记预期失败的测试。这些测试将被执行，但如果它们失败了，则不会被视为错误。
示例：

import pytest

@pytest.mark.xfail(reason="Known issue")
def test_xfail():
    assert False

# 可以通过编写一个函数来模拟@pytest.mark.xfailif的行为
def pytest_xfail_if(condition, reason):
    def decorator(func):
        if condition:
            func = pytest.mark.xfail(reason=reason)(func)
        return func
    return decorator

@pytest_xfail_if(True, reason="Condition met, expect failure")
def test_conditional_xfail():
    assert False

@pytest.mark.tryfirst和@pytest.mark.trylast

用于控制测试的执行顺序，尤其是在有多个钩子函数（如setup/teardown方法）时。这些装饰器通常与pytest插件中的钩子函数一起使用。
注意：这些装饰器通常不直接用于测试函数，而是用于钩子函数或插件实现。

@pytest.mark.usefixtures

用于声明测试将使用的fixture。虽然这不是严格意义上的装饰器（因为它不直接修饰函数），但它用于指定测试依赖的fixture。
示例：

import pytest

@pytest.fixture
def my_fixture():
    return "fixture value"

@pytest.mark.usefixtures("my_fixture")
def test_with_fixture(my_fixture):
    assert my_fixture == "fixture value"

在这个例子中，test_with_fixture函数将使用名为my_fixture的fixture。

二、自定义注解

在pytest框架中，还可以通过创建自定义注解来扩展测试用例的功能。自定义注解可以帮助为测试用例添加更多的描述信息和执行条件，从而更好地组织和分类测试用例。以下是创建和使用自定义注解的步骤：

确保已经安装了pytest插件。如果没有安装，可以通过pip进行安装：pip install pytest。
创建一个Python文件（例如：custom_annotations.py），在该文件中定义自定义注解。
在测试用例中使用自定义注解来标记测试用例。
运行pytest命令来执行测试用例。pytest会自动扫描所有以.py结尾的文件，并执行其中的测试用例。如果使用了自定义注解，pytest将根据注解信息执行相应的测试用例。