参数化测试¶
pytest 允许轻松参数化测试函数。有关基本文档，请参阅 如何参数化固定装置和测试函数。
以下我们提供一些使用内置机制的示例。
根据命令行生成参数组合¶
假设我们希望使用不同的计算参数执行测试，并且参数范围应由命令行参数确定。让我们首先编写一个简单的（无操作）计算测试
# content of test_compute.py
def test_compute(param1):
assert param1 < 4
现在，我们添加如下测试配置
# content of conftest.py
def pytest_addoption(parser):
parser.addoption("--all", action="store_true", help="run all combinations")
def pytest_generate_tests(metafunc):
if "param1" in metafunc.fixturenames:
if metafunc.config.getoption("all"):
end = 5
else:
end = 2
metafunc.parametrize("param1", range(end))
这意味着如果我们不传递 --all，我们只运行 2 个测试
$ pytest -q test_compute.py
.. [100%]
2 passed in 0.12s
我们只运行两个计算，所以我们看到两个点。让我们运行全部
$ pytest -q --all
....F [100%]
================================= FAILURES =================================
_____________________________ test_compute[4] ______________________________
param1 = 4
def test_compute(param1):
> assert param1 < 4
E assert 4 < 4
test_compute.py:4: AssertionError
========================= short test summary info ==========================
FAILED test_compute.py::test_compute[4] - assert 4 < 4
1 failed, 4 passed in 0.12s
正如预期的那样，在运行 param1 值的完整范围时，我们会在最后一个值上收到错误。
测试 ID 的不同选项¶
pytest 将构建一个字符串，该字符串是参数化测试中每组值的测试 ID。这些 ID 可与 -k 一起使用，以选择要运行的特定案例，并且当一个案例失败时，它们还将识别该特定案例。使用 --collect-only 运行 pytest 将显示生成的 ID。
数字、字符串、布尔值和 None 将在其通常的字符串表示形式中用于测试 ID。对于其他对象，pytest 将基于参数名称生成一个字符串
# content of test_time.py
from datetime import datetime, timedelta
import pytest
testdata = [
(datetime(2001, 12, 12), datetime(2001, 12, 11), timedelta(1)),
(datetime(2001, 12, 11), datetime(2001, 12, 12), timedelta(-1)),
]
@pytest.mark.parametrize("a,b,expected", testdata)
def test_timedistance_v0(a, b, expected):
diff = a - b
assert diff == expected
@pytest.mark.parametrize("a,b,expected", testdata, ids=["forward", "backward"])
def test_timedistance_v1(a, b, expected):
diff = a - b
assert diff == expected
def idfn(val):
if isinstance(val, (datetime,)):
# note this wouldn't show any hours/minutes/seconds
return val.strftime("%Y%m%d")
@pytest.mark.parametrize("a,b,expected", testdata, ids=idfn)
def test_timedistance_v2(a, b, expected):
diff = a - b
assert diff == expected
@pytest.mark.parametrize(
"a,b,expected",
[
pytest.param(
datetime(2001, 12, 12), datetime(2001, 12, 11), timedelta(1), id="forward"
),
pytest.param(
datetime(2001, 12, 11), datetime(2001, 12, 12), timedelta(-1), id="backward"
),
],
)
def test_timedistance_v3(a, b, expected):
diff = a - b
assert diff == expected
在 test_timedistance_v0 中，我们让 pytest 生成测试 ID。
在 test_timedistance_v1 中，我们将 ids 指定为用作测试 ID 的字符串列表。这些字符串简洁，但维护起来可能很麻烦。
在 test_timedistance_v2 中，我们将 ids 指定为一个函数，该函数可以生成一个字符串表示形式，以作为测试 ID 的一部分。因此，我们的 datetime 值使用 idfn 生成的标签，但由于我们没有为 timedelta 对象生成标签，因此它们仍在使用默认的 pytest 表示形式
$ pytest test_time.py --collect-only
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-8.x.y, pluggy-1.x.y
rootdir: /home/sweet/project
collected 8 items
<Dir parametrize.rst-198>
<Module test_time.py>
<Function test_timedistance_v0[a0-b0-expected0]>
<Function test_timedistance_v0[a1-b1-expected1]>
<Function test_timedistance_v1[forward]>
<Function test_timedistance_v1[backward]>
<Function test_timedistance_v2[20011212-20011211-expected0]>
<Function test_timedistance_v2[20011211-20011212-expected1]>
<Function test_timedistance_v3[forward]>
<Function test_timedistance_v3[backward]>
======================== 8 tests collected in 0.12s ========================
在 test_timedistance_v3 中，我们使用 pytest.param 将测试 ID 与实际数据一起指定，而不是单独列出它们。
快速移植“testscenarios”¶
这是一个快速移植，用于运行使用 testscenarios 配置的测试，这是 Robert Collins 为标准 unittest 框架提供的附加组件。我们只需要做一些工作来构建 pytest 的 Metafunc.parametrize 的正确参数
# content of test_scenarios.py
def pytest_generate_tests(metafunc):
idlist = []
argvalues = []
for scenario in metafunc.cls.scenarios:
idlist.append(scenario[0])
items = scenario[1].items()
argnames = [x[0] for x in items]
argvalues.append([x[1] for x in items])
metafunc.parametrize(argnames, argvalues, ids=idlist, scope="class")
scenario1 = ("basic", {"attribute": "value"})
scenario2 = ("advanced", {"attribute": "value2"})
class TestSampleWithScenarios:
scenarios = [scenario1, scenario2]
def test_demo1(self, attribute):
assert isinstance(attribute, str)
def test_demo2(self, attribute):
assert isinstance(attribute, str)
这是一个完全自包含的示例，您可以使用以下命令运行
$ pytest test_scenarios.py
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-8.x.y, pluggy-1.x.y
rootdir: /home/sweet/project
collected 4 items
test_scenarios.py .... [100%]
============================ 4 passed in 0.12s =============================
如果您只收集测试，您还将很好地看到“高级”和“基本”作为测试函数的变体
$ pytest --collect-only test_scenarios.py
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-8.x.y, pluggy-1.x.y
rootdir: /home/sweet/project
collected 4 items
<Dir parametrize.rst-198>
<Module test_scenarios.py>
<Class TestSampleWithScenarios>
<Function test_demo1[basic]>
<Function test_demo2[basic]>
<Function test_demo1[advanced]>
<Function test_demo2[advanced]>
======================== 4 tests collected in 0.12s ========================
请注意，我们告诉 metafunc.parametrize()，您的场景值应被视为类作用域。使用 pytest-2.3，这将导致基于资源的排序。
推迟参数化资源的设置¶
测试函数的参数化发生在收集时间。仅在实际测试运行时设置昂贵的资源（如数据库连接或子进程）是一个好主意。以下是一个实现此目的的简单示例。此测试需要 db 对象固定装置
# content of test_backends.py
import pytest
def test_db_initialized(db):
# a dummy test
if db.__class__.__name__ == "DB2":
pytest.fail("deliberately failing for demo purposes")
我们现在可以添加一个测试配置，该配置生成 test_db_initialized 函数的两个调用，并实现一个工厂，为实际测试调用创建数据库对象
# content of conftest.py
import pytest
def pytest_generate_tests(metafunc):
if "db" in metafunc.fixturenames:
metafunc.parametrize("db", ["d1", "d2"], indirect=True)
class DB1:
"one database object"
class DB2:
"alternative database object"
@pytest.fixture
def db(request):
if request.param == "d1":
return DB1()
elif request.param == "d2":
return DB2()
else:
raise ValueError("invalid internal test config")
让我们首先看看它在收集时间的样子
$ pytest test_backends.py --collect-only
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-8.x.y, pluggy-1.x.y
rootdir: /home/sweet/project
collected 2 items
<Dir parametrize.rst-198>
<Module test_backends.py>
<Function test_db_initialized[d1]>
<Function test_db_initialized[d2]>
======================== 2 tests collected in 0.12s ========================
然后，当我们运行测试时
$ pytest -q test_backends.py
.F [100%]
================================= FAILURES =================================
_________________________ test_db_initialized[d2] __________________________
db = <conftest.DB2 object at 0xdeadbeef0001>
def test_db_initialized(db):
# a dummy test
if db.__class__.__name__ == "DB2":
> pytest.fail("deliberately failing for demo purposes")
E Failed: deliberately failing for demo purposes
test_backends.py:8: Failed
========================= short test summary info ==========================
FAILED test_backends.py::test_db_initialized[d2] - Failed: deliberately f...
1 failed, 1 passed in 0.12s
第一个调用（db == "DB1"）通过，而第二个调用（db == "DB2"）失败。我们的 db 固定装置函数在设置阶段实例化了每个数据库值，而 pytest_generate_tests 在收集阶段生成了对 test_db_initialized 的两个相应调用。
间接参数化¶
在对测试进行参数化时使用 indirect=True 参数允许使用固定装置对测试进行参数化，该固定装置在将值传递给测试之前接收值
import pytest
@pytest.fixture
def fixt(request):
return request.param * 3
@pytest.mark.parametrize("fixt", ["a", "b"], indirect=True)
def test_indirect(fixt):
assert len(fixt) == 3
例如，这可用于在固定装置中在测试运行时执行更昂贵的设置，而不是在收集时运行这些设置步骤。
对特定参数应用间接¶
参数化通常使用多个参数名称。有机会对特定参数应用 indirect 参数。可以通过将参数名称列表或元组传递给 indirect 来完成此操作。在下面的示例中，有一个函数 test_indirect，它使用两个固定装置：x 和 y。在这里，我们给间接一个列表，其中包含固定装置 x 的名称。间接参数将仅应用于此参数，并且值 a 将传递给相应的固定装置函数
# content of test_indirect_list.py
import pytest
@pytest.fixture(scope="function")
def x(request):
return request.param * 3
@pytest.fixture(scope="function")
def y(request):
return request.param * 2
@pytest.mark.parametrize("x, y", [("a", "b")], indirect=["x"])
def test_indirect(x, y):
assert x == "aaa"
assert y == "b"
此测试的结果将成功
$ pytest -v test_indirect_list.py
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-8.x.y, pluggy-1.x.y -- $PYTHON_PREFIX/bin/python
cachedir: .pytest_cache
rootdir: /home/sweet/project
collecting ... collected 1 item
test_indirect_list.py::test_indirect[a-b] PASSED [100%]
============================ 1 passed in 0.12s =============================
通过每个类的配置对测试方法进行参数化¶
这是一个 pytest_generate_tests 函数示例，它实现了类似于 Michael Foord 的 unittest 参数化程序 的参数化方案，但代码少得多
# content of ./test_parametrize.py
import pytest
def pytest_generate_tests(metafunc):
# called once per each test function
funcarglist = metafunc.cls.params[metafunc.function.__name__]
argnames = sorted(funcarglist[0])
metafunc.parametrize(
argnames, [[funcargs[name] for name in argnames] for funcargs in funcarglist]
)
class TestClass:
# a map specifying multiple argument sets for a test method
params = {
"test_equals": [dict(a=1, b=2), dict(a=3, b=3)],
"test_zerodivision": [dict(a=1, b=0)],
}
def test_equals(self, a, b):
assert a == b
def test_zerodivision(self, a, b):
with pytest.raises(ZeroDivisionError):
a / b
我们的测试生成器查找类级别的定义，该定义指定要为每个测试函数使用哪些参数集。让我们运行它
$ pytest -q
F.. [100%]
================================= FAILURES =================================
________________________ TestClass.test_equals[1-2] ________________________
self = <test_parametrize.TestClass object at 0xdeadbeef0002>, a = 1, b = 2
def test_equals(self, a, b):
> assert a == b
E assert 1 == 2
test_parametrize.py:21: AssertionError
========================= short test summary info ==========================
FAILED test_parametrize.py::TestClass::test_equals[1-2] - assert 1 == 2
1 failed, 2 passed in 0.12s
使用多个固定装置进行参数化¶
这是一个精简的真实示例，说明如何使用参数化测试来测试不同 Python 解释器之间对象的序列化。我们定义了一个 test_basic_objects 函数，该函数将针对其三个参数的不同参数集运行
python1：第一个 Python 解释器，运行以将对象 pickle 存储到文件中python2：第二个解释器，运行以从文件中 pickle 加载对象obj：要存储/加载的对象
"""Module containing a parametrized tests testing cross-python serialization
via the pickle module."""
import shutil
import subprocess
import textwrap
import pytest
pythonlist = ["python3.9", "python3.10", "python3.11"]
@pytest.fixture(params=pythonlist)
def python1(request, tmp_path):
picklefile = tmp_path / "data.pickle"
return Python(request.param, picklefile)
@pytest.fixture(params=pythonlist)
def python2(request, python1):
return Python(request.param, python1.picklefile)
class Python:
def __init__(self, version, picklefile):
self.pythonpath = shutil.which(version)
if not self.pythonpath:
pytest.skip(f"{version!r} not found")
self.picklefile = picklefile
def dumps(self, obj):
dumpfile = self.picklefile.with_name("dump.py")
dumpfile.write_text(
textwrap.dedent(
rf"""
import pickle
f = open({str(self.picklefile)!r}, 'wb')
s = pickle.dump({obj!r}, f, protocol=2)
f.close()
"""
)
)
subprocess.run((self.pythonpath, str(dumpfile)), check=True)
def load_and_is_true(self, expression):
loadfile = self.picklefile.with_name("load.py")
loadfile.write_text(
textwrap.dedent(
rf"""
import pickle
f = open({str(self.picklefile)!r}, 'rb')
obj = pickle.load(f)
f.close()
res = eval({expression!r})
if not res:
raise SystemExit(1)
"""
)
)
print(loadfile)
subprocess.run((self.pythonpath, str(loadfile)), check=True)
@pytest.mark.parametrize("obj", [42, {}, {1: 3}])
def test_basic_objects(python1, python2, obj):
python1.dumps(obj)
python2.load_and_is_true(f"obj == {obj}")
运行它会跳过一些内容，如果我们没有安装所有 Python 解释器，否则会运行所有组合（3 个解释器乘以 3 个解释器乘以 3 个要序列化/反序列化的对象）
. $ pytest -rs -q multipython.py
ssssssssssss...ssssssssssss [100%]
========================= short test summary info ==========================
SKIPPED [12] multipython.py:65: 'python3.9' not found
SKIPPED [12] multipython.py:65: 'python3.11' not found
3 passed, 24 skipped in 0.12s
可选实现/导入的参数化¶
如果你想比较给定 API 的几个实现的结果，你可以编写接收已导入实现的测试函数，并在无法导入/使用该实现的情况下跳过该函数。假设我们有一个“基本”实现，而其他（可能是经过优化的）实现需要提供类似的结果
# content of conftest.py
import pytest
@pytest.fixture(scope="session")
def basemod(request):
return pytest.importorskip("base")
@pytest.fixture(scope="session", params=["opt1", "opt2"])
def optmod(request):
return pytest.importorskip(request.param)
然后是简单函数的基本实现
# content of base.py
def func1():
return 1
以及优化版本
# content of opt1.py
def func1():
return 1.0001
最后是一个小测试模块
# content of test_module.py
def test_func1(basemod, optmod):
assert round(basemod.func1(), 3) == round(optmod.func1(), 3)
如果你在启用跳过报告的情况下运行此操作
$ pytest -rs test_module.py
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-8.x.y, pluggy-1.x.y
rootdir: /home/sweet/project
collected 2 items
test_module.py .s [100%]
========================= short test summary info ==========================
SKIPPED [1] test_module.py:3: could not import 'opt2': No module named 'opt2'
======================= 1 passed, 1 skipped in 0.12s =======================
你会看到我们没有 opt2 模块，因此跳过了 test_func1 的第二次测试运行。一些说明
conftest.py文件中的固定装置函数是“会话作用域”，因为我们不需要导入多次如果你有多个测试函数和一个跳过的导入，你将在报告中看到
[1]计数增加你可以对测试函数使用 @pytest.mark.parametrize 样式的参数化，以参数化输入/输出值。
为各个参数化测试设置标记或测试 ID¶
使用 pytest.param 将标记应用于各个参数化测试或为其设置测试 ID。例如
# content of test_pytest_param_example.py
import pytest
@pytest.mark.parametrize(
"test_input,expected",
[
("3+5", 8),
pytest.param("1+7", 8, marks=pytest.mark.basic),
pytest.param("2+4", 6, marks=pytest.mark.basic, id="basic_2+4"),
pytest.param(
"6*9", 42, marks=[pytest.mark.basic, pytest.mark.xfail], id="basic_6*9"
),
],
)
def test_eval(test_input, expected):
assert eval(test_input) == expected
在此示例中，我们有 4 个参数化测试。除了第一个测试，我们用自定义标记 basic 标记了其余三个参数化测试，对于第四个测试，我们还使用了内置标记 xfail 来指示此测试预期失败。为了明确起见，我们为一些测试设置了测试 ID。
然后使用详细模式和仅使用 basic 标记运行 pytest
$ pytest -v -m basic
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-8.x.y, pluggy-1.x.y -- $PYTHON_PREFIX/bin/python
cachedir: .pytest_cache
rootdir: /home/sweet/project
collecting ... collected 24 items / 21 deselected / 3 selected
test_pytest_param_example.py::test_eval[1+7-8] PASSED [ 33%]
test_pytest_param_example.py::test_eval[basic_2+4] PASSED [ 66%]
test_pytest_param_example.py::test_eval[basic_6*9] XFAIL [100%]
=============== 2 passed, 21 deselected, 1 xfailed in 0.12s ================
结果
收集了四个测试
取消选择了一个测试，因为它没有
basic标记。选择了带有
basic标记的三个测试。测试
test_eval[1+7-8]通过，但名称是自动生成的，令人困惑。测试
test_eval[basic_2+4]通过。测试
test_eval[basic_6*9]预期失败，并且确实失败了。
参数化条件引发¶
使用 pytest.raises() 和 pytest.mark.parametrize 装饰器编写参数化测试，其中一些测试引发异常，而另一些测试不引发异常。
contextlib.nullcontext 可用于测试预期不会引发异常但应产生某个值的情况。该值作为 enter_result 参数给出，该参数可用作 with 语句的目标（如下例中的 e）。
例如
from contextlib import nullcontext
import pytest
@pytest.mark.parametrize(
"example_input,expectation",
[
(3, nullcontext(2)),
(2, nullcontext(3)),
(1, nullcontext(6)),
(0, pytest.raises(ZeroDivisionError)),
],
)
def test_division(example_input, expectation):
"""Test how much I know division."""
with expectation as e:
assert (6 / example_input) == e
在上面的示例中，前三个测试用例应在没有任何异常的情况下运行，而第四个应引发 pytest 预期的 ``ZeroDivisionError`` 异常。
