Python 记录器：如何同时将消息输出到 stdout 和日志文件？

2024-03-04 01:31:06

Python 记录器：如何在记录文件之外同时输出消息到标准输出

在开发过程中，日志记录对于诊断问题和跟踪应用程序行为至关重要。Python 的 logging 模块提供了强大的功能，允许你灵活地记录消息，包括将其输出到文件或流。然而，有时你可能希望同时将所有消息输出到标准输出 (stdout)，以进行实时查看和调试。

StreamHandler：输出到 stdout

为了实现这一目标，logging 模块提供了 StreamHandler 类，它允许你将记录器连接到输出流，例如 stdout。只需几行代码，你就可以配置一个 StreamHandler 并将其附加到记录器：

import logging

# 创建一个记录器
logger = logging.getLogger(__name__)

# 创建一个 StreamHandler，并将它附加到记录器
handler = logging.StreamHandler()
logger.addHandler(handler)

设置日志级别：调试所有消息

默认情况下，记录器仅记录警告和更高级别的消息。如果你希望记录所有消息，包括调试消息，你需要将日志级别设置为 DEBUG：

logger.setLevel(logging.DEBUG)

日志格式：增强可读性

为了使 stdout 中的输出易于阅读，你可以配置日志格式，包括时间戳、日志名称、级别和消息：

# 创建一个日志格式器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

# 将格式器附加到流处理程序
handler.setFormatter(formatter)

完成这些配置后，所有记录的消息都会同时输出到 stdout 和指定的记录文件。

示例代码

以下是一个示例代码，演示如何使用 StreamHandler 将所有消息输出到 stdout：

import logging

# 创建一个记录器
logger = logging.getLogger(__name__)

# 将一个 StreamHandler 附加到记录器
handler = logging.StreamHandler()
logger.addHandler(handler)

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

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

# 记录一些消息
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')

运行此代码，你会看到所有日志消息都已输出到 stdout，如下所示：

2023-02-28 10:04:32,123 - __main__ - DEBUG - This is a debug message
2023-02-28 10:04:32,123 - __main__ - INFO - This is an info message
2023-02-28 10:04:32,123 - __main__ - WARNING - This is a warning message
2023-02-28 10:04:32,123 - __main__ - ERROR - This is an error message
2023-02-28 10:04:32,123 - __main__ - CRITICAL - This is a critical message