logging库——python版的glog日志

使用过c++版本的glog日志记录后，发现日志分级和随时可以切换输出到log文件与终端的功能非常方便，就想着python是否也有类似的功能呢？搜索之后发现的确有这样的一个库，那就是python的logging库。

1. 安装

朴实无华的安装

pip install logging

2. 日志等级

logging分为六种日志级别，设置显示等级时，会包括所有大于等级设置等级的信息：
NOTSET(0)：全部日志
DEBUG(10)：用于调试信息
INFO(20)：用于通知信息
WARNING(30)：用于警告信息
ERROR(40)：用于错误信息
CRITICAL(50)：严重错误，程序无法继续运行

3. 快速使用

一种简单快速使用日志功能的方法，能够自定义日志输出格式和时间戳显示格式，自定义日志的等级。

import logging
# 配置日志输出模式
logging.basicConfig(format="%(asctime)s.%(msecs)03d|%(name)s|%(levelname)s|%(message)s", datefmt="%Y/%m/%d %H:%M:%S",level=logging.INFO)

logging.info("hi")

4. 同时输出到日志文件和终端

注：该方法不要与上一个快速使用方法同时使用，否则会造成重复的log信息在终端上打印两遍！

import time
import shutil
import logging
import os

# 初始化logging模块设定
# 输入：log存储路径，是否先清空该路径
def init_logging(log_dir, remove_old_log=False):
    # 是否清空旧日志
    if os.path.exists(log_dir) and remove_old_log:
        shutil.rmtree(log_dir)
    # 创建输出文件夹
    os.makedirs(log_dir, exist_ok=True)

    local_time = time.localtime()
    log_name = f"{local_time[0]:04d}-{local_time[1]:02d}-{local_time[2]:02d}-{local_time[3]:02d}-" \
        + f"{local_time[4]:02d}-{local_time[5]:02d}.log"
    # 输出的日志文件用时间命名
    log_path = os.path.join(log_dir, log_name)

    """
    logger的level决定了你可以处理的最低级别的日志。
    如果一个logger的level被设置为INFO，那么所有DEBUG级别的日志消息都会被logger忽略，不会传递给它的handler。
    handler的level则是在logger级别的基础上，进一步过滤日志。
    比如，即使logger的level被设置为DEBUG，但是如果一个handler的level被设置为WARNING，那么这个handler就只会处理WARNING、ERROR和CRITICAL级别的日志。
    如果需求比较简单，比如所有级别的日志都输出到同一个地方，那么可以只设置logger的level，并使用默认的handler（默认的level是NOTSET，即接收所有日志）
    """
    # 对全局的logging修改配置
    logger = logging.getLogger()
    logger.setLevel(logging.DEBUG)  # 设置日志级别

    # 创建一个handler，用于写入日志文件
    file_handler = logging.FileHandler(log_path)
    file_handler.setLevel(logging.INFO)

    # 再创建一个handler，用于输出到控制台
    console_handler = logging.StreamHandler()
    console_handler.setLevel(logging.INFO)

    # 定义handler的输出格式
    formatter = logging.Formatter("%(asctime)s.%(msecs)03d|%(name)s|%(levelname)s|%(message)s", datefmt="%Y/%m/%d %H:%M:%S")
    
    # 设置为北京时区
    def beijing(sec):
        if time.strftime('%z') == "+0800":
            return datetime.datetime.now().timetuple()
        return (datetime.datetime.now() + datetime.timedelta(hours=8)).timetuple()
    formatter.converter = beijing
    
    file_handler.setFormatter(formatter)
    console_handler.setFormatter(formatter)

    # 给logger添加handler
    logger.addHandler(file_handler)
    logger.addHandler(console_handler)