如何在Python中通过pytest-metadata插件在报告中添加版本信息?

阿静小哥_5311

阿静小哥_5311

2026-06-07

861人浏览

原创

pytest-metadata插件不支持直接在pytest.ini或命令行写version=1.2.3,需通过pytest_configure钩子向config._metadata["version"]注入;html报告需pytest-html v3.2.0+或显式--metadata才显示,且键名须统一小写。

如何在python中通过pytest-metadata插件在报告中添加版本信息?

pytest-metadata 插件不支持直接写入自定义版本字段

直接在 pytest.ini 或命令行里加 version=1.2.3 不会生效——pytest-metadata 默认只收集环境变量、Python 版本、平台等固定元数据,不开放任意键值写入。想加版本号,必须通过钩子函数手动注入。

用 pytest_configure 钩子往 metadata 字典里塞 version

在项目根目录的 conftest.py 中添加如下代码,这是最稳定、兼容性最好的方式:

def pytest_configure(config):
    config._metadata["version"] = "1.2.3"

注意几点:

  • config._metadata 是插件内部维护的字典,直接赋值即可,无需 import 或初始化
  • 版本号建议从 __version__ 变量或 pyproject.toml 读取,避免硬编码,例如:from mypackage import __version__
  • 如果用了 --metadata 命令行参数,它会覆盖钩子里的值,顺序上钩子先执行,命令行后合并

生成 HTML 报告时 version 不显示?检查插件版本和模板

pytest-html v3.2.0+ 才默认渲染 _metadata 全部字段;旧版本只显示预设字段(如 Platform、Python)。现象是:控制台输出里能看到 version,但 HTML 里没有。

解决办法:

Li Python Sec Check
Li Python Sec Check

Python 安全规范检查工具:基于 CloudBase 规范、腾讯安全指南,LLM 智能分析(默认禁用,优先本地执行)

下载
  • 升级到最新版:pip install -U pytest-html
  • 若仍不显示,可在 pytest.ini 中显式启用完整元数据:addopts = --html=report.html --self-contained-html --metadata version 1.2.3
  • 自定义 HTML 模板时,确保模板中包含 {{ metadata }} 或遍历 metadata.items() 的逻辑

CI 环境下动态获取版本要避开 git describe 失败场景

很多项目用 git describe --tags 获取版本,但在 CI 构建镜像里常因没带 git history 而报错 fatal: No names found,导致测试直接退出。

安全做法是加异常兜底:

import subprocess

def get_version():
    try:
        return subprocess.check_output(["git", "describe", "--tags"], text=True).strip()
    except (subprocess.CalledProcessError, FileNotFoundError):
        return "unknown"

def pytest_configure(config):
    config._metadata["version"] = get_version()

关键点:

  • 捕获 CalledProcessError(git 命令失败)和 FileNotFoundError(没装 git)
  • 不要用 os.popen 或 os.system,它们不抛异常,错误会被静默吞掉
  • 如果构建流程本身已通过环境变量传入版本(如 CIRCLE_TAG),优先读环境变量,更快更可靠

真正容易被忽略的是:metadata 字段名区分大小写,且 HTML 报告对键名无自动格式化——写成 "Version" 和 "version" 在报告里就是两个不同条目;统一小写最稳妥。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1651

4

python能做什么
python能做什么

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

2023.07.25

4124

7

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

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

2023.07.31

1649

3

python教程
python教程

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

2023.08.03

23797

23

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

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

2023.08.04

2907

5

python eval
python eval

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

2023.08.04

2947

5

scratch和python区别
scratch和python区别

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

2023.08.11

1143

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2283

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程