如何在 Python 中使用 Logging 模块快速上手

配置 Logging 模块

Logging 模块通过 logging.basicConfig() 函数提供基本的配置。您可以使用此函数设置日志记录级别（例如 INFO 或 DEBUG）、处理程序（例如控制台或文件），以及格式化器（用于自定义日志消息的外观）。以下是一个示例配置：

import logging

logging.basicConfig(level=logging.INFO,
                    fORMat="%(asctime)s - %(levelname)s - %(message)s",
                    datefmt="%Y-%m-%d %H:%M:%S")

添加日志记录器

要开始记录日志，您需要创建一个日志记录器。使用 logging.getLogger() 函数获取日志记录器，它将基于提供的名称从根日志记录器中检索或创建日志记录器。

logger = logging.getLogger(__name__)

记录消息

使用日志记录器中的 debug()、info()、warning()、error() 和 critical() 方法记录消息。这些方法分别对应不同的日志记录级别。

logger.info("Application started")
logger.error("An error occurred")

配置日志记录级别

日志记录级别控制需要记录的消息类型。您可以使用 logging.setLevel() 函数设置日志记录级别。级别从最低到最高排序，依次为 DEBUG、INFO、WARNING、ERROR 和 CRITICAL。

logger.setLevel(logging.DEBUG)

使用处理程序

处理程序用于将日志消息发送到特定目标，例如控制台、文件或远程服务器。您可以使用 logging.addHandler() 函数添加处理程序。

import logging.handlers

# 将日志输出到控制台
console_handler = logging.StreamHandler()
logger.addHandler(console_handler)

# 将日志输出到文件
file_handler = logging.FileHandler("app.log")
logger.addHandler(file_handler)

使用格式化器

格式化器用于自定义日志消息的外观。您可以使用 logging.Formatter() 函数创建格式化器。格式化器字符串使用以下占位符：

• %(asctime)s：消息的时间戳
• %(levelname)s：消息的级别
• %(message)s：消息的内容
• %(name)s：消息的日志记录器名称

formatter = logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")
console_handler.setFormatter(formatter)

最佳实践

遵循以下最佳实践以有效利用 Logging 模块：

• 选择合适的日志记录级别，以避免记录过多或过少的信息。
• 使用有意义的日志消息，包括足够的信息。
• 在生产环境中使用文件处理程序，以避免丢失控制台输出。
• 定期检查日志，以了解应用程序的行为和错误。

结论

python Logging 模块是一个强大的工具，可以帮助您监视和调试应用程序。通过遵循本指南，您可以快速上手使用该模块，并改善应用程序的日志记录实践。