Python测试框架pytest核心库pluggy详解

简介

pytest是Python语言的一个单元测试框架，提供了丰富的测试选项和灵活易扩展的插件机制。pytest的核心库pluggy提供了一种插件化体系结构，能够让我们轻松地扩展和定制pytest的功能。

pluggy的结构

pluggy的体系结构由两个核心概念组成：hooks和hookspecs。hook是一个可以被其他插件调用的函数，而hookspec是hook的规范，规定了参数、返回值等细节。pluggy在运行时会自动收集所有注册的hook，并按照特定的顺序调用它们。

pluggy的用法

注册和调用hook

我们可以通过pluggy提供的hookimpl装饰器定义一个hook实现，然后使用hookimpl(tryfirst=True)注释来注册它。tryfirst=True表示该hook实现尝试优先被调用。例如：

import pytest

@pytest.fixture
def my_fixture():
    return "my_fixture"

@pytest.hookimpl(tryfirst=True)
def pytest_collection_modifyitems(items):
    for item in items:
        # 修改测试用例名称
        item.name = f"{item.name}: my_fixture"

def test_my_example(my_fixture):
    assert my_fixture == "my_fixture"

在这个例子中，我们定义了一个名为my_fixture的fixture。接着，我们使用hookimpl装饰器定义了一个pytest_collection_modifyitems的hook实现，并标记它为tryfirst=True。pytest_collection_modifyitems是pytest在收集测试用例之后调用的hook，我们可以通过它修改测试用例的名称等信息。

最后，我们编写一个使用my_fixture的测试用例，并使用assert断言验证它返回的值是否与我们期望的一致。

定义和使用hookspec

我们可以使用hookspec装饰器定义一个hook规范，规定了hook具体的参数、返回值等细节。例如：

import pytest
from _pytest import hookspec

@hookspec(firstresult=True)
def pytest_collection_modifyitems(items):
    """
    This hook is called after collection has been performed, but before running tests.
    :param items: list of item objects.
    """
    pass

在这个例子中，我们定义了一个pytest_collection_modifyitems的hook规范，并通过firstresult=True标记它只返回一个非None的值。其他插件可以通过实现这个规范来对收集到的测试用例进行修改。

使用hook收集插件

pluggy提供了pytest_plugins这个配置变量，用于收集插件。我们可以在conftest.py（pytest的配置文件）中定义这个变量，以便为pytest安装新的插件。例如：

# content of conftest.py
pytest_plugins = ["myplugin"]

# content of myplugin.py
import pytest

def pytest_addoption(parser):
    parser.addoption("--myopt")

@pytest.fixture
def myopt(request):
    return request.config.getoption("--myopt")

在这个例子中，我们定义了一个名为myplugin的插件，并在pytest_plugins中注册了它。这个插件提供了一个新的命令行参数--myopt，以及通过myopt这个fixture让其他插件能够访问到这个命令行参数。

总结

本文详细讲解了pytest的核心库pluggy的使用方法，包括注册和调用hook、定义和使用hookspec、收集插件等方面。pluggy提供了一种插件化的体系结构，能够让我们轻松地扩展和定制pytest的功能。在实际项目中，我们可以通过编写插件来扩展pytest的功能，提高测试效率。