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

Python中如何利用pytest的hook函数pytest_runtest_makereport定制日志?

风瑶同学_6559

风瑶同学_6559

发布时间:2026-06-06 10:54:01

|

768人浏览过

|

来源于php中文网

原创

pytest_runtest_makereport 是 pytest 的 hook 函数,在每个测试项执行完毕后、生成报告前触发,用于获取测试结果、异常及堆栈等原始数据,支持向 report 添加自定义字段或记录日志。

python中如何利用pytest的hook函数pytest_runtest_makereport定制日志?

pytest_runtest_makereport 是什么,它在哪个阶段触发?

pytest_runtest_makereport 是 pytest 提供的 hook 函数,用于在每个测试项(test item)执行完后、生成测试报告前被调用。它不负责执行测试,也不控制测试流程,只提供一个“观察+干预”的机会——你可以拿到当前测试的执行结果(pass/fail/skip)、异常信息、堆栈、耗时等原始数据。

注意:它不是在测试函数内部运行的,而是在 pytest 的内部调度循环中调用,因此不能直接修改测试逻辑,但可以往 report 对象里塞自定义字段,或触发日志写入。

如何在 conftest.py 中正确注册并获取失败详情?

必须把 pytest_runtest_makereport 放在项目根目录或测试目录下的 conftest.py 文件中(不能放在 test_*.py 里),且函数签名要严格匹配:

def pytest_runtest_makereport(item, call):
    if call.when == "call" and call.excinfo is not None:
        # 这里是测试主体执行失败时(非 setup/teardown)
        print(f"[FAIL] {item.name}: {call.excinfo.exconly()}")

关键点:

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

  • call.when == "call" 才代表测试函数本身执行完毕;"setup" 和 "teardown" 阶段也可能失败,但通常不归为用例失败
  • call.excinfo 仅在出错时非空,类型是 ExceptionInfo,可用 .exconly() 获取单行错误摘要,.reprcrash.message 拿具体报错消息
  • 不要在 hook 里 raise 异常,否则会中断 pytest 报告生成流程

怎么把失败用例的完整 traceback 写进本地日志文件?

pytest 默认不把 traceback 输出到文件,pytest_runtest_makereport 是最轻量可控的切入点。推荐做法是用 Python 标准 logging 模块追加写入,避免多进程冲突:

import logging
logging.basicConfig(
    level=logging.INFO,
    format="%(asctime)s [%(levelname)s] %(message)s",
    handlers=[logging.FileHandler("test_failures.log", encoding="utf-8")]
)
<p>def pytest_runtest_makereport(item, call):
if call.when == "call" and call.excinfo is not None:
logger = logging.getLogger(<strong>name</strong>)
logger.error(
f"Test failed: {item.nodeid}\n"
f"Error: {call.excinfo.exconly()}\n"
f"Traceback:\n{call.excinfo.getrepr(showlocals=False)}"
)</p>

注意事项:

  • call.excinfo.getrepr() 返回的是 pytest 格式化的 traceback 对象,需调用 str(...) 或 .tostring() 才能转成字符串;上面示例用了 getrepr(showlocals=False) 避免日志过大
  • 别用 print() 替代 logging——它不会落盘,且和 pytest 的 -s 参数行为耦合
  • 如果用 pytest-xdist 并行运行,多个 worker 可能同时写同一文件,建议按 worker ID 分日志名,或改用线程安全的 handler

为什么加了 hook 却没看到日志?常见排查点

hook 不生效往往不是代码写错了,而是环境或加载路径问题:

  • conftest.py 必须在 pytest 启动时能 import 到——运行 pytest --traceconfig 看是否列出了你的 conftest
  • 函数名拼错,比如写成 pytest_runtest_make_report(少个 r)或大小写不对
  • 在 pytest_configure 里动态 patch 了 hook,但未正确注册;应优先用标准 conftest 方式
  • pytest 版本太老(excinfo 属性,建议用 pytest>=7.0

定制日志真正难的不是写 hook,而是区分哪些失败需要记录、要不要截断 traceback、是否要关联 fixture 状态——这些都得靠 item 和 call 两个参数组合判断,不能只看 excinfo 有无。

热门AI工具

更多
立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

WorkBuddy

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

DeepSeek

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

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

豆包大模型

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

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

Atoms
Atoms Hot

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

Laper
Laper Hot

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

相关专题

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

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

1591

2023.07.20

python能做什么
python能做什么

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

3804

2023.07.25

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

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

1589

2023.07.31

python教程
python教程

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

21937

2023.08.03

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

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

2687

2023.08.04

python eval
python eval

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

2747

2023.08.04

scratch和python区别
scratch和python区别

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

1103

2023.08.11

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

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

596

2023.08.10

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

80

2026.09.23

热门下载

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

精品课程

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

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