如何对 fixture 和测试函数进行参数化

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 ========================

注意

参数值按原样传递给测试（完全不复制）。

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

注意

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

[pytest]
disable_test_id_escaping_and_forfeit_all_rights_to_community_support = True

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

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

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

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

也可以在参数化中标记各个测试实例，例如使用内置 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 示例

有时，你可能希望实现自己的参数化方案或实现某种动态性来确定参数或夹具的范围。为此，可以使用 pytest_generate_tests 钩子，在收集测试函数时调用此钩子。通过传入的 metafunc 对象，可以检查请求的测试上下文，最重要的是，可以调用 metafunc.parametrize() 来导致参数化。

例如，假设我们要运行一个测试，该测试采用我们希望通过新的 pytest 命令行选项设置的字符串输入。我们首先编写一个简单的测试，接受 stringinput 夹具函数参数

# 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 时，这些集合中的所有参数名称不能重复，否则会引发错误。

更多示例

有关更多示例，你可能希望查看 更多参数化示例。