欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

python自定义logging模块,实现颜色控制、同时输出到控制台和日志文件中

程序员文章站 2022-07-15 15:54:37
...

自定义logging模块,实现颜色控制、同时输出到控制台和日志文件中

通过基于logging的自定义日志类,实现日志颜色控制、并且将日志同时输出到控制台和日志文件中
日志模块:log_setting.py

import logging
from logging.handlers import RotatingFileHandler # 按文件大小滚动备份
import colorlog
import os
import time
import datetime

class Log:
    def __init__(self):
        # 生成日志文件夹
        cur_path = os.path.dirname(os.path.realpath(__file__))  # log_path是存放日志的路径
        self.log_path = os.path.join(cur_path, 'logs')
        if not os.path.exists(self.log_path): os.mkdir(self.log_path)  # 如果不存在这个logs文件夹,就自动创建一个
        # 生成日志名称
        self.logName = os.path.join(self.log_path, '%s.log' % time.strftime('%Y-%m-%d'))  # 文件的命名
        # 生成logger
        self.logger = logging.getLogger('ROOT')
        self.logger.setLevel(logging.DEBUG)
        # 生成formatter
        self.log_colors_config = {
            'DEBUG': 'green',
            'INFO': 'white',
            'WARNING': 'yellow',
            'ERROR': 'red',
            'CRITICAL': 'red',
        }
        self.formatter = colorlog.ColoredFormatter(
            '%(log_color)s[%(asctime)s] [%(filename)s:%(lineno)d] [%(module)s:%(funcName)s] [%(levelname)s]- %(message)s',
            log_colors=self.log_colors_config)  # 日志输出格式
        # 处理日志文件夹下过期的日志,以及控制日志文件的数量
        self.handle_logs()

        # 创建一个StreamHandler,用于输出到控制台
        stream_handler = logging.StreamHandler()
        stream_handler.setLevel(logging.DEBUG)
        stream_handler.setFormatter(self.formatter)
        self.logger.addHandler(stream_handler)

        # 创建一个FileHandler,用于写到本地
        fh = RotatingFileHandler(filename=self.logName, mode='a', maxBytes=1024 * 1024 * 5, backupCount=5,
                                 encoding='utf-8')  # 使用RotatingFileHandler类,滚动备份日志
        fh.setLevel(logging.DEBUG)
        fh.setFormatter(self.formatter)
        self.logger.addHandler(fh)


    def get_file_sorted(self):
        """最后修改时间顺序升序排列 os.path.getmtime()->获取文件最后修改时间"""
        dir_list = os.listdir(self.log_path)
        if not dir_list:
            return
        else:
            dir_list = sorted(dir_list, key=lambda x: os.path.getmtime(os.path.join(self.log_path, x)))
            return dir_list

    def TimeStampToTime(self, timestamp):
        """格式化时间"""
        timeStruct = time.localtime(timestamp)
        return str(time.strftime('%Y-%m-%d', timeStruct))

    def handle_logs(self):
        """处理日志过期天数和文件数量"""
        dir_list = [self.log_path]  # 要删除文件的目录名
        for dir in dir_list:
            dirPath = dir  # 拼接删除目录完整路径
            file_list = self.get_file_sorted()  # 返回按修改时间排序的文件list
            if file_list:  # 目录下没有日志文件
                for i in file_list:
                    file_path = os.path.join(dirPath, i)  # 拼接文件的完整路径
                    t_list = self.TimeStampToTime(os.path.getctime(file_path)).split('-')
                    now_list = self.TimeStampToTime(time.time()).split('-')
                    t = datetime.datetime(int(t_list[0]), int(t_list[1]),
                                          int(t_list[2]))  # 将时间转换成datetime.datetime 类型
                    now = datetime.datetime(int(now_list[0]), int(now_list[1]), int(now_list[2]))
                    if (now - t).days > 30:  # 创建时间大于30天的文件删除
                        self.delete_logs(file_path)
                if len(file_list) > 30:  # 限制目录下记录文件数量为30个
                    file_list = file_list[0:-4]
                    for i in file_list:
                        file_path = os.path.join(dirPath, i)
                        print(file_path)
                        self.delete_logs(file_path)

    def delete_logs(self, file_path):
        try:
            os.remove(file_path)
        except PermissionError as e:
            Log().warning('删除日志文件失败:{}'.format(e))

    def returnLogger(self):
        # 返回logger句柄
        return self.logger

log = Log().returnLogger()

其它程序中,调用日志模块的方式:

from log_setting import log

log.info(res.stderr)
相关标签: python logging