如何参数化 fixtures 和测试函数

pytest 允许在多个级别进行测试参数化

@pytest.mark.parametrize：参数化测试函数

内置的 pytest.mark.parametrize 装饰器可以为测试函数的参数启用参数化。这是一个典型的测试函数示例，该函数实现了检查特定输入是否导致预期输出

# content of test_expectation.py
import pytest


@pytest.mark.parametrize("test_input,expected", [("3+5", 8), ("2+4", 6), ("6*9", 42)])
def test_eval(test_input, expected):
    assert eval(test_input) == expected

在此，@parametrize 装饰器定义了三个不同的 (test_input,expected) 元组，以便 test_eval 函数将使用它们依次运行三次

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

test_expectation.py ..F                                              [100%]

================================= FAILURES =================================
____________________________ test_eval[6*9-42] _____________________________

test_input = '6*9', expected = 42

    @pytest.mark.parametrize("test_input,expected", [("3+5", 8), ("2+4", 6), ("6*9", 42)])
    def test_eval(test_input, expected):
>       assert eval(test_input) == expected
E       AssertionError: assert 54 == 42
E        +  where 54 = eval('6*9')

test_expectation.py:6: AssertionError
========================= short test summary info ==========================
FAILED test_expectation.py::test_eval[6*9-42] - AssertionError: assert 54...
======================= 1 failed, 2 passed in 0.12s ========================

注意

参数值按原样传递给测试（没有任何副本）。

例如，如果将列表或字典作为参数值传递，并且测试用例代码对其进行了修改，则修改将反映在后续的测试用例调用中。

注意

pytest 默认转义用于参数化的 unicode 字符串中的任何非 ASCII 字符，因为它有几个缺点。但是，如果您想在参数化中使用 unicode 字符串并在终端中按原样（非转义）查看它们，请在您的 pytest.ini 中使用此选项

[pytest]
disable_test_id_escaping_and_forfeit_all_rights_to_community_support = True

但请记住，这可能会导致不必要的副作用，甚至错误，具体取决于所使用的操作系统和当前安装的插件，因此请自行承担风险使用它。

如此示例中设计的那样，只有一对输入/输出值未能通过简单的测试函数。与测试函数参数一样，您可以在回溯中看到 input 和 output 值。

请注意，您也可以在类或模块上使用 parametrize 标记（请参阅 如何使用属性标记测试函数），这将使用参数集调用多个函数，例如

import pytest


@pytest.mark.parametrize("n,expected", [(1, 2), (3, 4)])
class TestClass:
    def test_simple_case(self, n, expected):
        assert n + 1 == expected

    def test_weird_simple_case(self, n, expected):
        assert (n * 1) + 1 == expected

要参数化模块中的所有测试，您可以赋值给 pytestmark 全局变量

import pytest

pytestmark = pytest.mark.parametrize("n,expected", [(1, 2), (3, 4)])


class TestClass:
    def test_simple_case(self, n, expected):
        assert n + 1 == expected

    def test_weird_simple_case(self, n, expected):
        assert (n * 1) + 1 == expected

也可以在 parametrize 中标记各个测试实例，例如使用内置的 mark.xfail

# content of test_expectation.py
import pytest


@pytest.mark.parametrize(
    "test_input,expected",
    [("3+5", 8), ("2+4", 6), pytest.param("6*9", 42, marks=pytest.mark.xfail)],
)
def test_eval(test_input, expected):
    assert eval(test_input) == expected

让我们运行它

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

test_expectation.py ..x                                              [100%]

======================= 2 passed, 1 xfailed in 0.12s =======================

先前导致失败的参数集现在显示为 “xfailed”（预期失败）测试。

如果提供给 parametrize 的值导致空列表 - 例如，如果它们是由某些函数动态生成的 - 则 pytest 的行为由 empty_parameter_set_mark 选项定义。

要获取多个参数化参数的所有组合，您可以堆叠 parametrize 装饰器

import pytest


@pytest.mark.parametrize("x", [0, 1])
@pytest.mark.parametrize("y", [2, 3])
def test_foo(x, y):
    pass

这将使用参数设置为 x=0/y=2、x=1/y=2、x=0/y=3 和 x=1/y=3 运行测试，并按照装饰器的顺序耗尽参数。

基本 pytest_generate_tests 示例

有时您可能想要实现自己的参数化方案，或者为确定 fixture 的参数或范围实现一些动态性。为此，您可以使用 pytest_generate_tests hook，它在收集测试函数时被调用。通过传入的 metafunc 对象，您可以检查请求的测试上下文，最重要的是，您可以调用 metafunc.parametrize() 来引起参数化。

例如，假设我们要运行一个接受字符串输入的测试，我们想通过新的 pytest 命令行选项来设置。让我们首先编写一个简单的测试，接受 stringinput fixture 函数参数

# content of test_strings.py


def test_valid_string(stringinput):
    assert stringinput.isalpha()

现在我们添加一个 conftest.py 文件，其中包含命令行选项的添加和测试函数的参数化

# content of conftest.py


def pytest_addoption(parser):
    parser.addoption(
        "--stringinput",
        action="append",
        default=[],
        help="list of stringinputs to pass to test functions",
    )


def pytest_generate_tests(metafunc):
    if "stringinput" in metafunc.fixturenames:
        metafunc.parametrize("stringinput", metafunc.config.getoption("stringinput"))

如果我们现在传递两个 stringinput 值，我们的测试将运行两次

$ pytest -q --stringinput="hello" --stringinput="world" test_strings.py
..                                                                   [100%]
2 passed in 0.12s

让我们也使用一个将导致测试失败的 stringinput 运行

$ pytest -q --stringinput="!" test_strings.py
F                                                                    [100%]
================================= FAILURES =================================
___________________________ test_valid_string[!] ___________________________

stringinput = '!'

    def test_valid_string(stringinput):
>       assert stringinput.isalpha()
E       AssertionError: assert False
E        +  where False = <built-in method isalpha of str object at 0xdeadbeef0001>()
E        +    where <built-in method isalpha of str object at 0xdeadbeef0001> = '!'.isalpha

test_strings.py:4: AssertionError
========================= short test summary info ==========================
FAILED test_strings.py::test_valid_string[!] - AssertionError: assert False
1 failed in 0.12s

正如预期的那样，我们的测试函数失败了。

如果您未指定 stringinput，它将被跳过，因为 metafunc.parametrize() 将使用空参数列表调用

$ pytest -q -rs test_strings.py
s                                                                    [100%]
========================= short test summary info ==========================
SKIPPED [1] test_strings.py: got empty parameter set ['stringinput'], function test_valid_string at /home/sweet/project/test_strings.py:2
1 skipped in 0.12s

请注意，当使用不同的参数集多次调用 metafunc.parametrize 时，这些集合中的所有参数名称都不能重复，否则将引发错误。

更多示例

有关更多示例，您可能需要查看 更多参数化示例。