Python logging 模块解密：揭示其不为人知的一面

1. 日志级别：精准控制日志信息

logging 模块定义了五种标准日志级别：DEBUG、INFO、WARNING、ERROR 和 CRITICAL。这些级别决定了要记录的消息的重要性和严重性。默认情况下，logging 仅记录 WARNING 及以上级别的消息。您可以通过设置日志器的级别来微调日志的行为。例如：

import logging

# 设置 root 日志器的级别为 INFO
logging.basicConfig(level=logging.INFO)

2. 日志格式：定制日志输出

logging 模块提供了强大的日志格式机制，允许您自定义日志消息的外观。格式字符串指定了日志消息中包含的信息，例如时间戳、日志级别、消息文本和堆栈跟踪。默认格式为：

"[%(asctime)s] %(levelname)s %(module)s.%(funcName)s: %(message)s"

您可以使用以下代码自定义格式：

# 设置自定义日志格式
logging.basicConfig(format="%(asctime)s %(levelname)-8s %(message)s")

3. 日志处理器：扩展日志输出目的地

处理器负责将日志消息发送到特定目标，例如文件、控制台或远程服务器。logging 模块提供了几种内置处理器，如 StreamHandler 和 FileHandler。

创建自定义处理器也非常简单。您需要创建一个类并覆盖 handle 方法，该方法将日志消息写入目标。例如，将日志写入自定义文件：

class MyFileHandler(logging.FileHandler):
    def __init__(self, filename):
        super().__init__(filename)

# 将自定义处理器添加到 root 日志器
logging.getLogger().addHandler(MyFileHandler("my_log.txt"))

4. 日志筛选器：过滤不必要的日志消息

筛选器允许您根据特定的条件过滤日志消息。您可以基于日志级别、消息文本或其他标准来创建筛选器。筛选器可以附加到处理器，以仅允许满足条件的消息通过。

例如，忽略 WARNING 级别的消息的筛选器：

import logging

# 创建筛选器忽略 WARNING 级别的消息
filter = logging.Filter()
filter.filter = lambda record: record.levelno < logging.WARNING

# 将筛选器添加到 root 日志器的处理器
logging.getLogger().handlers[0].addFilter(filter)

5. 日志上下文管理：优雅的日志记录

logging.LoggerContextManager 上下文管理器提供了一种简洁的方式来记录块中的消息。这对于临时更改日志级别或禁用日志记录非常有用。

with logging.LoggerContextManager():
    # 临时将日志级别设置为 DEBUG
    logging.getLogger().setLevel(logging.DEBUG)

    # 在块内记录 DEBUG 级的消息
    logging.debug("调试信息")

6. 高级技巧：

• 使用字典配置器：使用字典配置器提供更灵活的配置选项。
• 创建自己的日志级别：通过编写自定义日志级别来扩展内置级别。
• 使用日志记录框架：例如 structlog 或 loguru，提供高级功能和可扩展性。
• 异步日志记录：通过使用异步处理器来提高大型应用程序的性能。
• 日志记录异常：使用 logging.exception() 或 logging.log_exception() 记录异常堆栈跟踪。

结论：

Python logging 模块是一个功能强大的工具，可用于有效地记录应用程序活动。通过理解日志级别、日志格式、日志处理器、日志筛选器和高级技巧，您可以充分利用 logging 的功能，为您的应用程序创建灵活且有意义的日志记录解决方案。