Skip to content

系统内置日志模块

全局日志设置

通过 logging.basicConfig 设置全局的日志属性等

查看示例代码 
import logging
logging.basicConfig(level=logging.DEBUG, format="%(asctime)s %(levelname)s %(message)s", datefmt="%Y-%m-%d %H:%M:%S")

功能定制

彩色化日志

为了方便在终端上查看日志, 带色彩的文本, 能更轻松地定位到关注的信息.

日志输出到终端的时候能显示色彩, 本质原理就是终端匹配到了表示颜色的前缀, 以及表示结束色彩的后缀, 那么中间这部分字符串, 就会按照前缀里指定的颜色进行输出.

基本的实现思路, 无非两种.

  1. 在输出文本的时候, 对文本内容进行封装. 虽然灵活, 但是繁琐.
  2. 在格式化日志的时候, 按照格式, 如"%(levelname)s", 对格式内容进行封装. 泛用性高, 但是定制性差.

基于格式化彩色化日志

最终还是选择了以格式化为基本的做法, 简单更加重要.

顺便一提, click.style 函数封装了在终端显示文本时的色彩等样式功能, 使用起来非常方便.

class ColorFormatter(logging.Formatter):
    _format = "%(asctime)s %(levelname)s %(message)s"
    _datefmt = "%Y-%m-%d %H:%M:%S"

    log_colors: dict[int, list[tuple[str, str]]] = {
        logging.DEBUG: [
            ("%(levelname)s", "cyan"),
        ],
        logging.INFO: [
            ("%(levelname)s", "green"),
        ],
        logging.WARNING: [
            ("%(levelname)s", "yellow"),
            ("%(message)s", "yellow"),
        ],
        logging.ERROR: [
            ("%(levelname)s", "red"),
            ("%(message)s", "red"),
        ],
        logging.CRITICAL: [
            ("%(levelname)s", "bright_red"),
            ("%(message)s", "bright_red"),
        ],
    }

    def format(self, record: logging.LogRecord):
        log_fmt = self._format

        color_handlers: list[tuple[str, str]] = self.log_colors.get(record.levelno, [])
        for text, color in color_handlers:
            log_fmt = log_fmt.replace(text, click.style(str(text), fg=color))

        formatter = logging.Formatter(log_fmt, datefmt=self._datefmt)
        return formatter.format(record)

def init_logger(log_level: int):
    color_formatter = ColorFormatter()

    handler = logging.StreamHandler()
    handler.setFormatter(color_formatter)

    root_logger = logging.getLogger()
    root_logger.setLevel(logging.DEBUG)
    root_logger.addHandler(handler)
    logging.basicConfig(level=log_level, format="%(asctime)s %(levelname)s %(message)s", datefmt="%Y-%m-%d %H:%M:%S")