添加新Logging Handler时如何默认保持相同Formatter？

问题场景 #

当我们添加新的额外日志处理器时，直接添加的话默认不会继承已有的日志格式：

import logging
logging.basicConfig(level=logging.INFO, format='%(asctime)s: %(name)s: %(levelname)s: %(message)s')
logging.getLogger().addHandler(logging.FileHandler("debug.log"))
logging.info('an info')

此时文件日志会使用默认格式，而非basicConfig中定义的格式。

通常我们需要手动重复定义格式并设置给新处理器：

logging_format = "%(asctime)s: %(name)s: %(levelname)s: %(message)s"
logging.basicConfig(level=logging.INFO, format=logging_format)

# 后续添加文件处理器时
f = logging.Formatter(logging_format)
h = logging.FileHandler("debug.log")
h.setFormatter(f)
logging.getLogger().addHandler(h)

请问是否存在一种方法，在添加新日志处理器时默认保持相同的Formatter？

可行方案 #

1. 复用根日志器已有的Formatter #

无需重复定义格式字符串，直接从根日志器已有的处理器中提取Formatter并复用：

import logging
logging.basicConfig(level=logging.INFO, format='%(asctime)s: %(name)s: %(levelname)s: %(message)s')

root_logger = logging.getLogger()
# 获取根日志器第一个处理器的Formatter（通常是basicConfig创建的控制台处理器）
existing_formatter = root_logger.handlers[0].formatter

# 新建文件处理器并设置格式
file_handler = logging.FileHandler("debug.log")
file_handler.setFormatter(existing_formatter)
root_logger.addHandler(file_handler)

logging.info('an info')

2. 自定义自动继承格式的Handler子类 #

如果需要频繁添加处理器，可以自定义Handler类，初始化时自动继承根日志器的格式：

import logging

class FormattedFileHandler(logging.FileHandler):
    def __init__(self, filename, *args, **kwargs):
        super().__init__(filename, *args, **kwargs)
        # 自动获取根日志器的格式并应用
        root_formatter = logging.getLogger().handlers[0].formatter
        self.setFormatter(root_formatter)

# 初始化基础日志配置
logging.basicConfig(level=logging.INFO, format='%(asctime)s: %(name)s: %(levelname)s: %(message)s')

# 使用自定义Handler，无需手动设置格式
logging.getLogger().addHandler(FormattedFileHandler("debug.log"))
logging.info('an info')

3. 全局统一管理Formatter实例 #

提前创建统一的Formatter实例，给所有处理器（包括初始的控制台处理器和后续添加的文件处理器）统一设置：

import logging

# 全局创建唯一的Formatter实例
log_formatter = logging.Formatter('%(asctime)s: %(name)s: %(levelname)s: %(message)s')

# 初始化控制台处理器并设置格式
console_handler = logging.StreamHandler()
console_handler.setFormatter(log_formatter)
root_logger = logging.getLogger()
root_logger.setLevel(logging.INFO)
root_logger.addHandler(console_handler)

# 添加文件处理器时直接复用同一个Formatter
file_handler = logging.FileHandler("debug.log")
file_handler.setFormatter(log_formatter)
root_logger.addHandler(file_handler)

logging.info('an info')

内容的提问来源于Stack Exchange，提问作者Basj