讲师中心 微信公众号
AI工具推荐 视频效率加速

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

胖敏君_1530

胖敏君_1530

发布时间:2026-11-01 09:29:21

|

572人浏览过

|

来源于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会在对应时机自动调用。关键不是“注册”,而是“命名+可见性”。

立即学习“Python免费学习笔记(深入)”;

macOS UI 自动化技能包 —— 用 Python 控制你的 Mac
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"
)
  • 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相关符号,只在钩子函数作用域内按需导入或使用。

热门AI工具

更多
Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

相关专题

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

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

1851

2023.07.20

python能做什么
python能做什么

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

4964

2023.07.25

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

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

1789

2023.07.31

python教程
python教程

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

29837

2023.08.03

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

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

3547

2023.08.04

python eval
python eval

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

3567

2023.08.04

scratch和python区别
scratch和python区别

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

1223

2023.08.11

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

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

616

2023.08.10

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

100

2026.10.28

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn