pytest-metadata默认不自动记录环境信息,因其设计定位是元数据扩展点而非环境探测工具;必须在conftest.py中通过pytest_configure hook手动注入platform.python_version()、platform.platform()等动态值,并用--metadata-json参数输出到报告文件。

直接用 pytest-metadata 默认行为,根本不会自动记录 Python 版本、操作系统或 Git 信息——它只存你手动传进去的键值对。想让报告里带真实环境数据,必须自己补全采集逻辑。
为什么 pytest-metadata 不自动记录环境信息
pytest-metadata 的设计定位是“元数据扩展点”,不是环境探测工具。它只负责把你在命令行、配置文件或 hook 中塞进去的数据写进 JSON 报告,不内置任何系统探查逻辑。常见误操作是装完包就跑 pytest --metadata-json report.json,结果发现里面只有空对象或默认的 {"Python": "3.x"}(这个还是插件硬编码的占位符,不是当前真实版本)。
-
pytest启动时不会主动调用platform.python_version()或os.uname() -
pytest-metadata的--metadata命令行参数只能静态传字符串,没法执行表达式 -
pytest.ini或pyproject.toml里的metadata配置项也仅支持字面量
在 conftest.py 中用 pytest_configure 注入动态环境数据
最可靠的方式是在项目根目录的 conftest.py 里,通过 pytest_configure hook 手动往 config._metadata 字典里塞值。这个 hook 在 pytest 初始化完成后、测试执行前触发,此时所有系统信息都可安全读取。
快速生成专业的 Python 脚本和应用代码。一键创建完整项目结构,支持CLI、API、爬虫、Bot、Django等多种项目类型,包含完整的项目结构、配置文件、依赖管理、测试、README和文档。
示例:
import platform
import os
import subprocess
<p>def pytest_configure(config):
metadata = config._metadata</p><h1>替换默认的 Python 版本为真实值</h1><pre class="brush:php;toolbar:false;"><pre class="brush:php;toolbar:false;">metadata["Python"] = platform.python_version()
metadata["Platform"] = platform.platform()
metadata["Architecture"] = platform.architecture()[0]
# 尝试读取 Git 提交哈希(非强制,失败就跳过)
try:
git_hash = subprocess.check_output(["git", "rev-parse", "--short", "HEAD"]).decode().strip()
metadata["GitCommit"] = git_hash
except (subprocess.CalledProcessError, FileNotFoundError):
metadata["GitCommit"] = "unknown"
# 添加自定义字段,比如 CI 环境标识
metadata["CI"] = os.getenv("CI", "false")
- 必须用
config._metadata(注意是下划线开头),不是 <code>config.metadata - Git 命令要包在
try/except里——本地开发没初始化 git 仓库时会报错 - 避免在 hook 里做耗时操作(如网络请求),否则拖慢 pytest 启动
用 pytest --metadata-json 生成含环境信息的报告
运行时加 --metadata-json 参数,输出文件会包含你在 pytest_configure 里写入的所有字段。不加这个参数,环境数据只存在内存里,不会落地。
- 命令:
pytest --metadata-json report.json - 生成的
report.json里会有"environment"字段,内容就是config._metadata的最终状态 - 如果同时用了
--metadata命令行参数(如--metadata "env=staging"),它会和conftest.py里写的合并,后者优先级更高 - 注意:JSON 文件名不能是
metadata.json——某些 CI 工具会把它当元数据源自动解析,导致循环引用
真正麻烦的不是加几行代码,而是不同环境下的数据一致性:CI 机器可能禁用 git 命令,容器里 platform.platform() 返回的是宿主信息而非容器信息,Windows 下 os.uname() 直接报错。这些边界情况得一个个补 try/except,而不是指望某个插件替你兜底。
Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!










