python操作日志的封裝

前言

曾經轉載過一篇關於python日志模塊logging的詳解 https://www.cnblogs.com/linuxchao/p/linuxchao-log.html， 雖然這篇文章是別人寫的， 但是我就是靠着這篇文章入門的logging，所以我覺得沒必要再繼續說些理論的東西，今天就簡單的對日志做個封裝，實際工作中直接拿去用吧

方法1

"""
------------------------------------
@Time : 2019/5/22 8:12
@Auth : linux超
@File : logfile.py
@IDE  : PyCharm
@Motto: Real warriors,dare to face the bleak warning,dare to face the incisive error!
------------------------------------
"""
import logging


class Log(object):
    def __init__(self, name=__name__, path='mylog.log', level='DEBUG'):
        self.__name = name
        self.__path = path
        self.__level = level
        self.__logger = logging.getLogger(self.__name)
        self.__logger.setLevel(self.__level)

    def __ini_handler(self):
        """初始化handler"""
        stream_handler = logging.StreamHandler()
        file_handler = logging.FileHandler(self.__path, encoding='utf-8')
        return stream_handler, file_handler

    def __set_handler(self, stream_handler, file_handler, level='DEBUG'):
        """設置handler級別並添加到logger收集器"""
        stream_handler.setLevel(level)
        file_handler.setLevel(level)
        self.__logger.addHandler(stream_handler)
        self.__logger.addHandler(file_handler)

    def __set_formatter(self, stream_handler, file_handler):
        """設置日志輸出格式"""
        formatter = logging.Formatter('%(asctime)s-%(name)s-%(filename)s-[line:%(lineno)d]'
                                      '-%(levelname)s-[日志信息]: %(message)s',
                                      datefmt='%a, %d %b %Y %H:%M:%S')
        stream_handler.setFormatter(formatter)
        file_handler.setFormatter(formatter)

    def __close_handler(self, stream_handler, file_handler):
        """關閉handler"""
        stream_handler.close()
        file_handler.close()

    @property
    def Logger(self):
        """構造收集器，返回looger"""
        stream_handler, file_handler = self.__ini_handler()
        self.__set_handler(stream_handler, file_handler)
        self.__set_formatter(stream_handler, file_handler)
        self.__close_handler(stream_handler, file_handler)
        return self.__logger


if __name__ == '__main__':
    log = Log(__name__, 'file.log')
    logger = log.Logger
    logger.debug('I am a debug message')
    logger.info('I am a info message')
    logger.warning('I am a warning message')
    logger.error('I am a error message')
    logger.critical('I am a critical message')

初始化方法參數說明

name：自定義日志的名字， 默認是root， 但是我這里是使用調用文件的__name__ 作為默認名字

path：生成的日志的文件名

level：日志的級別，我這里把所有的級別都默認設置了level=DEBUG

方法2

使用logging.fileconfig這個模塊實現(不知道這個模塊的找度娘惡補一下把)

1.使用配置文件構造日志配置信息

logger.ini

[loggers]
keys = root, example01, example02
[logger_root]
level = DEBUG
handlers = hand01, hand02
[logger_example01]
handlers = hand01, hand02
qualname = example01
propagate = 0
[logger_example02]
handlers = hand01, hand03
qualname = example02
propagate = 0
[handlers]
keys = hand01, hand02, hand03
[handler_hand01]
class = StreamHandler
level = INFO
formatter = form01
args=(sys.stdout, )
[handler_hand02]
class = FileHandler
level = DEBUG
formatter = form01
args = ('log/test_case_log.log', 'a')
[handler_hand03]
class = handlers.RotatingFileHandler
level = INFO
formatter = form01
args = ('log/test_case_log.log', 'a', 10*1024*1024,3)
[formatters]
keys = form01, form02
[formatter_form01]
format = %(asctime)s-%(filename)s-[line:%(lineno)d]-%(levelname)s-[LogInfoMessage]: %(message)s
datefmt = %a, %d %b %Y %H:%M:%S
[formatter_form02]
format = %(name)-12s: %(levelname)-8s-[日志信息]: %(message)s
datefmt = %a, %d %b %Y %H:%M:%S

封裝python代碼

"""
------------------------------------
@Time : 2019/5/22 9:37
@Auth : linux超
@File : Log.py
@IDE  : PyCharm
@Motto: Real warriors,dare to face the bleak warning,dare to face the incisive error!
------------------------------------
"""
import logging
from logging import config


class MyLog(object):

    def __init__(self):
        config.fileConfig('logger.ini')
        self.logger = logging.getLogger('example01')

    @property
    def my_logger(self):

        return self.logger

if __name__ == '__main__':
    log = MyLog()
    log.my_logger.info('it is my test log message info')

總結

兩種方法各有好處吧

第一種代碼很好理解思路清晰 ， 但是不利於項目都維護，比如日志文件名，日志格式等無法修改，只能通過代碼內部修改

第二種其實是使用config模塊內部使用配置文件操作模塊ConfigParser做了封裝， 用配置文件來構造自定義日志器，好處很明顯，我們只要通過修改配置文件就能修改日志的格式，名字，級別等等一些設置，無需改動代碼，而且使用很簡單， 其實這種方法完全不需要封裝一個python代碼，哪個模塊需要輸出日志，直接調用config模塊獲得logger就可以了(就是上面文件的那幾行代碼)，今天就到這吧......