Python最强日志工具——标准库 logging 的使用指南

在开发 Python 程序时，日志（logging）是我们非常重要的一部分。它可以帮助我们记录程序的运行状态，方便后续调试和维护。Python 提供了一个强大的标准库——logging，它能帮助我们轻松地处理日志记录，分类、输出、格式化等等。

本文将带你深入了解 Python 中的logging 库，教你如何使用它记录日志信息，避免直接在代码中使用 print 语句调试，提升你的代码质量。

什么是 `logging`？

logging 是 Python 标准库中的一个模块，主要用于记录程序的运行状态，记录调试信息、错误信息，甚至警告信息等。相比于简单的print() 语句，logging 提供了更强大和灵活的功能。它支持不同级别的日志记录、日志文件保存、日志格式化等操作，是开发者必备的工具。

日志级别

logging 库定义了 5 个日志级别，从低到高分别为：

DEBUG

：详细的调试信息，通常用于开发和调试阶段，记录所有信息。
INFO

：一般信息，显示程序的运行状态、普通事件等。
WARNING

：警告信息，通常表示程序的运行有潜在问题，但不会影响运行。
ERROR

：错误信息，表示程序运行中出现了错误，可能导致部分功能不可用。
CRITICAL

：严重错误，表示程序出现了致命问题，通常会导致程序崩溃。

每个级别的日志信息都会传递给比它更高级别的日志记录器。例如，WARNING 级别的日志记录器会同时记录WARNING、ERROR 和CRITICAL 级别的日志信息，但不会记录DEBUG 或INFO。

如何使用 `logging`？

1. 基本配置

最简单的使用方法是使用logging.basicConfig() 来进行日志配置，指定日志输出的级别、格式、输出目的地等。

示例代码：

import logging

# 配置日志
logging.basicConfig(level=logging.DEBUG,  # 设置日志级别
                    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')  # 设置输出格式

# 各种级别的日志信息
logging.debug("这是调试信息")
logging.info("这是普通信息")
logging.warning("这是警告信息")
logging.error("这是错误信息")
logging.critical("这是严重错误信息")

输出：

2024-12-01 12:00:00,000 - root - DEBUG - 这是调试信息
2024-12-01 12:00:00,000 - root - INFO - 这是普通信息
2024-12-01 12:00:00,000 - root - WARNING - 这是警告信息
2024-12-01 12:00:00,000 - root - ERROR - 这是错误信息
2024-12-01 12:00:00,000 - root - CRITICAL - 这是严重错误信息

这里，我们使用了basicConfig() 来设置日志的级别为DEBUG，表示记录所有级别的日志。format 参数用来设置输出格式，可以根据需求进行自定义。

2. 日志输出到文件

有时候我们需要将日志输出到文件中，而不是直接在终端显示。只需要稍微修改配置即可。

示例代码：

import logging

# 配置日志输出到文件
logging.basicConfig(filename='app.log',  # 指定日志文件
                    level=logging.DEBUG,
                    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')

logging.debug("调试信息写入文件")
logging.info("普通信息写入文件")
logging.warning("警告信息写入文件")

在这个例子中，我们指定了日志输出到名为app.log 的文件中，而不是终端。

3. 使用日志记录器（Logger）

logging 提供了更强大的功能，你可以使用Logger 对象来创建多个日志记录器，分别记录不同模块的日志信息。

示例代码：

import logging

# 创建一个日志记录器
logger = logging.getLogger('my_logger')

# 配置日志
logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(levelname)s - %(message)s')

# 使用记录器记录日志
logger.debug("调试信息")
logger.info("普通信息")
logger.warning("警告信息")
logger.error("错误信息")

在此例中，我们通过getLogger() 创建了一个名为my_logger 的日志记录器。不同的记录器可以在不同的模块或文件中使用，有助于更好地分类和管理日志信息。

4. 日志处理器（Handler）与格式化器（Formatter）

日志处理器（Handler）允许我们把日志发送到不同的地方，如控制台、文件或网络。格式化器（Formatter）则用来定义日志输出的具体格式。

示例代码：

import logging

# 创建记录器
logger = logging.getLogger('my_logger')
logger.setLevel(logging.DEBUG)

# 创建处理器，输出到控制台
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.DEBUG)

# 创建处理器，输出到文件
file_handler = logging.FileHandler('app.log')
file_handler.setLevel(logging.INFO)

# 创建格式化器
formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
console_handler.setFormatter(formatter)
file_handler.setFormatter(formatter)

# 添加处理器
logger.addHandler(console_handler)
logger.addHandler(file_handler)

# 记录日志
logger.debug("调试信息")
logger.info("普通信息")
logger.warning("警告信息")

在这个示例中，我们创建了两个日志处理器：一个输出到控制台，一个输出到文件。通过setFormatter() 方法，设置了统一的日志格式。

5. 日志轮转

如果日志文件不断增长，我们可以使用logging 中的RotatingFileHandler 来实现日志轮转，确保日志文件不会无限膨胀。

示例代码：

import logging
from logging.handlers import RotatingFileHandler

# 创建记录器
logger = logging.getLogger('my_logger')
logger.setLevel(logging.DEBUG)

# 创建一个日志轮转处理器
handler = RotatingFileHandler('app.log', maxBytes=2000, backupCount=3)  # 2000 字节，最多备份 3 个文件
handler.setLevel(logging.DEBUG)

# 设置日志格式
formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)

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

# 记录日志
for i in range(1000):
    logger.debug(f"调试信息 #{i}")