如何在Python测试中捕获自定义Warning警告

大芳姑娘_2097

大芳姑娘_2097

2026-09-30

839人浏览

原创

应使用 warnings.catch_warnings(record=true) 或 pytest.warns 捕获自定义 warning;需确保警告类继承 warning、设 record=true 或 simplefilter("always"),且 pytest 配置未忽略警告。

如何在python测试中捕获自定义warning警告

用 warnings.catch_warnings 临时捕获自定义 Warning

Python 的 warnings 模块默认不抛出异常,即使你触发了自定义警告类,测试里也看不到它——除非显式捕获。最直接的方式是用 warnings.catch_warnings(record=True) 上下文管理器,它能拦截所有警告并存为列表。

注意:必须设 record=True,否则 warnings 对象为空;还要确保你的自定义警告类继承自 Warning(不能是 Exception 或普通 object)。

  • 示例中触发 MyCustomWarning 后,w 是 warnings.WarningMessage 实例,其 .category 是警告类,.message 是实际内容
  • 若想匹配部分消息文本,可用 str(w.message) 做 in 判断,避免硬编码全等
  • 不加 record=True 时,warnings 被丢弃,列表为空,容易误判“没警告”
import warnings
<p>class MyCustomWarning(Warning):
pass</p><p>def risky_func():
warnings.warn("something's off", MyCustomWarning)</p><p>def test_risky_func_warns():
with warnings.catch_warnings(record=True) as w:
warnings.simplefilter("always")  # 必须设为 always,否则可能被忽略
risky_func()
assert len(w) == 1
assert issubclass(w[0].category, MyCustomWarning)
assert "something's off" in str(w[0].message)
</p>

用 pytest.warns 断言更简洁

如果你用 pytest,pytest.warns 是专为测试警告设计的上下文管理器,语法更紧凑,失败时提示也更清晰。它内部也是调用 warnings.catch_warnings,但封装了常见逻辑。

关键点在于:它只捕获指定类型的警告(或其子类),且自动验证是否真的发生了——如果没触发,测试直接失败。

Python Use Agent
Python Use Agent

智能执行Python任务,自动生成、执行代码并反馈结果,无需额外配置,兼容旧命令。

下载
  • 支持传入具体警告类,如 pytest.warns(MyCustomWarning)
  • 也可传字符串匹配消息,如 pytest.warns(MyCustomWarning, match="off")
  • 若警告被全局过滤(例如 filterwarnings = ignore 在 pyproject.toml 中),pytest.warns 会失效,需检查 pytest 配置
  • 不支持同时断言多个不同警告类型,一次只能盯一种
import pytest
<p>def test_with_pytest_warns():
with pytest.warns(MyCustomWarning, match="off"):
risky_func()
</p>

为什么 assertRaises 对 Warning 无效

unittest.TestCase.assertRaises 只捕获 Exception 及其子类,而 Warning 继承自 BaseException 但不是 Exception,所以它根本不会被 assertRaises 捕到——代码会静默通过,造成假阳性。

  • 错误写法:self.assertRaises(MyCustomWarning, risky_func) → 永远不报错,但也没捕获到警告
  • 本质原因:Python 把 Warning 设计为“非中断式提示”,和 Exception 的语义完全不同
  • 如果真想让警告变成异常(仅调试用),可临时设 warnings.simplefilter("error"),但这会改变行为,不适合常规测试逻辑

自定义 Warning 类定义的常见疏漏

自定义警告类本身看似简单,但两个细节常被忽略,导致测试始终不匹配:

  • 必须显式继承 Warning(或其子类如 UserWarning),写成 class MyWarning: 或 class MyWarning(Exception): 都不行
  • 模块路径影响匹配:如果测试里 import 的是 mylib.MyCustomWarning,但触发警告时用的是 from mylib import MyCustomWarning 再 warn(..., MyCustomWarning),通常没问题;但如果跨文件重定义同名类(比如在测试文件里又写了一遍),issubclass 会返回 False
  • 警告类别在 w.category 中是类对象,不是字符串,别用 w.category == "MyCustomWarning" 这种比较

测试里捕获 Warning 看似简单,但真正卡住人的往往是 warning 类型没对上、record=True 忘加、或者 pytest 配置把警告吞掉了。动手前先确认三件事:类继承链对不对、上下文里 filter 设没设对、测试运行时有没有外部 warning filter 干扰。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1611

4

python能做什么
python能做什么

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

2023.07.25

3924

7

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

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

2023.07.31

1609

3

python教程
python教程

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

2023.08.03

22537

23

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

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

2023.08.04

2767

5

python eval
python eval

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

2023.08.04

2807

5

scratch和python区别
scratch和python区别

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

2023.08.11

1123

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2183

5

热门下载

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

精品课程

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