如何在 Python 中临时更改记录消息的格式？

Question

在 Python 中（通过日志模块）临时更改日志消息格式的最简单方法是什么？

目标是拥有一些标准的消息格式，同时能够临时添加有关正在读取的某些文件的信息（如其名称）；当不再读取文件时，消息格式应恢复为其默认值。生成消息的程序不知道正在读取什么文件，所以如果它的消息自动包含相关文件名会很好（错误消息是：“ERROR while正在读取文件 ***: ...”而不是“ERROR: ...”）。

Answer 1

这里有一个简单的解决方案，可以从Vinay Sajip自己的HOWTO推导出来；它基本上用setFormatter()更新了日志格式化程序：

import logging

logger = logging.getLogger()  # Logger
logger_handler = logging.StreamHandler()  # Handler for the logger
logger.addHandler(logger_handler)

# First, generic formatter:
logger_handler.setFormatter(logging.Formatter('%(message)s'))
logger.error('error message')  # Test

# New formatter for the handler:
logger_handler.setFormatter(logging.Formatter('PROCESSING FILE xxx - %(message)s'))
logger.error('error message')  # Test

这正确产生：

error message
PROCESSING FILE xxx - error message

（其中xxx 可以动态设置为正在处理的文件，如问题中所要求的那样）。

Answer 2

有几种方法。除了 already documented ones (extra 记录调用的参数，LoggerAdapter, Filter) 之外，另一种方法是指定自定义格式化类，您可以随时了解其实例正在处理的文件。例如：

class FileProcessingFormatter(logging.Formatter):
    def __init__(self, fmt, datefmt=None, current_file=None):
        super(FileProcessingFormatter, self).__init__(fmt, datefmt)
        self.orig_fmt = fmt
        self.current_file = current_file

    def format(self, record):
        if self.current_file is None:
            self._fmt = self.orig_fmt.replace('__FILE_PLACEHOLDER__', '')
        else:
            self._fmt = self.orig_fmt.replace('__FILE_PLACEHOLDER__',
                            ' while processing %r' % self.current_file)
        return super(FileProcessingFormatter, self).format(record)

实例化格式化程序...

f = FileProcessingFormatter('%(levelname)s__FILE_PLACEHOLDER__ %(message)s')
for h in relevant_handlers:
    h.setFormatter(f)

处理文件...

f.current_file = fn
process_file(fn)
f.current_file = None

这非常简单 - 例如，如果文件处理由不同的线程同时完成，则不适用于线程环境。

更新：虽然可以通过logging.getLogger().handlers 访问根记录器的处理程序，但这是一个可能会更改的实现细节。由于您的要求不是那么基本，您也许可以使用 dictConfig() 来配置您的日志记录（可通过 logutils 项目获得旧版本的 Python）。

Answer 3

我不推荐这个；但是你可以说假设第一个根处理程序是搞砸的并直接修改它

import logging
ROOT_LOGGER = logging.getLogger()
ROOT_LOGGER.handlers[0].setFormatter(logging.Formatter(
    '%(asctime)s:%(levelname)s:%(name)s:%(message)s\n'
))

如果您在任何具有托管日志记录的系统中；这可能会射中你的脚；最好能够确定对要修改的处理程序的确切引用并对其进行修改；

但没有人关心它是否正常工作？/s

Answer 4

据我所知，@Vinay Sajip 在更新中提到的 dictConfig() 是最好的方法。

这是 Python 3.8 中的一个工作示例：

import logging
from logging.config import dictConfig    
FI_PATH_CONSUMERS_LOG = "/project/test_log.log"
LOG_FORMAT = "%(asctime)s %(levelname)-8s [%(name)s] %(message)s"
LOG_LEVEL = "INFO"
LOG_DATEFMT = "%Y-%m-%d %H:%M:%S"

logging.basicConfig(
    filename=FI_PATH_CONSUMERS_LOG,
    format=LOG_FORMAT,
    level=getattr(logging, LOG_LEVEL),
    datefmt=LOG_DATEFMT,
)

def create_new_format(format_additions: str=""):
    """
    This adjusts both loggers, but you can
    also make changes specific to each.
    """
    alt_new_formats = {
        "event_format": {
            "format": LOG_FORMAT + format_additions,
            "datefmt": LOG_DATEFMT,
        },
    }

    changed_setting = {
        "version": 1,
        "formatters": alt_new_formats,
        "handlers": {
            "to_file": {
                "class": "logging.FileHandler",
                "filename": FI_PATH_CONSUMERS_LOG,
                "formatter": "event_format",
                "level": LOG_LEVEL,
            },
        },
        "loggers": {
            "": {
                "handlers": ["to_file"],
            },
        },
        "disable_existing_loggers": False,
    }
    return changed_setting

你可以这样运行：

logger = logging.getLogger()  # root logger
logger_2 = logging.getLogger("logger 2")  # child logger with name "logger 2"
msg_test = "Testing message."

logger.info(msg_test)
logger_2.info(msg_test)

dictConfig(create_new_format(" [Adjust formatting]"))
logger.info(msg_test)
logger_2.info(msg_test)

dictConfig(create_new_format())
logger.info(msg_test)
logger_2.info(msg_test)

这将为您提供以下输出：

2021-09-16 14:47:48 INFO     [root] Testing message.
2021-09-16 14:47:48 INFO     [logger 2] Testing message.
2021-09-16 14:47:48 INFO     [root] Testing message. [Adjust formatting]
2021-09-16 14:47:48 INFO     [logger 2] Testing message. [Adjust formatting]
2021-09-16 14:47:48 INFO     [root] Testing message.
2021-09-16 14:47:48 INFO     [logger 2] Testing message.

Answer 5

如果你想动态改变日志的格式。 可以做成这样的。

logger = logging.getLogger()
# Change format of handler for the logger
logger.handlers[0].setFormatter(logging.Formatter('%(asctime)s,%(msecs)d %(name)s %(levelname)s %(message)s'))
# Print log
logging.info(log)
# return other format
logger.handlers[0].setFormatter(logging.Formatter('%(message)s'))