Python高级技术之：`pytest`的参数化测试：`@pytest.mark.parametrize`的实践。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷，欢迎来到今天的Pytest参数化测试专场！我是你们的老朋友，今天就来跟大家聊聊@pytest.mark.parametrize这个神器，保证让你的测试代码高效又优雅。

一、什么是参数化测试？

想象一下，你要测试一个计算平方的函数。如果只用一个数字测试，万一这个数字是个特殊值，测试结果就不能保证函数的通用性。如果用多个数字测试，比如 0, 1, 2, 3, -1, -2，那结果是不是更有说服力？

这就是参数化测试的魅力：用不同的输入值，重复执行同一个测试函数，验证函数的正确性。这样可以有效覆盖各种边界条件和典型场景，提高测试的覆盖率和可靠性。

二、@pytest.mark.parametrize：你的参数化好帮手

@pytest.mark.parametrize 是 Pytest 提供的装饰器，专门用来实现参数化测试。它可以将多个参数组合传递给一个测试函数，让测试函数在不同的参数下运行多次。

三、@pytest.mark.parametrize 的基本用法

@pytest.mark.parametrize 的基本语法如下：

@pytest.mark.parametrize("参数名1, 参数名2, ...", [
    (参数值1_1, 参数值2_1, ...),
    (参数值1_2, 参数值2_2, ...),
    ...
])
def test_function(参数名1, 参数名2, ...):
    # 测试逻辑
    pass

参数名： 一个或多个参数名，用逗号分隔，用字符串形式表示。
参数值列表： 一个包含多个元组或列表的列表。每个元组或列表对应一组参数值，与参数名一一对应。
测试函数： 接受参数名中定义的参数，并在不同的参数值下执行测试逻辑。

举个栗子：

import pytest

def square(x):
    """计算平方"""
    return x * x

@pytest.mark.parametrize("input_x, expected", [
    (0, 0),
    (1, 1),
    (2, 4),
    (-1, 1),
    (-2, 4),
])
def test_square(input_x, expected):
    """测试平方函数"""
    assert square(input_x) == expected

在这个例子中：

"input_x, expected" 定义了两个参数：input_x 和 expected。
[(0, 0), (1, 1), (2, 4), (-1, 1), (-2, 4)] 定义了五组参数值。
test_square 函数接受这两个参数，并验证 square(input_x) 的结果是否等于 expected。

运行这个测试，Pytest 会自动执行五次 test_square 函数，每次使用不同的 input_x 和 expected 值。

四、参数化测试的进阶技巧

使用 ids 参数自定义测试用例名称

默认情况下，Pytest 会自动为每个参数化的测试用例生成一个名称。如果你想自定义这些名称，可以使用 ids 参数。

ids 参数接受一个字符串列表，列表中的每个字符串对应一个测试用例的名称。

import pytest

@pytest.mark.parametrize("input_x, expected", [
    (0, 0),
    (1, 1),
    (2, 4),
], ids=["zero", "one", "two"])
def test_square(input_x, expected):
    assert square(input_x) == expected

在这个例子中，我们为每个测试用例定义了名称："zero", "one", "two"。运行测试时，Pytest 会显示这些自定义的名称，方便你识别和调试。

使用 pytest.param 更灵活地控制测试行为

pytest.param 可以让你更灵活地控制每个参数化测试用例的行为，比如标记跳过或预期失败。

import pytest

@pytest.mark.parametrize(
    "input_x, expected",
    [
        pytest.param(0, 0, id="zero"),
        pytest.param(1, 1, id="one"),
        pytest.param(2, 4, id="two"),
        pytest.param(3, 9, marks=pytest.mark.skip(reason="not implemented yet"), id="three"),
        pytest.param(4, 16, marks=pytest.mark.xfail(reason="known bug"), id="four"),
    ],
)
def test_square(input_x, expected):
    assert square(input_x) == expected

在这个例子中：

我们使用 pytest.param 来定义每个参数化的测试用例。
id 参数用于自定义测试用例的名称。
marks 参数用于添加标记，比如 pytest.mark.skip 跳过测试，pytest.mark.xfail 预期失败。

参数化与 Fixture 结合

@pytest.mark.parametrize 可以与 Fixture 结合使用，为测试函数提供更复杂的参数。

import pytest

@pytest.fixture
def data():
    return [1, 2, 3]

@pytest.mark.parametrize("item", "data")
def test_data(item, data):
    assert item in data

在这个例子中：

data fixture 返回一个列表 [1, 2, 3]。
@pytest.mark.parametrize("item", "data") 将 data fixture 作为参数传递给 test_data 函数。
test_data 函数会执行三次，每次 item 的值分别为 1, 2, 3。

使用 indirect 参数

indirect=True 是一个强大的特性，它允许你把参数传递给 fixture，让 fixture 根据不同的参数返回不同的值。

import pytest

@pytest.fixture
def user(request):
    """模拟用户对象，根据参数返回不同的用户"""
    user_id = request.param
    if user_id == "admin":
        return {"id": "admin", "name": "Administrator"}
    elif user_id == "guest":
        return {"id": "guest", "name": "Guest User"}
    else:
        return {"id": "unknown", "name": "Unknown User"}

@pytest.mark.parametrize("user", ["admin", "guest"], indirect=True)
def test_user_name(user):
    """测试用户名称"""
    assert user["name"] in ("Administrator", "Guest User")

在这个例子中：

user fixture 接受一个参数 request，通过 request.param 获取参数值。
@pytest.mark.parametrize("user", ["admin", "guest"], indirect=True) 将 "admin" 和 "guest" 作为参数传递给 user fixture。
indirect=True 告诉 Pytest，user 是一个 fixture，而不是一个普通的值。
test_user_name 函数会执行两次，第一次 user 的值为 {"id": "admin", "name": "Administrator"}，第二次 user 的值为 {"id": "guest", "name": "Guest User"}。

五、参数化测试的最佳实践

清晰的参数命名： 使用具有描述性的参数名，方便理解测试逻辑。
合理的参数组合： 选择能够覆盖各种边界条件和典型场景的参数组合。
适当的测试用例名称： 使用 ids 参数或 pytest.param 自定义测试用例名称，方便识别和调试。
避免过度参数化： 不要为了参数化而参数化，只选择必要的参数进行测试。
与 Fixture 结合： 利用 Fixture 提供更复杂的参数，提高测试的灵活性和可维护性。

六、一些常见问题及注意事项

参数顺序： 参数名和参数值列表的顺序必须一致，否则会导致测试结果错误。
参数数量： 每个参数值元组或列表中的元素数量必须与参数名的数量一致。
数据类型： 参数的数据类型应该与测试函数的要求一致。
性能问题： 过多的参数化可能会导致测试执行时间过长，需要根据实际情况进行调整。
可读性： 尽量保持参数化测试代码的简洁和可读性，方便维护和理解。

七、@pytest.mark.parametrize的应用场景

验证函数对不同输入的处理： 比如上面计算平方的例子。
测试 API 接口的不同参数组合： 比如测试一个搜索 API，可以参数化搜索关键词、排序方式、分页大小等参数。
验证 UI 组件在不同状态下的显示： 比如测试一个按钮在启用、禁用、点击状态下的显示效果。
测试数据库操作的不同条件： 比如测试一个查询函数，可以参数化查询条件、排序方式、限制数量等参数。
测试不同浏览器或操作系统下的兼容性： 结合pytest-xdist插件可以并行运行参数化测试，大大提高效率。

八、代码示例：更复杂的参数化场景

下面是一个更复杂的例子，演示如何使用 @pytest.mark.parametrize 测试一个简单的计算器函数：

import pytest

def calculate(x, y, operation):
    """简单的计算器函数"""
    if operation == "add":
        return x + y
    elif operation == "subtract":
        return x - y
    elif operation == "multiply":
        return x * y
    elif operation == "divide":
        if y == 0:
            raise ValueError("Cannot divide by zero")
        return x / y
    else:
        raise ValueError("Invalid operation")

@pytest.mark.parametrize(
    "x, y, operation, expected",
    [
        (1, 2, "add", 3),
        (5, 3, "subtract", 2),
        (2, 4, "multiply", 8),
        (10, 2, "divide", 5),
        pytest.param(1, 0, "divide", None, marks=pytest.mark.xfail(raises=ValueError, reason="division by zero")),
    ],
    ids=["add", "subtract", "multiply", "divide", "divide_by_zero"],
)
def test_calculate(x, y, operation, expected):
    """测试计算器函数"""
    if operation == "divide" and y == 0:
        with pytest.raises(ValueError):
            calculate(x, y, operation)
    else:
        assert calculate(x, y, operation) == expected

在这个例子中：

我们测试了加、减、乘、除四种运算。
我们使用 pytest.mark.xfail 标记了除以零的测试用例，预期它会失败并抛出 ValueError 异常。
我们使用了 ids 参数自定义了测试用例的名称。

九、总结

@pytest.mark.parametrize 是 Pytest 中一个非常强大的工具，可以帮助你编写高效、可靠的参数化测试。掌握它，可以让你的测试代码更简洁、更易维护，并提高测试的覆盖率。希望今天的讲解对大家有所帮助！记住，实践是检验真理的唯一标准，赶紧动手试试吧！

感谢各位的观看，下次再见！

发表回复 取消回复

发表回复取消回复