测试参数化¶
pytest 允许轻松地参数化测试函数。有关基本文档，请参阅如何参数化 fixture 和测试函数。
接下来，我们将提供一些使用内置机制的示例。
根据命令行生成参数组合¶
假设我们想用不同的计算参数执行一个测试，并且参数范围将由命令行参数确定。让我们首先编写一个简单的（什么都不做）计算测试
# 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。这些 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-207>
<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 配置的测试快速移植的示例，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 =============================
如果你只收集测试，你也会清楚地看到 'advanced' 和 'basic' 作为测试函数的变体
$ 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-207>
<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 对象 fixture
# 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-207>
<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 fixture 函数在设置阶段实例化了每个 DB 值，而 pytest_generate_tests 在收集阶段生成了对 test_db_initialized 的两次相应调用。
间接参数化¶
在参数化测试时使用 indirect=True 参数，允许使用一个 fixture 来参数化测试，该 fixture 在将值传递给测试之前接收这些值
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
例如，这可用于在 fixture 中在测试运行时执行更昂贵的设置，而不是在收集时运行这些设置步骤。
对特定参数应用间接¶
通常，参数化会使用多个参数名称。有机会对特定参数应用 indirect 参数。这可以通过将参数名称的列表或元组传递给 indirect 来完成。在下面的示例中，有一个函数 test_indirect 使用了两个 fixture：x 和 y。这里我们将包含 fixture x 名称的列表传递给 indirect。`indirect` 参数将仅应用于此参数，并且值 a 将传递给相应的 fixture 函数
# 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 parametrizer，但代码量少得多
# 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
多 fixture 参数化¶
这是一个简化版的真实示例，演示了如何使用参数化测试来测试不同 Python 解释器之间对象的序列化。我们定义了一个 test_basic_objects 函数，它将使用不同的参数集来运行其三个参数
python1：第一个 Python 解释器，运行以将对象 pickle-dump 到文件python2：第二个解释器，运行以从文件 pickle-load 一个对象obj：要 dump/load 的对象
"""Module containing a parametrized tests testing cross-python serialization
via the pickle module."""
from __future__ import annotations
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
sssssssssssssssssssssssssss [100%]
========================= short test summary info ==========================
SKIPPED [9] multipython.py:67: 'python3.9' not found
SKIPPED [9] multipython.py:67: 'python3.10' not found
SKIPPED [9] multipython.py:67: 'python3.11' not found
27 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文件中的 fixture 函数是“会话范围的”，因为我们不需要多次导入如果你有多个测试函数和一个被跳过的导入，你会在报告中看到
[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
在上面的示例中，前三个测试用例应该在没有任何异常的情况下运行，而第四个应该抛出 ZeroDivisionError 异常，这是 pytest 预期的情况。