将自定义格式化程序类与 Python 的 logging.config 模块结合使用

Question

我有以下日志记录类，当在代码中指定为格式化程序时，它可以很好地工作。它通过在要记录的消息的开头加一个字符串来扩展现有的格式化程序，以帮助显示消息的重要性。（我不只是在格式字符串中使用%(levelname)s，因为我不想显示DEBUG或INFO前缀。）

class PrependErrorLevelFormatter(logging.Formatter):
    def __init__(self, default):
        self._default_formatter = default
    def format(self, record):
        if record.levelno == logging.WARNING:
            record.msg = "[WARNING] " + record.msg
        elif record.levelno == logging.ERROR:
            record.msg = "[ERROR] " + record.msg
        elif record.levelno == logging.CRITICAL:
            record.msg = "[CRITICAL] " + record.msg
        return self._default_formatter.format(record)

现在我想通过logging.config.fileConfig（）加载的配置文件来分配它

[formatter_PrependErrorLevelFormatter]
format=%(asctime)s  %(message)s
datefmt=%X
class=PrependErrorLevelFormatter

不幸的是，我在解决这个类时遇到了错误：

  File "C:Python27libloggingconfig.py", line 70, in fileConfig
    formatters = _create_formatters(cp)
  File "C:Python27libloggingconfig.py", line 127, in _create_formatters
    c = _resolve(class_name)
  File "C:Python27libloggingconfig.py", line 88, in _resolve
    found = __import__(used)
ImportError: No module named PrependErrorLevelFormatter

我曾尝试在类名前面加上它所在模块的名称，但也出现了同样的错误。即使它可以解析类，由于我需要提供额外的默认格式化程序参数，它也可能无法工作。

如何使用logging.config系统实现我想要的结果？

Answer 1

当您使用Python 2.7时，您可以使用dictConfig()使用基于字典的配置：这比fileConfig()更灵活，因为它允许使用任意可调用函数作为工厂来返回例如处理程序、格式化程序或筛选器。

如果让使用fileConfig()，则必须构造一个可调用函数，该函数接受format和datefmt字符串值并返回类的实例。class值只需要解析为一个可调用的类，而不是一个实际的类。这里有一个有效的设置：在这个要点中，我有一个文件custfmt.py，它包含格式化程序定义，还有一个脚本fcfgtest.py，它通过fileConfig()使用它。只需将文件放入一个暂存目录并运行fcfgtest.py——您应该会看到这样的输出：

20:17:59 debug message
20:17:59 info message
20:17:59 [WARNING] warning message
20:17:59 [ERROR] error message
20:17:59 [CRITICAL] critical message

这似乎正是你所需要的。

请注意，您可以为格式化程序使用另一种设计，它应该做同样的工作：

class AltCustomFormatter(logging.Formatter):
    def format(self, record):
        if record.levelno in (logging.WARNING,
                              logging.ERROR,
                              logging.CRITICAL):
            record.msg = '[%s] %s' % (record.levelname, record.msg)
        return super(AltCustomFormatter , self).format(record)

要使用这个，你不需要单独的工厂功能，所以你可以只使用

class=custfmt.AltCustomFormatter

而不是

class=custfmt.factory

它应该可以工作——当我刚刚使用Python 2.7.1:-）