怎么在Python中通过自定义pytest插件扩展功能-Python教程-PHP中文网

pytest通过setuptools的pytest11 entry_points注册插件，需在setup.py或pyproject.toml中声明；插件内定义命名规范、签名严格的钩子函数（如pytest_configure）即可自动挂钩生命周期；自定义命令行或ini配置必须经pytest_addoption声明；禁止在模块顶层import pytest或调用其运行时功能。

怎么在python中通过自定义pytest插件扩展功能

如何注册自定义pytest插件并让pytest识别到它

pytest不会自动加载任意Python模块，必须通过明确的入口点或显式配置才能启用插件。最可靠的方式是使用setuptools的entry_points机制，把插件声明为pytest11类别。

在项目根目录的setup.py或pyproject.toml中声明：

#[project.entry-points."pytest11"]
#myplugin = "myplugin:pytest_plugin"

其中myplugin是插件名（任意合法标识符），"myplugin:pytest_plugin"指向一个模块和其中的全局对象（通常是pytest_configure函数或空对象）。这个对象本身不需可调用，但模块必须能被导入。

不声明entry_points → 插件永远不会被pytest发现，哪怕模块已安装
模块路径拼错、名称大小写不符 → 报EntryPointNotFound或静默失败
开发阶段想快速测试，可用-p myplugin命令行参数强制加载，但前提是模块已在PYTHONPATH中

怎么在插件中挂钩pytest生命周期（如收集测试前/运行后）

pytest提供一组预定义的钩子函数（hook functions），插件只需在模块顶层定义同名函数，pytest会在对应时机自动调用。关键不是“注册”，而是“命名+可见性”。

常见钩子示例：

macOS UI 自动化技能包 —— 用 Python 控制你的 Mac

让 macOS 自动化像说话一样简单 —— 用代码控制你的 Mac，无需学习 AppleScript 系统要求 macOS 14+ (Sonoma) Python 3.9+ 需要开启：辅助功能 + 屏幕录制权限

下载

def pytest_configure(config):
    config.addinivalue_line("markers", "slow: marks tests as slow")
<p>def pytest_collection_modifyitems(items):
for item in items:
if "slow" in item.keywords:
item.add_marker(pytest.mark.skip(reason="skipped during CI"))</p><p>def pytest_runtest_makereport(item, call):
if call.when == "call" and call.excinfo is not None:</p><h1>记录失败时的额外上下文</h1><pre class="brush:python;toolbar:false;">    item._custom_failure_info = {"traceback": str(call.excinfo)}

钩子名必须完全匹配官方文档定义，比如pytest_collection_modifyitems不能写成pytest_modify_collection_items
参数签名必须严格一致，少一个参数会导致pytest跳过该钩子（无报错）
多个插件实现同一钩子时，执行顺序由插件加载顺序决定，无法保证；如需控制，应使用firstresult=True（仅对返回值有意义的钩子有效）

怎么安全地向pytest配置添加自定义命令行选项和ini配置项

所有用户可配置项必须通过pytest_addoption钩子声明，否则--xxx或[tool:pytest]里的字段会被忽略。

声明方式分两类：

# 命令行选项（运行时传入）
def pytest_addoption(parser):
    parser.addoption(
        "--env",
        action="store",
        default="dev",
        help="Environment to run tests against (dev/staging/prod)"
    )
<h1>ini配置项（写在pyproject.toml或pytest.ini中）</h1><p>def pytest_addoption(parser):
parser.addini(
"api_base_url",
type="string",
default="<a href="https://www.php.cn/link/fcbb3a1c04ec11f1506563c26ca63774">https://www.php.cn/link/fcbb3a1c04ec11f1506563c26ca63774</a>",
help="Base URL for API integration tests"
)</p>

addoption的action类型要与实际使用匹配：比如action="store_true"对应布尔开关，action="append"用于多值参数
ini项的type参数只影响config.getini()的返回值类型，不校验配置文件内容；错误类型会导致运行时报ValueError
选项名若含下划线（如--log_level），在代码中通过config.getoption("--log-level")访问（pytest自动转换）

为什么插件里import pytest会报错或行为异常

根本原因在于插件模块被pytest动态导入的时机早于pytest自身完成初始化。直接在模块顶层import pytest可能触发未就绪的内部状态，尤其当插件试图访问pytest.mark或调用pytest.skip()等运行时功能时。

钩子函数体内可以安全使用pytest —— 此时pytest已完成启动
需要提前引用pytest.mark.xxx时，改用字符串形式标记：item.add_marker("slow")，再在pytest_configure中注册该marker
绝对避免在插件模块顶层调用pytest.main()或pytest.skip() —— 这会导致递归或状态冲突

最稳妥的做法是：所有pytest相关符号，只在钩子函数作用域内按需导入或使用。