【pytest】如何自定义一个断言函数，并在pytest测试中使用它

案例1

在pytest中，你可以通过自定义断言方法来实现更友好的错误输出。这通常涉及到创建一个自定义的断言函数，该函数在断言失败时输出一个清晰、有意义的错误信息。下面是一个简单的例子，说明如何自定义一个断言函数，并在pytest测试中使用它。

首先，你需要创建一个自定义的断言函数。这个函数应该接受你想要测试的值，以及一个预期的值或条件。如果测试失败，函数应该抛出一个AssertionError，并附带一个清晰的错误消息。

def assert_equal_with_message(actual, expected, message):
    """
    自定义断言函数，用于比较两个值是否相等。
    如果不相等，则抛出一个带有自定义错误消息的AssertionError。
    """
    if actual != expected:
        raise AssertionError(message)

然后，在你的pytest测试用例中，你可以使用这个自定义的断言函数来替代标准的assert语句。这样，当断言失败时，你会看到一个更友好的错误消息。

import pytest

def test_example():
    actual_value = 5
    expected_value = 6
    
    # 使用自定义断言函数
    assert_equal_with_message(actual_value, expected_value, f"实际值 {actual_value} 不等于预期值 {expected_value}")

在这个例子中，如果actual_value不等于expected_value，assert_equal_with_message函数会抛出一个带有自定义错误消息的AssertionError。这个错误消息会清晰地指出实际值和预期值是什么，以及它们为什么不相等。

你还可以根据你的需求扩展这个自定义断言函数，比如添加更多的比较逻辑，或者从错误消息中动态生成一部分内容。

需要注意的是，虽然自定义断言函数可以提供更友好的错误输出，但它们也可能使你的测试代码变得更加复杂。因此，你应该仔细权衡这种方法的优缺点，并在必要时使用它。

案例二

下面是如何使用pytest断言重写实现自定义断言方法的步骤：

1. 定义自定义断言函数：
   首先，你需要定义一个函数，该函数执行特定的检查并在条件不满足时抛出AssertionError。

def assert_is_positive(value, message=None):
    """自定义断言函数，检查值是否大于0。"""
    if value <= 0:
        if message is None:
            message = f"值 {value} 不是正数。"
        raise AssertionError(message)

2. 在测试用例中使用自定义断言：
   在你的pytest测试用例中，你可以像使用普通assert语句一样使用你的自定义断言函数。

def test_positive_number():
    number = 5
    assert_is_positive(number)  # 正常情况，不会抛出异常
    
    number = -1
    with pytest.raises(AssertionError) as exc_info:
        assert_is_positive(number)  # 抛出异常，因为number不是正数
    assert "值 -1 不是正数。" in str(exc_info.value)  # 验证错误消息

3. 使用上下文管理器处理异常（可选）：
   如果你想测试自定义断言是否确实抛出了AssertionError，并且想验证错误消息的内容，你可以使用pytest.raises上下文管理器来捕获异常。

4. 集成到pytest插件中（可选）：
   如果你的自定义断言方法非常通用，并且你想在多个项目中使用它们，你可以考虑将它们集成到一个pytest插件中。这样，你就可以通过安装插件并在任何pytest测试中使用这些自定义断言了。

5. 使用pytest的钩子（可选）：
   如果你想要更深入地集成自定义断言到pytest的运行过程中，你可以使用pytest的钩子（hooks）系统。这允许你在pytest的特定阶段执行自定义逻辑，比如在收集测试用例之后或执行测试用例之前。

6. 注意事项：

   • 自定义断言函数应该尽可能简单和明确，以便其他开发者能够容易地理解它们的用途和行为。
   • 避免在自定义断言函数中进行复杂的逻辑或计算，这可能会使测试难以理解和维护。
   • 当抛出AssertionError时，确保提供的错误消息是有意义的，并包含足够的信息来帮助定位问题。

通过实现自定义断言方法，你可以增强你的测试套件的可读性和健壮性，使得在断言失败时更容易定位问题并理解失败的原因。

案例三

在pytest中编写自定义断言方法可以通过定义一个辅助函数来实现，该函数在内部执行特定的检查，并在条件不满足时抛出AssertionError。这样，你可以在你的测试用例中重用这些自定义断言方法，并在断言失败时获得更清晰的错误信息。

下面是一个简单的例子，演示如何在pytest中编写自定义断言方法：

# 自定义断言方法
def assert_is_divisible_by(number, divisor, message=None):
    """
    自定义断言方法，检查一个数是否可以被另一个数整除。
    如果不能整除，则抛出AssertionError。
    """
    if number % divisor != 0:
        if message is None:
            message = f"{number} 不能被 {divisor} 整除。"
        raise AssertionError(message)

# pytest测试用例
def test_division():
    # 使用自定义断言方法
    assert_is_divisible_by(10, 2)  # 应该通过，因为10可以被2整除
    
    # 预期会失败的断言
    with pytest.raises(AssertionError) as exc_info:
        assert_is_divisible_by(9, 2)  # 应该失败，因为9不能被2整除
    
    # 验证错误消息
    assert "9 不能被 2 整除。" in str(exc_info.value)

# 如果你想要让自定义断言方法看起来更像内置的assert语句，
# 你可以使用pytest的插件系统来注册它们作为断言重写的一部分。
# 但通常，上面的方法已经足够用于大多数场景。

在这个例子中，assert_is_divisible_by是一个自定义的断言方法，它接受一个数number、一个除数divisor和一个可选的错误消息message。如果number不能被divisor整除，则方法会抛出一个带有错误消息的AssertionError。

在test_division测试用例中，我们使用了这个自定义断言方法。第一个调用应该通过测试，因为10确实可以被2整除。第二个调用预期会失败，因为9不能被2整除，所以我们使用pytest.raises上下文管理器来捕获并验证抛出的AssertionError及其错误消息。

请注意，虽然上面的方法可以实现自定义断言，但它并不是真正的断言重写。在pytest中，断言重写是一种机制，它允许你重写内置的assert语句的行为。这通常通过编写pytest插件来实现，该插件会在pytest收集测试用例时修改断言语句。自定义断言方法（如上所示）提供了一种更简单、更直接的方式来添加自定义的断言逻辑，而无需编写完整的pytest插件。