[Python知识库]python模块解析之logging模块：打印日志

第一次 import logging 的时候会创建一个名为 root 的 Logger 类作为根结点，等级是WARNING（也就是指打印WARNING及更高等级的信息），并建立一个 “名称-结点” 映射表。后续 logging.getLogger(name) 的时候，默认每个 Logger 类都有一个 root 属性，值为根结点。当新建一个多层次结点 logging.getLogger("aa.bb.cc") 时，logging 首先会检查 “名称-结点” 映射表，并创建 “aa.bb.cc” 结点并放进表里，然后逐层往上建表，遇到不存在的名称会把一个占位符 PlaceHolder 作为对应的结点。例如已有 “aa”，要建立 “aa.bb.cc”，那么在映射表中 “aa” 跟 “aa.bb.cc” 键对应的值是 Logger 实例，“aa.bb” 则是 PlaceHolder 实例。占位符会记录有哪些结点在逐层往上的过程中经过它（这些结点就是它的孩子），并在占位符对应的名字被 logging.getLogger(name) 的时候，先将映射表里的占位符替换成真正的结点，再将所有孩子结点的 parent 属性调整为自身。

在打印日志如 logger.info() 时，结点会检查 INFO 是否大于等于自己的日志等级 logger.level，是才打印，否则不打印。如果初始化结点时没有设置等级，该结点等级为 NOTSET 也即未设定，会向上找第一个有设定等级的结点，按它的等级进行判断。如果子结点使用了不同的日志文件路径，当子结点打印信息的时候，如果 logger.propagate=True，它还会同时向父结点的句柄（对句柄的解释见下文）写入信息。

句柄handler是logger实例输出信息的对象，可以是标准输出stdout，也可以是一个文件句柄，一个logger实例可以通过addHandler添加很多个句柄，每次logger.info()的时候会向所有句柄写入信息。stdout还可以通过setFormatter设置输出格式，也即formatter。

下面是一个包含较多信息且有颜色的formatter：

import logging

class _ColorfulFormatter(logging.Formatter):
    def __init__(self, *args, **kwargs):
        self._root_name = kwargs.pop("root_name") + "."
        super(_ColorfulFormatter, self).__init__(*args, **kwargs)

    def formatMessage(self, record):
        log = super(_ColorfulFormatter, self).formatMessage(record)
        if record.levelno == logging.WARNING:
            prefix = colored("WARNING", "red", attrs=["blink"])
        elif record.levelno == logging.ERROR or record.levelno == logging.CRITICAL:
            prefix = colored("ERROR", "red", attrs=["blink", "underline"])
        else:
            return log
        return prefix + " " + log

# 形如[03/01 16:09:17] func1() in moduleA.moduleB-file1.py line 70, INFO:
basic_formatter = "[%(asctime)s] %(funcName)s() in %(name)s-%(filename)s line %(lineno)d, %(levelname)s: "
plain_formatter = logging.Formatter(
    basic_formatter + "%(message)s",
    datefmt="%m/%d %H:%M:%S",
)
# stdout logging: master only
if distributed_rank == 0:
    ch = logging.StreamHandler(stream=sys.stdout)
    ch.setLevel(level)
    if color:
        formatter = _ColorfulFormatter(
            colored(basic_formatter, "green") + "%(message)s",
            datefmt="%m/%d %H:%M:%S",
            root_name=name,
        )
    else:
        formatter = plain_formatter
    ch.setFormatter(formatter)
    logger.addHandler(ch)