失眠网 > Python 将日志输出到控制台写入文件根据不同日志级别打印不同颜色的日志

Python 将日志输出到控制台写入文件根据不同日志级别打印不同颜色的日志

时间：2021-06-08 05:08:32

参考链接：/A/RnJWbDaBzq/

代码

__all__ = ['get_logger', 'set_logger', 'debug', 'info', 'warning', 'error', 'critical']import warningsimport loggingfrom logging import Formatterimport threadingimport osimport abcimport sixDEFAULT_FMT = '%(asctime)s - %(levelname)-10s %(pathname)s[line:%(lineno)d] - %(message)s'DEFAULT_DATE_FMT = '%Y-%m-%d %H:%M:%S'DEFAULT_LEVEL = 'DEBUG'def get_logger(loggername='root', cmdlog=True, filelog=True, filename='./log/app.log', filemode='a', colorful=True,cmd_color_dict=None, cmdlevel='DEBUG', cmdfmt=DEFAULT_FMT, cmddatefmt=DEFAULT_DATE_FMT,filelevel='INFO', filefmt=DEFAULT_FMT, filedatefmt=DEFAULT_DATE_FMT,propagate=False, backup_count=0, limit=10240, when=None):if not loggername:warnings.warn("'loggername' attribute must not be empty str.\n" +"Changed to 'root' by default.")loggername = 'root'return Logger.get_logger(**locals())@six.add_metaclass(abc.ABCMeta)class Color():'''The abstract base class of all color classes'''@abc.abstractclassmethoddef get_color_by_str(cls):'''get all the color names'''pass@abc.abstractclassmethoddef get_all_colors(cls, color_str):'''return color of given color_str'''pass@abc.abstractclassmethoddef get_color_set(cls):''' return a set contains the name of all the colors'''passclass WindowsCmdColor(Color):'''Windows Cmd color support'''STD_OUTPUT_HANDLE = -11'''Windows CMD命令行前景字体颜色'''FOREGROUND_BLACK = 0x00 # black.FOREGROUND_DARKBLUE = 0x01 # dark blue.FOREGROUND_DARKGREEN = 0x02 # dark green.FOREGROUND_DARKSKYBLUE = 0x03 # dark skyblue.FOREGROUND_DARKRED = 0x04 # dark red.FOREGROUND_DARKPINK = 0x05 # dark pink.FOREGROUND_DARKYELLOW = 0x06 # dark yellow.FOREGROUND_DARKWHITE = 0x07 # dark white.FOREGROUND_DARKGRAY = 0x08 # dark gray.FOREGROUND_BLUE = 0x09 # blue.FOREGROUND_GREEN = 0x0a # green.FOREGROUND_SKYBLUE = 0x0b # skyblue.FOREGROUND_RED = 0x0c # red.FOREGROUND_PINK = 0x0d # pink.FOREGROUND_YELLOW = 0x0e # yellow.FOREGROUND_WHITE = FOREGROUND_RESET = 0x0f # white and reset'''# Windows CMD命令行背景颜色'''BACKGROUND_DARKBLUE = 0x10 # dark blue.BACKGROUND_GREEN = 0x20 # dark green.BACKGROUND_DARKSKYBLUE = 0x30 # dark skyblue.BACKGROUND_DARKRED = 0x40 # dark red.BACKGROUND_DARKPINK = 0x50 # dark pink.BACKGROUND_DARKYELLOW = 0x60 # dark yellow.BACKGROUND_DARKWHITE = 0x70 # dark white.BACKGROUND_DARKGRAY = 0x80 # dark gray.BACKGROUND_BLUE = 0x90 # blue.BACKGROUND_GREEN = 0xa0 # green.BACKGROUND_SKYBLUE = 0xb0 # skyblue.BACKGROUND_RED = 0xc0 # red.BACKGROUND_PINK = 0xd0 # pink.BACKGROUND_YELLOW = 0xe0 # yellow.BACKGROUND_WHITE = 0xf0 # white.# color names to escape strings__COLOR_2_STR = {'red': FOREGROUND_RED,'green': FOREGROUND_GREEN,'yellow': FOREGROUND_YELLOW,'blue': FOREGROUND_BLUE,'pink': FOREGROUND_PINK,'black': FOREGROUND_BLACK,'gray': FOREGROUND_DARKGRAY,'white': FOREGROUND_WHITE,'reset': FOREGROUND_RESET,}__COLORS = __COLOR_2_STR.keys()__COLOR_SET = set(__COLORS)if os.name == 'nt':import ctypes__cmd_output_handle = ctypes.windll.kernel32.GetStdHandle(STD_OUTPUT_HANDLE) # get std output handle__cmd_color_setter = ctypes.windll.kernel32.SetConsoleTextAttribute # set color by handle@classmethoddef windows_cmd_color_wrapper(cls, logger, level, color):def wrapper(msg, *args, **kw):if logger.isEnabledFor(level):cls.__cmd_color_setter(cls.__cmd_output_handle, cls.get_color_by_str(color))logger._log(level, msg, args, **kw)cls.__cmd_color_setter(cls.__cmd_output_handle, cls.get_color_by_str('reset'))return Nonereturn wrapper@classmethoddef get_color_by_str(cls, color_str):'''return color of given color_str'''if not isinstance(color_str, str):raise TypeError("color string must str, but type: '%s' passed in." % type(color_str))color = color_str.lower()if color not in cls.__COLOR_SET:raise ValueError("no such color: '%s'" % color)return cls.__COLOR_2_STR[color]@classmethoddef get_all_colors(cls):''' return a list that contains all the color names '''return cls.__COLORS@classmethoddef get_color_set(cls):''' return a set contains the name of all the colors'''return cls.__COLOR_SETclass LinuxCmdColor(Color):'''Linux Cmd color support'''# color names to escape strings__COLOR_2_STR = {'red': '\033[1;31m','green': '\033[1;32m','yellow': '\033[1;33m','blue': '\033[1;34m','pink': '\033[1;35m','cyan': '\033[1;36m','gray': '\033[1;37m','white': '\033[1;38m','reset': '\033[1;0m',}__COLORS = __COLOR_2_STR.keys()__COLOR_SET = set(__COLORS)@classmethoddef get_color_by_str(cls, color_str):'''return color of given color_str'''if not isinstance(color_str, str):raise TypeError("color string must str, but type: '%s' passed in." % type(color_str))color = color_str.lower()if color not in cls.__COLOR_SET:raise ValueError("no such color: '%s'" % color)return cls.__COLOR_2_STR[color]@classmethoddef get_all_colors(cls):''' return a list that contains all the color names '''return cls.__COLORS@classmethoddef get_color_set(cls):''' return a set contains the name of all the colors'''return cls.__COLOR_SETclass BasicFormatter(Formatter):def __init__(self, fmt=None, datefmt=None):super(BasicFormatter, self).__init__(fmt, datefmt)self.default_level_fmt = '[%(levelname)s]'def formatTime(self, record, datefmt=None):''' @override logging.Formatter.formatTimedefault case: microseconds is addedotherwise: add microseconds mannually'''asctime = Formatter.formatTime(self, record, datefmt=datefmt)return self.default_msec_format % (asctime, record.msecs) if datefmt else asctimedef format(self, record):''' @override logging.Formatter.formatgenerate a consistent format'''msg = Formatter.format(self, record)pos1 = self._fmt.find(self.default_level_fmt) # return -1 if not findpos2 = pos1 + len(self.default_level_fmt)if pos1 > -1:last_ch = self.default_level_fmt[-1]repeat = self._get_repeat_times(msg, last_ch, 0, pos2)pos1 = self._get_index(msg, last_ch, repeat)return '%-10s%s' % (msg[:pos1], msg[pos1 + 1:])else:return msgdef _get_repeat_times(self, string, sub, start, end):cnt, pos = 0, startwhile 1:pos = string.find(sub, pos)if pos >= end or pos == -1:breakcnt += 1pos += 1return cntdef _get_index(self, string, substr, times):pos = 0while times > 0:pos = string.find(substr, pos) + 1times -= 1return posclass CmdColoredFormatter(BasicFormatter):'''Cmd Colored Formatter Class'''# levels list and set__LEVELS = ['NOTSET', 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']__LEVEL_SET = set(__LEVELS)def __init__(self, fmt=None, datefmt=None, **level_colors):super(CmdColoredFormatter, self).__init__(fmt, datefmt)self.LOG_COLORS = {} # a dict, used to convert log level to colorself.init_log_colors()self.set_level_colors(**level_colors)def init_log_colors(self):''' initialize log config '''for lev in CmdColoredFormatter.__LEVELS:self.LOG_COLORS[lev] = '%s'def set_level_colors(self, **kwargs):''' set each level different colors '''lev_set = CmdColoredFormatter.__LEVEL_SETcolor_set = WindowsCmdColor.get_color_set() if os.name == 'nt' else LinuxCmdColor.get_color_set()# check log level and set colorsfor lev, color in kwargs.items():lev, color = lev.upper(), color.lower()if lev not in lev_set:raise KeyError("log level '%s' does not exist" % lev)if color not in color_set:raise ValueError("log color '%s' does not exist" % color)self.LOG_COLORS[lev] = '%s' if os.name == 'nt' else ''.join([LinuxCmdColor.get_color_by_str(color), \'%s', LinuxCmdColor.get_color_by_str('reset')])def format(self, record):''' @override BasicFormatter.format'''msg = super(CmdColoredFormatter, self).format(record)# msg = BasicFormatter.format(self, record)# 本行和上一行等价return self.LOG_COLORS.get(record.levelname, '%s') % msgclass Logger():''' My logger '''# log related arguments__LOG_ARGS = ['cmdlog', 'cmd_color_dict', 'filelog', 'filename', 'filemode', 'colorful', 'cmdlevel', 'loggername','cmdfmt', 'cmddatefmt', 'filelevel', 'filefmt', 'filedatefmt', 'backup_count', 'limit', 'when','propagate']__log_arg_set = set(__LOG_ARGS)__lock = threading.Lock()__name2logger = {}@classmethoddef _acquire_lock(cls):cls.__lock.acquire()@classmethoddef _release_lock(cls):cls.__lock.release()@classmethoddef get_logger(cls, **kwargs):loggername = kwargs['loggername']if loggername not in cls.__name2logger:cls._acquire_lock() # lock current threadif loggername not in cls.__name2logger:log_obj = object.__new__(cls)cls.__init__(log_obj, **kwargs)cls.__name2logger[loggername] = log_objcls._release_lock() # release lockreturn cls.__name2logger[loggername]def set_logger(self, **kwargs):''' Configure logger with dict settings '''for k, v in kwargs.items():if k not in Logger.__log_arg_set:raise KeyError("config argument '%s' does not exist" % k)setattr(self, k, v) # add instance attributes# preprocess argsself.__arg_preprocessor()self.__init_logger()self.__import_log_func()if self.cmdlog:self.__add_streamhandler()if self.filelog:self.__add_filehandler()def __arg_preprocessor(self):if not self.cmd_color_dict:self.cmd_color_dict = {'debug': 'green', 'warning': 'yellow', 'error': 'red', 'critical': 'pink'}if isinstance(self.cmdlevel, str):self.cmdlevel = getattr(logging, self.cmdlevel.upper(), logging.DEBUG)if isinstance(self.filelevel, str):self.filelevel = getattr(logging, self.filelevel.upper(), logging.INFO)def __init__(self, **kwargs):self.logger = Noneself.streamhandler = Noneself.filehandler = Noneself.set_logger(**kwargs)def __init_logger(self):''' Init logger or reload logger '''if not self.logger:self.logger = logging.getLogger(self.loggername)else:logging.shutdown()self.logger.handlers.clear()self.streamhandler = Noneself.filehandler = Noneself.logger.setLevel(DEFAULT_LEVEL)def __import_log_func(self):''' Add common functions into current class'''func_names = ['debug', 'info', 'warning', 'error', 'critical', 'exception']for fn in func_names:# Windows cmd color supportif os.name == 'nt' and self.colorful and fn in self.cmd_color_dict:level = getattr(logging, fn.upper())f = WindowsCmdColor.windows_cmd_color_wrapper(self.logger, level, self.cmd_color_dict[fn])else:f = getattr(self.logger, fn)setattr(self, fn, f)def __path_preprocess(self):# calculate path according to the location of logger.pypar_path, file_name = os.path.split(self.filename)cur_par, _ = os.path.split(__file__)dir_path = os.path.join(cur_par, par_path)path = os.path.join(dir_path, file_name)if not os.path.exists(dir_path): # create dir if neccessaryos.makedirs(dir_path)if not os.path.exists(path): # create file if neccessaryopen(path, self.filemode).close()self.filename = os.path.abspath(path)def __add_filehandler(self):''' Add a file handler to logger '''# path preprocessself.__path_preprocess()# Filehandlerif self.backup_count == 0:self.filehandler = logging.FileHandler(self.filename, self.filemode)# RotatingFileHandlerelif not self.when:self.filehandler = logging.handlers.RotatingFileHandler(self.filename,self.filemode, self.limit, self.backup_count)# TimedRotatingFileHandlerelse:self.filehandler = logging.handlers.TimedRotatingFileHandler(self.filename,self.when, 1, self.backup_count)formatter = BasicFormatter(self.filefmt, self.filedatefmt)self.filehandler.setFormatter(formatter)self.filehandler.setLevel(self.filelevel)self.logger.addHandler(self.filehandler)def __add_streamhandler(self):''' Add a stream handler to logger '''self.streamhandler = logging.StreamHandler()self.streamhandler.setLevel(self.cmdlevel)formatter = CmdColoredFormatter(self.cmdfmt, self.cmddatefmt,**self.cmd_color_dict) if self.colorful else BasicFormatter(self.cmdfmt,self.cmddatefmt)self.streamhandler.setFormatter(formatter)self.logger.addHandler(self.streamhandler)if __name__ == '__main__':print("logger测试")log = get_logger(colorful=True, filename=r'log/app.log')log.set_logger(propagate=True)log.debug('原谅绿')log.info('info白')log.warning("提高log等级到warning, loggername为'log'")log.set_logger(cmdlevel='warning', loggername='log')log.info('不存在的一句话')log.warning("我怎么黄了!!!")log.error("我的天哪")log.set_logger(colorful=False)log.critical("没有颜色的红得发紫!!!!!!!")log.warning("修改log等级为debug")log.set_logger(cmdlevel='debug')log.set_logger(colorful=True)log.critical("红得发紫!!!!!!!")log.debug("修改debug颜色配置为灰色")log.set_logger(cmd_color_dict={'debug': 'gray'})log.debug('修改完成')print("同名时单例模式测试")log.set_logger(cmdlevel='error')# log = get_logger()log.debug("呵呵大1")log.debug("调整cmd输出format为: %s" % '%a, %H:%M:%S')log2 = get_logger(cmddatefmt='%a, %H:%M:%S')log2.debug("呵呵大2")log.debug("id 检测: log:%s log2:%s" % (id(log), id(log2)))log.debug("相等性检测: log is log2 %s" % (log is log2))print("不同名时非单例测试")log3 = get_logger(loggername='test_logger3')log3.debug("呵呵大3")# 测试propagatelog3.debug('propagate 属性为 %r 时' % log3.propagate)log3.set_logger(propagate=True)log3.error('propagate 属性为 %r 时' % log3.propagate)