是否可以根据消息日志级别修改Python的日志记录格式？

71

我正在使用Python的logging机制将输出打印到屏幕上。我可以使用print语句来做到这一点，但是我想允许用户调整更好的粒度以禁用某些类型的输出。我喜欢为错误打印的格式，但是当输出级别为“信息”时，我希望使用更简单的格式。

例如：

  logger.error("Running cmd failed")
  logger.info("Running cmd passed")

在此示例中，我希望以不同的方式打印错误的格式：

# error
Aug 27, 2009 - ERROR: Running cmd failed
# info
Running cmd passed

是否可以在没有多个日志记录对象的情况下针对不同的日志级别使用不同的格式？我宁愿在创建记录器后就不修改它，因为有大量的if / else语句来确定如何记录输出。

python  logging  string-formatting 
— 贝德韦尔
source

Answers:

32

是的，您可以通过创建一个自定义Formatter类来做到这一点：

class MyFormatter(logging.Formatter):
    def format(self, record):
        #compute s according to record.levelno
        #for example, by setting self._fmt
        #according to the levelno, then calling
        #the superclass to do the actual formatting
        return s

然后将一个MyFormatter实例附加到您的处理程序。

— 维奈·萨吉普（Vinay Sajip）
source
出色-完美运作。我修改了format（）方法以检查levelno并根据需要更改消息。否则，它将重置为我传入的原始字符串。谢谢！
— bedwyr
9
请删除此答案中的复选标记。到此为止的一个就完成了。此答案缺少大量的代码，仅在注释中描述了您应该做什么。
— Utkonos
78

我只是碰到了这个问题，在填补上面示例中遗留的“漏洞”时遇到了麻烦。这是我使用的更完整的工作版本。希望这可以帮助某人：

# Custom formatter
class MyFormatter(logging.Formatter):

    err_fmt  = "ERROR: %(msg)s"
    dbg_fmt  = "DBG: %(module)s: %(lineno)d: %(msg)s"
    info_fmt = "%(msg)s"


    def __init__(self, fmt="%(levelno)s: %(msg)s"):
        logging.Formatter.__init__(self, fmt)


    def format(self, record):

        # Save the original format configured by the user
        # when the logger formatter was instantiated
        format_orig = self._fmt

        # Replace the original format with one customized by logging level
        if record.levelno == logging.DEBUG:
            self._fmt = MyFormatter.dbg_fmt

        elif record.levelno == logging.INFO:
            self._fmt = MyFormatter.info_fmt

        elif record.levelno == logging.ERROR:
            self._fmt = MyFormatter.err_fmt

        # Call the original formatter class to do the grunt work
        result = logging.Formatter.format(self, record)

        # Restore the original format configured by the user
        self._fmt = format_orig

        return result

编辑：

赞扬Halloleo，这是一个如何在脚本中使用以上代码的示例：

fmt = MyFormatter()
hdlr = logging.StreamHandler(sys.stdout)

hdlr.setFormatter(fmt)
logging.root.addHandler(hdlr)
logging.root.setLevel(DEBUG)

编辑2：

Python3日志记录已更改了一点。有关Python3方法，请参见此处。

— JS。
source
这很棒！我将MyFormatter名称更改为，以self提高一致性。
— halloleo 2012年
2
在这里，我可能会添加在程序中使用MyFormatter类的方式（用回车符替换每个<CR>）： fmt = MyFormatter()<CR> hdlr = logging.StreamHandler(sys.stdout)<CR> <CR> hdlr.setFormatter（fmt）<CR> logging.root.addHandler（hdlr）<CR> 日志记录。 root.setLevel（DEBUG）`<CR>
— halloleo 2012年
6
由于内部日志记录机制的更改，此答案在3.2之后将不再起作用。logging.Formatter.format现在取决于的style参数__init__。
— Evpok
2
evpok是对的。分配self._fmt后，添加此代码：self._style = logging.PercentStyle(self._fmt)
— Ross R
2
是否可以通过使用super()而不是调用来改进logging.Formatter？
— 凤凰城
16

再像JS答案，但更紧凑。

class SpecialFormatter(logging.Formatter):
    FORMATS = {logging.DEBUG :"DBG: %(module)s: %(lineno)d: %(message)s",
               logging.ERROR : "ERROR: %(message)s",
               logging.INFO : "%(message)s",
               'DEFAULT' : "%(levelname)s: %(message)s"}

    def format(self, record):
        self._fmt = self.FORMATS.get(record.levelno, self.FORMATS['DEFAULT'])
        return logging.Formatter.format(self, record)

hdlr = logging.StreamHandler(sys.stderr)
hdlr.setFormatter(SpecialFormatter())
logging.root.addHandler(hdlr)
logging.root.setLevel(logging.INFO)
— 埃斯塔尼
source
2
由于内部日志记录机制的更改，此答案在3.2之后将不再起作用。logging.Formatter.format现在取决于的style参数__init__。
— Evpok
10

这是estani对新实现的答复的改编，该新实现logging.Formatter现在依赖于格式设置样式。我的依赖'{'样式格式，但是可以适应。可以改进为更通用，并允许选择格式设置样式和自定义消息作为的参数__init__。

class SpecialFormatter(logging.Formatter):
    FORMATS = {logging.DEBUG : logging._STYLES['{']("{module} DEBUG: {lineno}: {message}"),
           logging.ERROR : logging._STYLES['{']("{module} ERROR: {message}"),
           logging.INFO : logging._STYLES['{']("{module}: {message}"),
           'DEFAULT' : logging._STYLES['{']("{module}: {message}")}

    def format(self, record):
        # Ugly. Should be better
        self._style = self.FORMATS.get(record.levelno, self.FORMATS['DEFAULT'])
        return logging.Formatter.format(self, record)

hdlr = logging.StreamHandler(sys.stderr)
hdlr.setFormatter(SpecialFormatter())
logging.root.addHandler(hdlr)
logging.root.setLevel(logging.INFO)
— 埃波克
source
1
感谢您更新此版本以使其可用于Python3。我在Python3中遇到了同样的问题，并提出了类似的解决方案。您是否也愿意在此张贴答案？stackoverflow.com/questions/14844970/...
— JS。
2
在您的评论中使用新的“ {”样式？:-)
— JS。
10

除了依赖样式或内部字段，您还可以创建一个Formatter，它根据record.levelno（或其他条件）委派给其他格式化程序。以我的拙见，这是一个稍微干净的解决方案。以下代码适用于所有python版本> = 2.7的代码：

简单的方法如下所示：

class MyFormatter(logging.Formatter):

    default_fmt = logging.Formatter('%(levelname)s in %(name)s: %(message)s')
    info_fmt = logging.Formatter('%(message)s')

    def format(self, record):
        if record.levelno == logging.INFO:
            return self.info_fmt.format(record)
        else:
            return self.default_fmt.format(record)

但是您可以使其更通用：

class VarFormatter(logging.Formatter):

    default_formatter = logging.Formatter('%(levelname)s in %(name)s: %(message)s')

    def __init__(self, formats):
        """ formats is a dict { loglevel : logformat } """
        self.formatters = {}
        for loglevel in formats:
            self.formatters[loglevel] = logging.Formatter(formats[loglevel])

    def format(self, record):
        formatter = self.formatters.get(record.levelno, self.default_formatter)
        return formatter.format(record)

我在这里使用了dict作为输入，但是显然，您也可以使用元组，** kwargs，无论您的船是什么。然后将其用作：

formatter = VarFormatter({logging.INFO: '[%(message)s]', 
                          logging.WARNING: 'warning: %(message)s'})
<... attach formatter to logger ...>
— 乔里斯
source
9

这样做的一种方法

定义一个班级

import logging

class CustomFormatter(logging.Formatter):
    """Logging Formatter to add colors and count warning / errors"""

    grey = "\x1b[38;21m"
    yellow = "\x1b[33;21m"
    red = "\x1b[31;21m"
    bold_red = "\x1b[31;1m"
    reset = "\x1b[0m"
    format = "%(asctime)s - %(name)s - %(levelname)s - %(message)s (%(filename)s:%(lineno)d)"

    FORMATS = {
        logging.DEBUG: grey + format + reset,
        logging.INFO: grey + format + reset,
        logging.WARNING: yellow + format + reset,
        logging.ERROR: red + format + reset,
        logging.CRITICAL: bold_red + format + reset
    }

    def format(self, record):
        log_fmt = self.FORMATS.get(record.levelno)
        formatter = logging.Formatter(log_fmt)
        return formatter.format(record)

实例化记录器

# create logger with 'spam_application'
logger = logging.getLogger("My_app")
logger.setLevel(logging.DEBUG)

# create console handler with a higher log level
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)

ch.setFormatter(CustomFormatter())

logger.addHandler(ch)

并使用！

logger.debug("debug message")
logger.info("info message")
logger.warning("warning message")
logger.error("error message")
logger.critical("critical message")

结果 在此处输入图片说明

— 谢尔盖·普列沙科夫（Sergey Pleshakov）
source
1
这似乎是在python 3.6上工作的唯一答案
— user3821178
1
我尝试在这里stackoverflow.com/a/56944256/9150146保持最新答案，如果有帮助，请投票。谢谢@ user3821178
— Sergey Pleshakov
这是一个很好的答案。颜色编码日志记录也非常有帮助。
— Akash Desarda '20年
6

以上解决方案适用于3.3.3版本。但是，使用3.3.4时，会出现以下错误。

FORMATS = { logging.DEBUG : logging._STYLES['{']("{module} DEBUG: {lineno}: {message}"),

TypeError：“元组”对象不可调用

在日志记录类Lib \ logging__init __。py中进行了一些搜索之后，我发现数据结构已从3.3.3更改为3.3.4，从而导致了问题

3.3.3

_STYLES = {
    '%': PercentStyle,
    '{': StrFormatStyle,
    '$': StringTemplateStyle
}

3.3.4

_STYLES = {
   '%': (PercentStyle, BASIC_FORMAT),
   '{': (StrFormatStyle, '{levelname}:{name}:{message} AA'),
    '$': (StringTemplateStyle, '${levelname}:${name}:${message} BB'),
}

因此，更新的解决方案是

class SpecialFormatter(logging.Formatter):
     FORMATS = {logging.DEBUG : logging._STYLES['{'][0]("{module} DEBUG: {lineno}: {message}"),
       logging.ERROR : logging._STYLES['{'][0]("{module} ERROR: {message}"),
       logging.INFO : logging._STYLES['{'][0]("{module}: {message}"),
       'DEFAULT' : logging._STYLES['{'][0]("{module}: {message}")}

 def format(self, record):
    # Ugly. Should be better
    self._style = self.FORMATS.get(record.levelno, self.FORMATS['DEFAULT'])
    return logging.Formatter.format(self, record)
— 用户名
source
直接导入from logging import StrFormatStyle而不是直接导入样式类型可能会更容易logging._STYLES['{'][0]
— -TomDotTom，
3

如果您只是想跳过某些级别的格式，则可以执行比其他答案更简单的操作，如下所示：

class FormatterNotFormattingInfo(logging.Formatter):
    def __init__(self, fmt = '%(levelname)s:%(message)s'):
        logging.Formatter.__init__(self, fmt)

    def format(self, record):
        if record.levelno == logging.INFO:
            return record.getMessage()
        return logging.Formatter.format(self, record)

通过不使用诸如self._fmt或self._style之类的内部变量，这也具有在3.2版本之前和之后进行工作的优点。

— JDiMatteo
source
我认为这是最干净的解决方案
— vlk
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.