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

Python pytest怎么在测试总结中增加自定义字段_修改terminalsummary

小辰小哥_9093

小辰小哥_9093

发布时间:2026-05-05 08:08:59

|

237人浏览过

|

来源于php中文网

原创

pytest需通过conftest.py中自定义pytest_terminal_summary hook修改terminalsummary输出,利用terminalreporter.write_line()或section()追加内容,避免print()、异常及编码问题,并手动注入和统计字段。

python pytest怎么在测试总结中增加自定义字段_修改terminalsummary

pytest如何通过hook函数修改terminalsummary输出

pytest本身不提供直接配置项来增减测试总结行,必须通过自定义pytest_terminal_summary hook实现。这个hook在测试运行结束后被调用,接收terminalreporter对象,你可以用它往终端输出里追加任意文本。

  • hook必须放在conftest.py中(项目根目录或测试目录下),不能写在测试文件里
  • terminalreporter有write_line()和section()两个常用方法:前者纯文本换行,后者带分隔线更醒目
  • 不要在hook里调用print()——会破坏pytest的输出时序和颜色控制
  • 如果想显示统计值(如跳过数、耗时),需从terminalreporter.stats或config中提取,不能硬编码

获取并显示自定义统计字段(比如环境/版本/用例覆盖率)

terminalsummary本身不包含业务上下文,所有“自定义字段”都得你自己计算或注入。常见做法是:提前把数据存进config或session对象,在hook里读取。

  • 推荐在pytest_configure(config)中存入基础信息:config._metadata['ENV'] = 'staging'
  • 若需动态统计(如“标记为@smoke的用例执行数”),可在pytest_runtest_makereport中累计到session属性上
  • terminalreporter.stats只含pytest原生状态('passed'/'failed'/'skipped'等),不包含自定义标记统计,必须自己维护
  • 注意:metadata默认会被pytest-html插件读取,但terminalsummary里不会自动展示,仍需手动输出

避免覆盖默认summary或引发UnicodeEncodeError

直接调用terminalreporter.write_line()一般没问题,但在CI环境(如GitLab CI的alpine镜像)或Windows cmd下容易因编码问题崩溃,错误信息通常是UnicodeEncodeError: 'charmap' codec can't encode character。

python-parallelization
python-parallelization

将顺序 Python 代码转换为并行/并发实现,用于在需要并行化 Python 代码、提升性能时使用。

下载
  • 始终用str()包裹待输出内容,避免传入None或未解码bytes
  • 对可能含中文/emoji的字段,先做安全encode:s.encode('utf-8', errors='ignore').decode('utf-8')
  • 不要在write_line()里拼接长字符串+换行符,write_line()已自带换行;重复调用即可分多行
  • 避免在hook里raise异常——会导致pytest退出码变成2,掩盖真实测试失败

一个可直接复用的conftest.py片段

下面这段代码添加了环境名、Python版本、以及统计跳过用例中带reason="not implemented"的数量:

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

def pytest_configure(config):
    config._metadata['Python'] = config._metadata.get('Python', f"{sys.version_info.major}.{sys.version_info.minor}")

def pytest_terminal_summary(terminalreporter, exitstatus, config):
    tr = terminalreporter
    tr.section("CUSTOM SUMMARY", sep="-", blue=True)
    tr.write_line(f"Environment: {config._metadata.get('ENV', 'unknown')}")
    tr.write_line(f"Python: {config._metadata['Python']}")
    
    skipped = terminalreporter.stats.get('skipped', [])
    not_impl_count = sum(1 for rep in skipped if hasattr(rep, 'longrepr') and 'not implemented' in str(rep.longrepr))
    tr.write_line(f"NOT_IMPLEMENTED skipped: {not_impl_count}")

真正难的不是写这几行,而是决定哪些字段值得放进summary——太多会淹没关键失败信息,太少又失去定制意义。每次加新字段前,先问一句:这个值是否会影响我立刻判断CI是否要人工介入?

热门AI工具

更多
WorkBuddy

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

DeepSeek

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

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

豆包大模型

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

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

Laper
Laper Hot

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

Seko
Seko Hot

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

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

相关专题

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

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

1751

2023.07.20

python能做什么
python能做什么

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

4544

2023.07.25

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

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

1729

2023.07.31

python教程
python教程

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

26777

2023.08.03

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

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

3247

2023.08.04

python eval
python eval

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

3247

2023.08.04

scratch和python区别
scratch和python区别

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

1183

2023.08.11

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

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

596

2023.08.10

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

40

2026.10.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
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