在Python中如何编写自定义pytest插件扩展功能

风涛大大_9372

风涛大大_9372

2026-10-23

721人浏览

原创

注册基础 pytest 插件的关键是让 pytest 正确发现并加载该模块:最轻量方式是通过 pyproject.toml 声明入口点 [project.entry-points."pytest11"],插件名不能含下划线,模块需可导入且非 conftest.py;本地调试可用 pythonpath + --trace-config 验证识别。

在python中如何编写自定义pytest插件扩展功能

如何注册一个基础 pytest 插件模块

pytest 插件本质是 Python 模块,只要被正确发现并加载即可运行。关键不是“写插件”,而是“让 pytest 认出它是插件”。最轻量的方式是把模块放在项目根目录或 sys.path 中,并在 pyproject.toml 或 setup.py 里声明入口点。

推荐用 pyproject.toml 声明(无需打包):

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

其中 myplugin 是插件名(任意合法标识符),myplugin:pytest_plugin 表示模块 myplugin.py 中的全局变量或对象 pytest_plugin —— 它可以是 None,只要模块能被 import 就行;更常见的是直接导出 hook 实现函数。

  • 模块文件名不能是 conftest.py,否则会被 pytest 当作配置文件提前加载,hook 可能失效
  • 如果只在本地开发调试,可临时用 export PYTHONPATH=$(pwd) + pytest --trace-config 确认插件是否被识别
  • 插件名(entry-point key)不能含下划线,否则 pytest 会静默忽略

如何实现常用 hook:pytest_runtest_makereport

这个 hook 能拿到每个测试用例执行后的原始报告对象,是做失败重试、截图、日志增强的最常用入口。注意它不修改执行流程,只提供观察和补充能力。

典型用法是在插件模块中定义函数:

python学习
python学习

Python 编程学习助手 skill,面向零基础用户。 当用户表达以下意图时触发: - 学习 Python 基础概念(变量、数据类型、循环、函数、类等) - 请求 Python 练习题或测验 - 请求审查或调试 Python 代码 - 请求 Python 项目实战指导(爬虫、数据分析、Web 开发等入门项目) - 泛化表述如"教我 Python""我想学编程""Python 怎么写""帮我学 Python" 此 skill

下载
def pytest_runtest_makereport(item, call):
    if call.when == "call" and call.excinfo is not None:
        # 测试主体执行失败
        item._failed_reason = str(call.excinfo.value)

之后可在 pytest_runtest_logreport 或 fixture 中读取 item._failed_reason。

  • call.when 可能是 "setup"、"call"、"teardown",别在 "setup" 阶段误判失败
  • 不要在该 hook 里 raise 异常,会导致 pytest 内部状态错乱
  • 若需修改报告内容(如添加 extra info),应返回新 TestReport 实例,但需小心兼容 pytest 版本(v7+ 的 TestReport 构造参数有变)

如何安全地向 fixture 注入动态行为

直接 patch pytest.fixture 装饰器不可靠。正确方式是使用 pytest_fixture_setup hook,在 fixture 实例化时注入逻辑:

def pytest_fixture_setup(fixturedef, request):
    if fixturedef.argname == "browser":
        # 给 browser fixture 加个超时控制
        original = fixturedef.func
        def wrapped(*args, **kwargs):
            kwargs.setdefault("timeout", 30)
            return original(*args, **kwargs)
        fixturedef.func = wrapped

这种方式绕过装饰器链,直接干预 fixture 函数本身。

  • 修改 fixturedef.func 是高危操作,务必保留原函数引用,避免多插件冲突
  • 仅对明确命名的 fixture 操作,不要通配匹配,否则可能破坏 pytest 内置 fixture(如 tmp_path)
  • 若需在 fixture 执行前后加逻辑,优先考虑 pytest_fixture_post_finalizer 和 pytest_fixture_pre_finalizer,它们更安全

为什么 pytest_configure 不该做耗时初始化

pytest_configure 在 pytest 解析完所有参数、收集完测试项之前就调用,看似是“最早入口”,但此时 config 对象尚未完全就绪,且该 hook 会被每个 pytest 进程调用一次 —— 在 --workers 或 --dist 场景下,重复初始化会导致资源争抢或端口占用冲突。

  • 数据库连接、WebDriver 启动、日志文件打开等操作,应延迟到 pytest_sessionstart 或首个 fixture 中进行
  • 若必须预加载配置,只读取 config.option 或 config.getini,避免调用 config.pluginmanager.register 等副作用方法
  • 调试时可用 print(f"[{os.getpid()}] configure") 验证是否被多次触发

插件真正的复杂点不在 hook 写法,而在于生命周期判断:哪个时刻对象可用、哪个时刻已过期、哪个操作会跨进程污染。没理清这点,插件在 CI 或分布式环境下大概率表现异常。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1791

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4684

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1749

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

27777

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3347

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3347

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1203

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2603

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习