学习笔记-logging模块

1. 简介

Python的logging模块提供了通用的日志系统，可以方便第三方模块或者是应用使用。这个模块提供不同的日志级别，并可以采用不同的方式记录日志，比如文件，HTTP GET/POST，SMTP，Socket等，甚至可以自己实现具体的日志记录方式。模块提供logger，handler，filter，formatter

1.1 logger

提供日志接口，供应用代码使用。logger最长用的操作有两类：配置和发送日志消息。可以通过logging.getLogger(name)获取logger对象，如果不指定name则返回root对象，多次使用相同的name调用getLogger方法返回同一个logger对象。

1.2 hander

将日志记录（log record）发送到合适的目的地（destination），比如文件，socket等。一个logger对象可以通过addHandler方法添加0到多个handler，每个handler又可以定义不同日志级别，以实现日志分级过滤显示。

1.3 filter

提供一种优雅的方式决定一个日志记录是否发送到handler。

1.4 formatter

** 指定日志记录输出的具体格式。formatter的构造方法需要两个参数：消息的格式字符串和日期字符串，这两个参数都是可选的。**

2. 初始化logger

import logging
logger =logging.getLogger("simple_example") #模块名
# 设置级别 logger.setLevel(logging.DEBUG),Logging中有NOTSET < DEBUG < INFO < WARNING < ERROR < CRITICAL这几种级别，日志会记录设置级别以上的日志
logger.setLevel(logging.DEBUG)
# 建立一个filehandler来把日志记录在文件里，级别为debug以上
fh = logging.FileHandler("spam.log")
fh.setLevel(logging.DEBUG)
 # 建立一个streamhandler来把日志打在CMD窗口上，级别为error以上
 ch = logging.StreamHandler()
 ch.setLevel(logging.ERROR)
# 设置日志格式
formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
ch.setFormatter(formatter)
fh.setFormatter(formatter)
#将相应的handler添加在logger对象中
logger.addHandler(ch)
logger.addHandler(fh)
# 开始打日志
logger.debug("debug message")
logger.info("info message")
logger.warn("warn message")
logger.error("error message")
logger.critical("critical message")

3. 示例

    def _console(self,loglevel,message):
        '
        设置控制台与日志输出信息
        :param loglevel: 日志等级
        :param message: 日志信息
        '
        #FileHandler用于本地日志输出
        fh=logging.FileHandler(self.logfile,'a',encoding='utf-8')
        fh.setLevel(logging.DEBUG)
        fh.setFormatter(self.format)
        self.logger.addHandler(fh)

        #StreamHandler用于控制台输出
        sh=logging.StreamHandler()
        sh.setLevel(logging.DEBUG)
        sh.setFormatter(self.format)
        self.logger.addHandler(sh)

        #通过判断level输出
        if loglevel=='info':
            # self.logger.info("".join(["run:",message]))
            self.logger.info('run:{}'.format(message))
        elif loglevel=='debug':
            self.logger.debug("".join(["run:",message]))
        elif loglevel=='warning':
            self.logger.warning("".join(["run:",message]))
        elif loglevel=='error':
            self.logger.error("".join((["run:",message])))

        #避免日志输出重复
        self.logger.removeHandler(sh)
        self.logger.removeHandler(fh)

        #关闭打开的文件
        fh.close()

    def info(self,message):
        '''
        输出info信息
        :param message: 日志信息
        '''
        self._console('info',message)

    def debug(self,message):
        '''
        输出debug信息
        :param message: 日志信息
        '''
        self._console('debug',message)

    def warning(self,message):
        '''
        输出warning信息
        :param message: 日志信息
        '''
        self._console('warning',message)

    def error(self,message):
        '''
        输出error信息
        :param message: 日志信息
        '''
        self._console('error',message)

    def _nowtime(self):
        '''获取当前时间'''
        nowtime=time.strftime("%Y%m%d")
        return nowtime

4. Formatters

Formatter对象设置日志信息最后的规则、结构和内容，默认的时间格式为%Y-%m-%d %H:%M:%S，下面是Formatter常用的一些信息