Python模块——import warnings的用法介绍|极客教程

Python模块——import warnings的用法介绍

一、导入warnings模块

在Python中，warnings是一个用于控制警告信息输出的模块。通过导入warnings模块，我们可以对程序中的警告进行处理和控制。下面是导入warnings模块的语法:

import warnings

二、警告的分类

在使用warnings模块之前，我们需要了解一下Python中警告的分类。Python中的警告可以分为两类：一个是语法警告，另一个是运行时警告。

2.1 语法警告

语法警告是指在代码中有不符合语法规范的部分，它们通常不会导致程序运行出错，但可能会影响程序的运行结果。Python默认会将语法警告输出到标准错误流中。下面是一个示例代码，用于演示语法警告的情况：

#coding:utf-8

def divide(x, y):
    result = x / y
    return result

#x为整型，y为字符串
x = 10
y = "2"

divide(x, y)

在上面的代码中，调用divide函数时，传入的参数y是一个字符串类型的变量，而不是预期的数字类型。这种情况下，Python会生成一个语法警告，并将其输出到标准错误流中。

2.2 运行时警告

运行时警告是指在代码运行时可能出现的潜在问题，可能会导致程序运行出错或产生不符合预期的结果。Python默认会将运行时警告输出到标准错误流中。下面是一个示例代码，用于演示运行时警告的情况：

import math

def square_root(x):
    result = math.sqrt(x)
    return result

#x为负数
x = -1

square_root(x)

上面的示例代码中，调用square_root函数时，传入的参数x是一个负数。由于负数没有实数域的平方根，所以会触发一个运行时警告，并将其输出到标准错误流中。

三、使用warnings模块控制警告的输出方式

在Python中，我们可以使用warnings模块的功能来控制警告的输出方式。warnings模块提供了以下几个函数，用于控制警告的输出方式：

warn(message, category=None, stacklevel=1, source=None)
发出一个警告消息。
formatwarning(message, category, filename, lineno, line=None)
格式化警告消息。
filterwarnings(action, message=””, category=Warning, module=””, lineno=0,
append=False)
设置警告过滤器。
showwarning(message, category, filename, lineno, file=None, line=None)
显示警告消息。

下面，我们将逐个介绍这些函数的使用方法。

3.1 warn函数

warn函数用于发出一个警告消息。它接受以下参数：

message: 警告消息的内容，可以是字符串或者Warning子类的实例。
category: 警告消息的类别，可以是Warning子类的实例。
stacklevel: 警告消息所在的堆栈层数，默认为1，表示当前的函数调用层级。
source: 警告消息的来源，可以是字符串或者Warning子类的实例。

下面是一个示例代码，用于演示warn函数的用法：

import warnings

warnings.warn("这是一个警告消息", UserWarning)

运行结果如下所示：

__main__:1: UserWarning: 这是一个警告消息

在上面的示例代码中，我们调用了warn函数发出了一个警告消息，并指定了警告消息的类型为UserWarning。

3.2 formatwarning函数

formatwarning函数用于格式化警告消息。它接受以下参数：

message: 警告消息的内容。
category: 警告消息的类别。
filename: 警告消息所在的文件名。
lineno: 警告消息所在的行号。
line: 警告消息所在的行的内容。

下面是一个示例代码，用于演示formatwarning函数的用法：

import warnings

warnings.formatwarning = lambda message, category, filename, lineno, line: (
    f"{filename}:{lineno}: {category.__name__}: {message}\n"
)

warnings.warn("这是一个警告消息", UserWarning)

运行结果如下所示：

__main__:9: UserWarning: 这是一个警告消息

在上面的示例代码中，我们通过给formatwarning函数赋予一个lambda函数来格式化警告消息。lambda函数接受formatwarning函数的参数，并返回一个格式化的字符串，用于表示警告消息的格式。

3.3 filterwarnings函数

filterwarnings函数用于设置警告过滤器。它接受以下参数：

action: 设置警告的处理方式。可以是以下几种取值：
- “error”: 将警告视为错误，并抛出一个异常。
- “ignore”: 忽略警告，不做任何处理。
- “always”: 总是显示警告。
- “default”: 使用Python的默认警告处理方式。
- “module”: 将警告记录到一个日志文件中。
- “once”: 只显示一次相同类型的警告。
message: 设置警告消息的匹配模式。
category: 设置警告消息的类别。
module: 设置警告消息的模块名称。
lineno: 设置警告消息所在的行号。
append: 是否将过滤器添加到警告过滤器列表的末尾，默认为False。

下面是一个示例代码，用于演示filterwarnings函数的用法：

import warnings

warnings.filterwarnings("ignore")
warnings.warn("这是一个警告消息", UserWarning)

运行结果为空，没有任何输出。

在上面的示例代码中，我们调用了filterwarnings函数，将警告的处理方式设为忽略，然后通过warn函数发出了一个警告消息。由于我们将警告的处理方式设为忽略，所以警告消息并没有被输出。

3.4 showwarning函数

showwarning函数用于显示警告消息。它接受以下参数：

message: 警告消息的内容。
category: 警告消息的类别。
filename: 警告消息所在的文件名。
lineno: 警告消息所在的行号。
file: 输出警告消息的文件流，默认为sys.stderr。
line: 警告消息所在的行的内容。

下面是一个示例代码，用于演示showwarning函数的用法：

import warnings

def custom_showwarning(message, category, filename, lineno, file=None, line=None):
    if file is None:
        file = sys.stderr
    file.write(f"Warning ({category.__name__}): {message}\n")

warnings.showwarning = custom_showwarning

warnings.warn("这是一个自定义的警告消息", UserWarning)

运行结果如下所示：

Warning (UserWarning): 这是一个自定义的警告消息

在上面的示例代码中，我们定义了一个自定义的showwarning函数，用来显示警告消息。然后将自定义的showwarning函数赋值给warnings模块的showwarning函数，以替换默认的显示警告消息的方法。最后，我们调用了warn函数发出了一个警告消息，并指定了警告消息的类型为UserWarning。