【Python】logging模块函数详解和示例

发布于:2023-12-07 ⋅ 阅读:(48) ⋅ 点赞:(0)

在Python中,LOGGER通常是指一个用于记录日志的模块或对象。它可以帮助你在程序中跟踪和记录事件,以便于调试、错误跟踪和日志分析。Python的标准库中包含了一个名为logging的模块,它提供了一个灵活且功能强大的日志记录系统。本文对相应的函数进行详解和示例,以帮助大家理解和使用。


首先,需要导入logging模块,以便在你的代码中使用它。

import logging

日志级别

在logging模块中,你可以创建一个或多个日志记录器,然后将它们配置为记录不同级别的消息。
有五个预定义的日志级别,从低到高分别是:DEBUG、INFO、WARNING、ERROR、CRITICAL。每个级别都对应着不同的信息类型和严重程度。

DEBUG

这是最低的日志级别,通常用于输出最详细的信息,包括程序的内部运作细节。这种级别通常只在诊断问题时使用,因为在生产环境中可能会产生大量的日志输出。

INFO

这个级别的日志用于输出一般信息,比如程序的主要事件或状态改变。这是了解系统运行状态的有用工具。

WARNING

当发生可能的问题或潜在的错误时,会使用此级别的日志。例如,如果磁盘空间不足,可能会记录一个警告。虽然这种情况可能会导致问题,但仍然允许程序继续运行。

ERROR

这个级别的日志用于输出错误信息,这些错误信息通常会导致程序的部分功能失效。例如,如果无法连接到数据库,可能会记录一个错误。

CRITICAL

这是最高的日志级别,用于输出极其严重的问题,这些问题可能会导致程序崩溃或无法正常运行。例如,内存溢出或操作系统崩溃等严重问题会记录为严重错误。

这些级别构成了一个大层次结构,意味着如果一个消息被标记为 INFO,那么它包括比它更低级别的所有消息(例如 DEBUG),但不包括比它更高的级别(例如 ERROR)。

你可以通过设置日志记录器的级别来控制哪些消息被记录下来。例如,如果将日志记录器的级别设置为 INFO,那么 INFO 和 DEBUG 级别的消息都会被记录下来,但 WARNING、ERROR 和 CRITICAL 级别的消息则不会。

logging.getLogger()

logging.getLogger() 是 Python 的 logging 模块中的一个函数,它用于获取或创建日志记录器对象。这个对象是用于处理和跟踪程序中事件(例如错误、警告、信息等)的工具。

logging.getLogger(name)

其中 name 是一个字符串,用于区分不同的日志记录器对象。
如果 name 参数为空字符串(""),那么将返回根日志记录器。
如果 name 参数为非空字符串,那么将返回一个具有该名称的日志记录器,
如果该日志记录器不存在,则创建一个新的日志记录器。
import logging

# # 创建一个logger
logger = logging.getLogger('my_logger')

logger.setLevel()

logger.setLevel() 是 Python 的 logging 模块中的一个方法,用于设置 logger 的日志级别。
日志级别决定了 logger 是否记录消息。
日志级别从低到高分别是:DEBUG、INFO、WARNING、ERROR、CRITICAL。如果 logger 的级别设置为 DEBUG,那么它就会记录 DEBUG 及其以上级别的所有消息;如果设置为 INFO,那么就记录 INFO、WARNING、ERROR 和 CRITICAL 消息。依此类推。

import logging
logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)  # 设置日志级别为DEBUG

logging.FileHandler()

logging.FileHandler() 是 Python 的 logging 模块中的一个类,它用于将日志消息写入到文件中。你可以使用这个类来创建一个特定的文件处理器,从而将日志消息输出到一个指定的文件中。

logging.FileHandler() 接收两个参数:

filename:要写入的文件名。也可以是文件路径,例如 '/path/to/logfile.log'。
mode:文件打开模式。默认为 'a'(追加模式),也可是 'w'(写入模式)覆盖原有内容,或者 'r'(读取模式)读取原有内容。

logging.StreamHandler()

logging.StreamHandler() 是 Python 的 logging 模块中的一个类,它用于将日志消息输出到指定的流(默认为 sys.stderr)。你可以使用这个类来创建一个特定的流处理器,从而将日志消息输出到特定的流中。

logging.StreamHandler() 不需要任何参数。

logging.Formatter()

logging.Formatter() 是 Python 的 logging 模块中的一个类,它用于定义日志消息的格式。你可以使用这个类来创建一个特定的格式化器,从而定义你希望看到的日志消息格式。

logging.Formatter() 可以接收以下参数:

format:格式字符串,用于定义日志消息的格式。可以包含一些特殊的格式化指令,例如 %m(消息文本)、%n(换行符)、%t(时间戳)等。
datefmt:时间戳的格式化字符串,用于定义时间戳的格式。如果不提供该参数,默认使用 ISO8601 格式。
style:字符串格式化操作符,默认为 '{'(字典样式)和 'r'(原始字符串样式)之一。如果设置为 '{',则可以使用诸如 {asctime} 之类的占位符。如果设置为 'r',则消息将被格式化为原始字符串。

logger.addHandler()

logger.addHandler() 是 Python 的 logging 模块中的一个方法,它用于将一个日志处理器(handler)添加到特定的 logger 中。这个方法使得 logger 能够将日志消息发送到特定的处理器中,以便进行记录、输出或其他处理。

logger.addHandler() 方法接收一个 logging.Handler 对象作为参数。在 Python 的 logging 模块中,有许多不同类型的处理器,包括 StreamHandler(输出到控制台)、FileHandler(输出到文件)、RotatingFileHandler(输出到轮转文件)等等。

运行示例

import logging

# 创建一个logger
logger = logging.getLogger('my_logger')

# 设置全局日志级别为DEBUG
logger.setLevel(logging.DEBUG)

# 创建一个handler,用于写入日志文件
fh = logging.FileHandler('my_logger.log')

# 再创建一个handler,用于输出到控制台
ch = logging.StreamHandler()

# 定义handler的输出格式
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

# 给handler设置输出格式
fh.setFormatter(formatter)
ch.setFormatter(formatter)

# 给logger添加handler
logger.addHandler(fh)
logger.addHandler(ch)

# 记录一条日志
logger.debug('This is a debug message')
logger.info('This is an info message')
logger.warning('This is a warning message')
logger.error('This is an error message')
logger.critical('This is a critical message')

在这个示例中,我们创建了一个 Formatter,它将日志消息的格式定义为包含时间戳、logger名称、日志级别和消息文本的字符串。然后,我们将这个 Formatter 应用到了一个 StreamHandler 上,该 handler 将日志消息输出到控制台。最后,我们记录了一些日志消息,并使用这个 Formatter 对它们进行了格式化。

在这里插入图片描述

**输出内容:**在终端输出相应信息,并在文件夹中创建了一个Logging_ceshi.log的文件,文件内容为:
在这里插入图片描述

本文含有隐藏内容,请 开通VIP 后查看