如何参数化 fixtures 和测试函数¶
pytest 在几个级别上支持测试参数化:
@pytest.mark.parametrize 允许在测试函数或类中定义多组参数和 fixture。
pytest_generate_tests 允许定义自定义参数化方案或扩展。
@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-7.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
值。
注意,您也可以在类或模块(参见 如何用属性标记测试函数),它将调用几个带有参数集的函数,例如:
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
也可以在parameterize中标记单个测试实例,例如使用内置的 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-7.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
钩子,它在收集测试函数时被调用。通过传入的 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
不出所料,我们的测试函数失败了。
If you don’t specify a stringinput it will be skipped because
metafunc.parametrize()
will be called with an empty parameter
list:
$ 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
如果你没有指定 stringinput,它将被跳过,因为 metafunc.parametrize
将被调用时带有一个空的参数列表:
更多例子¶
更多的例子,你可能参考 parametrization examples。