Pytest 如何在每次 py.test 断言失败时调用方法

在本文中，我们将介绍如何在每次 py.test 断言失败时调用方法。py.test 是一个功能强大的 Python 测试框架，它提供了许多功能帮助我们进行单元测试和集成测试。在测试过程中，我们经常需要在断言失败时执行一些额外的操作，比如打印日志、发送通知等。Pytest 提供了一种简洁的方式来实现这个目标。

阅读更多：Pytest 教程

Pytest 提供的钩子函数

在 py.test 中，我们可以使用钩子函数来在不同的测试阶段执行自定义的代码。钩子函数允许我们在测试之前、期间或之后执行额外的操作。pytest_assertion_pass 和 pytest_assertion_fail 钩子函数可以在断言成功或失败时调用，我们可以利用它们来执行我们想要的操作。

下面是一个示例，演示了如何使用 pytest_assertion_fail 钩子函数来在断言失败时调用方法：

# content of pytest_example.py

import pytest

def test_example():
    x = 1
    y = 2
    z = 3
    assert x + y == z

@pytest.hookimpl(tryfirst=True)
def pytest_assertion_fail(traceback, statement, *args):
    # 调用你想要执行的方法
    print("调用自定义方法：记录失败断言的日志")

当我们运行上述测试时，断言会失败并触发 pytest_assertion_fail 钩子函数。这时，我们定义的自定义方法 pytest_assertion_fail 将被调用，并执行 print() 语句打印日志信息。

Pytest 插件：pytest-testmon

如果我们想要在每次断言失败时自动调用方法而不需要每个测试文件中都添加钩子函数，我们可以考虑使用 pytest-testmon 插件。pytest-testmon 是一个用于监视变动并执行相应测试的 pytest 插件。它可以在断言失败时调用自定义方法或执行特定的测试。

下面是一个使用 pytest-testmon 插件的示例：

# content of test_mon_example.py

import pytest

def test_example_1():
    x = 1
    y = 2
    z = 3
    assert x + y == z

@pytest.mark.testmon
def test_example_2():
    x = 4
    y = 5
    z = 9
    assert x + y == z

def log_failure():
    print("调用自定义方法：记录失败断言的日志")

pytest.register_assert_rewrite('test_mon_example')

在上面的示例中，我们增加了一个名为 test_mon_example 的 pytest 插件。在测试文件中，我们为需要监视的测试函数添加了 @pytest.mark.testmon 装饰器。这样，每次运行测试时，当断言失败时，自定义方法 log_failure 就会被调用。

要使用 pytest-testmon 插件，我们需要在命令行中运行以下命令：

pytest --testmon

这样，pytest-testmon 插件就会在每次断言失败时自动调用我们定义的方法。

总结

在本文中，我们介绍了如何在每次 py.test 断言失败时调用方法。我们可以使用 pytest 的钩子函数 pytest_assertion_fail 来实现，也可以选择使用 pytest-testmon 插件来实现自动调用方法的功能。无论使用哪种方式，都可以方便地执行一些额外的操作，提高测试的可靠性和可追溯性。

希望本文对你了解 pytest 如何在断言失败时调用方法有所帮助！