掌握Python logging：全面指南、从初级到专业

简介

logging 模块是 python 中用于日志记录的标准库。它提供了对应用程序中事件进行日志记录的统一界面，并允许开发人员定义日志级别的细粒度控制、格式化日志消息以及将日志输出到各种目标（例如文件、控制台或网络套接字）。

入门

创建一个 Logger

要开始日志记录，首先需要创建一个 logger 对象。logger 可以通过 logging.getLogger(name) 函数创建，其中 name 是一个标识符字符串，用于识别logger。

import logging

# 创建一个名为 "my_logger" 的 logger
logger = logging.getLogger("my_logger")

记录日志消息

可以使用 logger.log(level, msg, *args, **kwargs) 方法记录日志消息，其中：

• level：日志消息的级别。
• msg：日志消息的。
• *args 和 **kwargs：可选参数，用于格式化日志消息。

logger.info("程序已启动")
logger.error("发生错误！")

日志级别

logging 模块定义了以下日志级别（从最低到最高）：

• DEBUG：用于调试目的的详细信息。
• INFO：用于常规应用程序消息。
• WARNING：用于引起注意的问题。
• ERROR：用于错误和例外情况。
• CRITICAL：用于严重错误或应用程序崩溃。
• NOTSET：禁用日志记录。

可以将日志级别设置为 logger.level 属性。例如，要将 my_logger 的级别设置为 WARNING，可以使用：

logger.level = logging.WARNING

格式化器

格式化器用于控制日志消息的外观。可以通过 logging.FORMatter 类创建格式化器，它具有以下参数：

• fmt：日志消息的格式字符串。
• datefmt：日期和时间的格式字符串（可选）。

# 创建一个格式化器，包含时间戳、日志级别和日志消息
formatter = logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")

处理器

处理器用于将日志消息输出到特定目标。logging 模块提供了一些开箱即用的处理器，例如：

• logging.StreamHandler：将日志消息输出到控制台。
• logging.FileHandler：将日志消息输出到文件。
• logging.SocketHandler：将日志消息输出到网络套接字。

# 创建一个处理器，将日志消息输出到控制台
handler = logging.StreamHandler()

# 将格式化器添加到处理器
handler.setFormatter(formatter)

# 将处理器添加到 logger
logger.addHandler(handler)

过滤器

过滤器用于根据特定条件筛选日志消息。logging 模块提供了以下过滤器：

• logging.Filter：基本过滤器，允许或拒绝日志消息。
• logging.LevelFilter：基于日志级别筛选日志消息。
• logging.MessageFilter：基于日志消息本身筛选日志消息。

# 创建一个过滤器，仅允许 INFO 和 WARNING 级别的日志消息
filter = logging.LevelFilter(logging.INFO)

# 将过滤器添加到处理器
handler.addFilter(filter)

高级用法

层次结构日志记录

Python logging 模块支持层次结构日志记录，其中 logger 可以继承其父 logger 的属性和行为。这允许建立一个具有不同级别的日志细粒度的日志记录结构。

自定义日志记录级别

还可以创建自定义日志记录级别，以便更好地适应应用程序的特定需求。这可以通过 logging.addLevelName(level_name, level_value) 函数实现。

扩展 Logging 模块

可以通过自定义类和函数扩展 logging 模块，以实现更高级或特定的日志记录功能。例如，可以创建自己的处理器或过滤器来满足特定要求。

结论

Python logging 模块是一个强大的工具，用于应用程序中的日志记录。它提供了灵活性和可定制性，允许开发人员根据应用程序的特定需求构建日志记录系统。通过遵循本教程中概述的基本原则和高级技术，可以最大限度地利用 logging 模块，并为应用程序实现高效且信息丰富的日志记录。