python 自定义logging模块

在测试项目中，对于log可能有一些自定义操作，需要在原来logging的基础上封装修改，以下展示常用的修改示例

import logging
import colorlog
import sys



class Log:

    def __init__(self, name=None, log_level=logging.DEBUG):
        # 日志格化字符串
        console_fmt = '%(log_color)s%(asctime)s-%(threadName)s-%(filename)s-[line:%(lineno)d]-%(levelname)s: %(message)s'
        file_fmt = '%(asctime)s-%(threadName)s-%(filename)s-[line:%(lineno)d]-%(levelname)s: %(message)s'

        # 控制台输出不同级别日志颜色设置
        color_config = {
            'DEBUG': 'cyan',
            'INFO': 'green',
            'WARNING': 'yellow',
            'ERROR': 'red',
            'CRITICAL': 'purple',
        }
        # 获取logger对象
        self.logger = logging.getLogger(name)

        # 指定最低日志级别：（critical > error > warning > info > debug）
        self.logger.setLevel(log_level)

        console_formatter = colorlog.ColoredFormatter(fmt=console_fmt, log_colors=color_config)
        file_formatter = logging.Formatter(fmt=file_fmt)

        # 输出到控制台
        console_handler = logging.StreamHandler()
        # 输出到文件
        file_handler = logging.FileHandler(filename=name, mode='a', encoding='utf-8')


        # 设置日志格式
        console_handler.setFormatter(console_formatter)
        file_handler.setFormatter(file_formatter)

        # 处理器设置日志级别，不同处理器可各自设置级别，默认使用logger日志级别
        # console_handler.setLevel(logging.WARNING)
        file_handler.setLevel(logging.INFO)  # 只有error和critical级别才会写入日志文件

        # logger添加处理器
        # 避免重复打印日志
        if not self.logger.handlers:
            self.logger.addHandler(console_handler)
            self.logger.addHandler(file_handler)

    def add_handler(self, custom_handler):
        # 添加自定义的handler,示例如 下文中add_handler()
        custom_handler.setFormatter(logging.Formatter('%(asctime)s-%(threadName)s-%(filename)s-[line:%(lineno)d]-%(levelname)s: %(message)s'))

        self.logger.addHandler(custom_handler)

    def debug(self, message):
        self.logger.debug(message)

    def info(self, message):
        self.logger.info(message)

    def warning(self, message):
        self.logger.warning(message)

    def error(self, message):
        self.logger.error(message)

    def critical(self, message):
        self.logger.critical(message)


log = Log(name='log.txt', log_level=logging.INFO)

if __name__ == '__main__':
    # 控制台只会显示warning及以上级别日志信息，而log.txt文件中则会记录error及以上级别日志信息
    # log = Log(name='logtest.txt', log_level=logging.INFO)
    log.debug('debug')
    log.info('info')
    log.warning('warning')
    log.error('error')
    log.critical('critical')

    print("test Print")

add_handler()示例

import logging
from logconfig import log
import eventlet
from flask_socketio import SocketIO, emit, send
import re

async_mode = 'eventlet'
app = Flask(__name__)

app.secret_key = 'supersecretkey'  # 需要设置sercet key来 加密flash消息
app.config["SESSION_REFRESH_EACH_REQUEST"] = True
socketio = SocketIO(app, async_mode=async_mode)  # 明确指定使用eventlet

class WebSocketLogHandler(logging.Handler):
    def emit(self, record):
        log_msg = self.format(record)
        pattern = r'-[A-Z]+:'
        log_type = re.findall(pattern, log_msg)[0][1:-1]
        socketio.emit('log_message', {'msg': log_msg, 'type': log_type})

# 这里添加自定义的WebSocketLogHandler，是为了将log打印输出到socketio中，以满足自定义需求
log.add_handler(WebSocketLogHandler())