运行时服务(二)、warnings模块
参考 python的warnings模块 - 云+社区 - 腾讯云
目录
警告类别
警告过滤器
默认警告过滤器
可用函数
可用的上下文管理器
Python 通过调用 warnings 模块中定义的 warn() 函数来发出警告。警告消息通常用于提示用户一些错误或者过时的用法,当这些情况发生时我们不希望抛出异常或者直接退出程序。警告消息通常写入 sys.stderr,对警告的处理方式可以灵活的更改,例如忽略或者转变为为异常。警告的处理可以根据警告类别,警告消息的文本和发出警告消息的源位置而变化。对相同源位置的特定警告的重复通常被抑制。
警告控制分为两个阶段:首先,警告被触发时,确定是否应该发出消息;接下来,如果要发出消息,则使用用户可设置的钩子来格式化和打印消息。
警告过滤器可以用来控制是否发出警告消息,警告过滤器是一些匹配规则和动作的序列。可以通过调用 filterwarnings()
将规则添加到过滤器,并通过调用 resetwarnings()
将其重置为默认状态。
警告消息的输出是通过调用 showwarning() 函数来完成的,其可以被覆盖;该函数的默认实现通过调用 formatwarning() 格式化消息,这也可以由自定义实现使用。
警告类别
內建警告类型:
类 | 描述 |
---|---|
Warning | 所有警告类别类的基类,它是 Exception 的子类 |
UserWarning | 函数 warn() 的默认类别 |
DeprecationWarning | 用于已弃用功能的警告(默认被忽略) |
SyntaxWarning | 用于可疑语法的警告 |
RuntimeWarning | 用于有关可疑运行时功能的警告 |
FutureWarning | 对于未来特性更改的警告 |
PendingDeprecationWarning | 对于未来会被弃用的功能的警告(默认将被忽略) |
ImportWarning | 导入模块过程中触发的警告(默认被忽略) |
UnicodeWarning | 与 Unicode 相关的警告 |
BytesWarning | 与 bytes 和 bytearray 相关的警告 (Python3) |
ResourceWarning | 与资源使用相关的警告(Python3) |
可以通过继承內建警告类型来实现自定义的警告类型,警告类型必须始终是 Warning
类的子类。
警告过滤器
警告过滤器用于控制警告的行为,如忽略,显示或转换为错误(引发异常)
。警告过滤器维护着一个有序的过滤规则列表,匹配规则用于确定如何处理警告,任何特定警告都将依次与列表中的每个过滤规则匹配,直到找到匹配为止。过滤规则类型为一个元组 (action,message,category,module,lineno),其中:
- action 为以下值:
值 | 处理方式 |
---|---|
"error" | 将匹配警告转换为异常 |
"ignore" | 忽略匹配的警告 |
"always" | 始终输出匹配的警告 |
"default" | 对于同样的警告只输出第一次出现的警告 |
"module" | 在一个模块中只输出第一次出现的警告 |
"once" | 输出第一次出现的警告,而不考虑它们的位置 |
- message 是包含正则表达式的字符串,警告消息的开始必须匹配,不区分大小写
- category 是一个警告类型(必须是 Warning 的子类)
- module 是包含模块名称的正则表达式字符串,区分大小写
- lineno 是一个整数,警告发生的行号,为 0 则匹配所有行号
默认警告过滤器
默认情况下,Python 设置了几个警告过滤器,可以通过 -W 命令行选项和调用 filterwarnings() 函数来覆盖它们。
DeprecationWarning
和PendingDeprecationWarning
和ImportWarning
被默认忽略。- 除非 -b 选项给出一次或两次,否则忽略
BytesWarning
;在这种情况下,此警告或者被输出(-b)或者变成异常(-bb)。 - 除非 Python 是在调试模式下构建的,否则将忽略 ResourceWarning。
在 3.2 版中的调整: 除 PendingDeprecationWarning 之外,默认情况下将忽略 DeprecationWarning。
可用函数
warn
warnings.warn(message, category=None, stacklevel=1, source=None)
触发异常。category
参数默认为 UserWarning。message
参数为警告消息,可以是 Warning 实例,在这种情况下,将忽略 category 并使用 message.__class__
,消息文本则为 str(message)。
warn_explicit
warnings.warn_explicit(message, category, filename, lineno, module=None, registry=None, module_globals=None, source=None)
这是 warn() 函数的低级接口,明确传递消息,类别,文件名和行号,以及可选的模块名称和注册表(应该是模块的 __warningregistry__
字典)
showwarning
warnings.showwarning(message, category, filename, lineno, file=None, line=None)
写入警告到文件。默认调用 formatwarning(message, category, filename, lineno, line) 并将结果字符串写入 file
,默认为 sys.stderr。 line
是包含在警告消息中的一行源代码;如果未提供则尝试读取由 filename 和 lineno 指定的行。
formatwarning
warnings.formatwarning(message, category, filename, lineno, line=None)
格式化警告,返回一个字符串。可能包含嵌入的换行符,并以换行符结束。 line
是包含在警告消息中的一行源代码;如果不提供则尝试读取由 filename 和 lineno 指定的行。
filterwarnings
warnings.filterwarnings(action, message='', category=Warning, module='', lineno=0, append=False)
过滤警告,在 警告过滤器规则
列表中插入一个条目。默认情况下,条目插入在前面;如果 append 为真,则在末尾插入。它检查参数的类型,编译 message 和 module 的正则表达式,并将它们作为警告过滤器列表中的元组插入。如果多个地方都匹配特定的警告,那么更靠近列表前面的条目会覆盖列表中后面的条目,省略的参数默认为匹配一切的值。
simplefilter
warnings.simplefilter(action, category=Warning, lineno=0, append=False)
简单易用的过滤器,类似 filterwarnings()
函数,但是不需要正则表达式。
resetwarnings
warnings.resetwarnings()
重置警告过滤器。这会丢弃所有以前对 filterwarnings() 调用的影响,包括 -W 命令行选项和对 simplefilter() 的调用的影响。
可用的上下文管理器
class warnings.catch_warnings(*, record=False, module=None)
捕获警告,在退出上下文时恢复警告过滤器和 showwarning() 函数功能。如果 record 参数是 False (缺省值),则上下文管理器在入口处返回 None。如果 record 是 True,则返回一个列表,该列表元素为 showwarning() 函数所见的对象,列表中的每个元素都具有与 showwarning() 的参数具有相同名称的属性。
import warningswarnings.simplefilter("always")def fxn():warnings.warn("this is a warning", Warning)with warnings.catch_warnings():warnings.simplefilter("ignore")fxn()with warnings.catch_warnings(Warning):warnings.warn("this is a warning2", Warning)warnings.warn("this is a warning3", Warning)def fxn2():warnings.warn("deprecated", DeprecationWarning)with warnings.catch_warnings(record=True) as w:# Cause all warnings to always be triggered.warnings.simplefilter("always")# Trigger a warning.fxn2()# Verify some thingsassert len(w) == 1assert issubclass(w[-1].category, DeprecationWarning)assert "deprecated" in str(w[-1].message)
可以从命令行通过传递 -Wd 参数到解释器(即为 -W default
的速记)。这将为所有警告启用默认处理,包括默认情况下忽略的警告。要更改遇到的警告所采取的操作,只需更改传递给 -W 的参数即可,如 -W error
。可以用 python --help
来查看 -W 参数的详细使用。
在代码中实现 -Wd
的功能为:
warnings.simplefilter('default')
这样的代码应该在程序开始被执行,否则有些警告可能仍然会被触发。
运行时服务(二)、warnings模块相关推荐
- 通过Dapr实现一个简单的基于.net的微服务电商系统(十二)——istio+dapr构建多运行时服务网格...
多运行时是一个非常新的概念.在 2020 年,Bilgin Ibryam 提出了 Multi-Runtime(多运行时)的理念,对基于 Sidecar 模式的各种产品形态进行了实践总结和理论升华.那到 ...
- c++builder 运行网站的api_04 将您的API Builder Docker映像发布到AMPLIFY运行时服务(ARS)...
「注:转载请注明出处,谢谢!」 注意:请参考在线文档以获取最新信息. 将APIBuilder应用程序部署到AMPLIFY Runtime Services 在先前文章中,我们描述了如何轻松地使用API ...
- [翻译]Go与C#对比 第三篇:编译、运行时、类型系统、模块和其它的一切
Go vs C#, Part 3: Compiler, Runtime, Type System, Modules, and Everything Else | by Alex Yakunin | S ...
- Python笔记-解决pyinstaller打包后运行时动态加载模块报错(No module named)
出现的问题就是:No module named 原因是我代码里面使用了这个 importlib.import_module pyinstaller没有检测到. 百度上没有找到解决办法,在外wang找到 ...
- java 模块设计模式_Java9模块化学习笔记二之模块设计模式
模块设计的原则: 1.防止出现编译时循环依赖(主要是编译器不支持),但运行时是允许循环依赖的,比如GUI应用 2.明确模块的边界 几种模块设计: API模块,聚合模块(比如java.base) 可选依 ...
- Spark基础学习笔记02:Spark运行时架构
文章目录 零.本讲学习目标 一.Spark运行时架构 二.YARN集群架构 (一)YARN集群主要组件 1.ResourceManager - 资源管理器 2.NodeManager - 节点管理器 ...
- 1.Containerd容器运行时初识与尝试
0x00 前言简述 1.基础介绍 2.专业术语 3.架构简述 0x01 安装配置 1.Ubuntu安装Containerd.io流程 0x02 简单使用 1.镜像拉取与运行 2.创建和使用网络 3.与 ...
- WCF服务端运行时架构体系详解[下篇]
作为WCF中一个核心概念,终结点在不同的语境中实际上指代不同的对象.站在服务描述的角度,我们所说的终结点实际上是指ServiceEndpoint对象.如果站在WCF服务端运行时框架来说,终结点实际上指 ...
- directx最终用户运行时_运维定位服务故障时,前5分钟都在忙啥?
遇到服务器故障,问题出现的原因很少可以一下就想到.我们基本上都会从以下步骤入手,这些也是绝大多数运维工程师在定位故障时前几分钟的主要排查点: 一.尽可能搞清楚问题的前因后果 不要一下子就扎到服务器前面 ...
最新文章
- March Library 版本更新
- hadoop 入门实例【转】
- Python之collections模块详细实例
- python列表输出斐波那契数列_Python|运用列表求斐波那契数列
- uva 11997(优先队列)
- DMA(direct memory access)直接内存访问
- maven -maven.test.skip skipTests
- 不规矩的xml与JAVA对象互相转换的小技巧-使用Marshaller
- ArrayList、LinkedList原理
- ubuntu刷新DNS
- python manage.py makemigrations执行完无反应的解决办法
- java调用百度云api_百度云—使用机器人视觉SDK调用百度API方法教程
- 服务器临时文件定时清理,定时/开机自动清理Win10临时文件夹的技巧
- 海图水深点的标注方法
- layui数据表格实现快捷键切换编辑单元格
- 密评(商用密码应用安全性评估)
- 强连通分量(Tarjan算法)和缩点
- 正六边形C语言输出算法记录
- win10右键新建没有文本文档
- javaScript中的undefined