Use lazy % formatting in logging functions (65:4) [logging-fstring-interpolation]

在Python的日志记录中，使用懒惰的（lazy）格式化是一种最佳实践，特别是在使用高级别的日志记录时，因为这可以避免在日志级别被设置为不会记录该消息时进行不必要的格式化操作。Python的日志模块支持多种格式化方式，包括传统的%格式化和f-string（格式化字符串字面量）。然而，在日志记录中，推荐使用%格式化，因为它支持懒惰求值。

为什么使用懒惰格式化？

当使用%格式化时，实际上是在调用Logger对象的_log方法时进行格式化的，这意味着如果日志级别设置得较高，那么即使传递了参数，也不会进行实际的格式化操作，从而节省资源。

示例

假设你有一个简单的日志记录函数，目前使用f-string进行日志记录：

import logging

logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)

# 创建一个文件处理器
handler = logging.FileHandler('app.log')
handler.setLevel(logging.DEBUG)

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

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

def log_message(message, value):
    logger.debug(f"Message: {message}, Value: {value}")

这段代码在日志级别不是DEBUG时，依然会解析f-string，这是不必要的。我们可以改为使用%格式化：

import logging

logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)

# 创建一个文件处理器
handler = logging.FileHandler('app.log')
handler.setLevel(logging.DEBUG)

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

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

def log_message(message, value):
    logger.debug("Message: %s, Value: %s", message, value)

解释

在修改后的代码中，logger.debug接受两个参数：一个是格式字符串，另一个是待格式化的参数列表。当实际的日志级别低于DEBUG时，logger.debug不会执行任何操作，因此不会对传入的参数进行任何格式化处理。

避免不必要的计算

使用懒惰格式化还有一个好处，那就是可以避免在日志级别不允许记录时执行复杂的表达式或函数调用。例如：

def expensive_computation():
    # 假设这是一个复杂的计算
    import time
    time.sleep(1)
    return "Expensive result"

def log_message(message, value):
    # 使用f-string
    logger.debug(f"Message: {message}, Value: {expensive_computation()}")

    # 使用%格式化
    logger.debug("Message: %s, Value: %s", message, expensive_computation())

在这个例子中，如果日志级别不是DEBUG，则不会执行expensive_computation()函数。但是，如果使用f-string，则无论如何都会执行该函数，即使最终日志不会被记录。

总结

使用懒惰格式化不仅提高了性能，还能确保在不必要的情况下不会进行复杂的计算。对于Python的日志记录，推荐使用%格式化，尤其是在日志消息中包含复杂表达式或函数调用时。这样可以确保只有在日志级别允许记录时才会进行实际的格式化操作。