logging模块
logging模块是Python内置的标准模块,主要用于输出运行日志,可以设置输出日志的等级、日志保存路径、日志文件回滚等;相比print,具备如下优点:
- 可以通过设置不同的日志等级,在release版本中只输出重要信息,而不必显示大量的调试信息;
- print将所有信息都输出到标准输出中,严重影响开发者从标准输出中查看其它数据;
- logging则可以由开发者决定将信息输出到什么地方,以及怎么输出;
日志等级
日志等级由上至下依次递增
级别 | 含义 |
---|---|
DEBUG | 调试时的详细信息 |
INFO | 正常运行的信息 |
WARNING | 警告信息,可能现在或未来会发生问题(如磁盘满了) |
ERRO | 严重问题,软件部分功能停止运行 |
CRITICAL | 严重错误,软件已经不能运行了 |
import logging
logging.debug('debug message')
logging.info('info message')
logging.warn('warn message')
logging.error('error message')
logging.critical('critical message')
标准输出(屏幕)未显示任何信息,发现当前工作目录下生成了logger.log,内容如下:
INFO:root:info message
WARNING:root:warn message
ERROR:root:error message
CRITICAL:root:critical message
Logger、Hander、Formatter、Filter
- Logger 记录器,暴露了应用程序代码能直接使用的接口。
- Handler 处理器,将(记录器产生的)日志记录发送至合适的目的地。
- Filter 过滤器,提供了更好的粒度控制,它可以决定输出哪些日志记录。
- Formatter 格式化器,指明了最终输出中日志记录的布局。
Logger记录器
Logger是一个树形层级结构,在使用接口debug,info,warn,error,critical之前必须创建Logger实例,即创建一个记录器,如果没有显式的进行创建,则默认创建一个root logger,并应用默认的日志级别(WARN),处理器Handler(StreamHandler,即将日志信息打印输出在标准输出上),和格式化器Formatter(默认的格式即为第一个简单使用程序中输出的格式)。
# 创建logger实例
logger = logging.getLogger(logger_name) # logger_name即存储的日志文件名
# 创建实例后,需要进行日志级别设置并增加处理Handler
logger.setLevel(logging.ERROR) # 设置日志级别为ERROR
logger.addHandler(handler_name) # 为Logger实例增加一个处理器
logger.removeHandler(handler_name) # 为Logger示例删除一个处理器
Hanlder处理器
Handler处理器类型有很多种,比较常用的有三个,StreamHandler,FileHandler,NullHandler
StreamHandler
流Handler,能够将日志信息输出到sys.stdout,sys.stderr或者类文件对象(确切来说就是能够支持write()和flush()方法的对象)
# 日志信息会输出到指定的stream中,若为空默认输出到sys.stderr
sh = logging.StreamHanlder(stream=None)
FileHandler
继承自StreamHandler,将日志信息输出到磁盘文件上
# 模式默认为append,delay为true时,文件直到emit方法被执行才会打开。默认情况下,日志文件可以无限大
fh = logging.FileHandler(filename,mode='a',encoding=None,delay=False)
NullHandler
空操作的handler,没有参数
Formatter格式化器
使用Formatter对象设置日志信息最后的规则、结构和内容,默认的时间格式为 %Y-%m-%d %H:%M:%S
# fmt是消息的格式化字符串,datefmt是日期字符串。
# 如果不指明fmt,将使用'%(message)s'。如果不指明datefmt,将使用ISO8601日期格式。
formatter = logging.Formatter(fmt=None.datefmt=None)
Filter过滤器
Handlers和Loggers可以使用Filters来完成比级别更复杂的过滤。Filter基类只允许特定Logger层次以下的事件。例如用’A.B’初始化的Filter允许Logger’A.B’,‘A.B.C’,‘A.B.C.D’, ‘A.B.D’等记录的事件,logger’A.C’, 'B.A.B’等就不行。
# 如果用空字符串初始化,表示所有事件都接受
filter = logging.Filter(name='')
树形层级结构的Logger
熟悉了这些概念之后,有另外一个比较重要的事情必须清楚,即Logger是一个树形层级结构:
- Logger可以包含一个或多个Handler和Filter,即Logger与Handler或Fitler是一对多的关系
- 一个Logger实例可以新增多个Handler,一个Handler可以新增多个格式化器或多个过滤器,而且日志级别将会继承
Logging工作流程
logging模块使用过程
- 第一次导入logging模块或使用reload函数重新导入logging模块,logging模块中的代码将被执行,这个过程中将产生logging日志系统的默认配置。
- 自定义配置(可选)。logging标准模块支持三种配置方式: dictConfig,fileConfig,listen。其中,dictConfig是通过一个字典进行配置Logger,Handler,Filter,Formatter;fileConfig则是通过一个文件进行配置;而listen则监听一个网络端口,通过接收网络数据来进行配置。当然,除了以上集体化配置外,也可以直接调用Logger,Handler等对象中的方法在代码中来显式配置。
- 使用logging模块的全局作用域中的getLogger函数来得到一个Logger对象实例(其参数即是一个字符串,表示Logger对象实例的名字,即通过该名字来得到相应的Logger对象实例)。
- 使用Logger对象中的debug,info,error,warn,critical等方法记录日志信息。
logging模块处理流程
- 判断日志的等级是否大于Logger对象的等级,如果大于,则往下执行,否则,流程结束。
- 产生日志。第一步,判断是否有异常,如果有,则添加异常信息。第二步,处理日志记录方法(如debug,info等)中的占位符,即一般的字符串格式化处理。
- 使用注册到Logger对象中的Filters进行过滤。如果有多个过滤器,则依次过滤;只要有一个过滤器返回假,则过滤结束,且该日志信息将丢弃,不再处理,而处理流程也至此结束。否则,处理流程往下执行。
- 在当前Logger对象中查找Handlers,如果找不到任何Handler,则往上到该Logger对象的父Logger中查找;如果找到一个或多个Handler,则依次用Handler来处理日志信息。但在每个Handler处理日志信息过程中,会首先判断日志信息的等级是否大于该Handler的等级,如果大于,则往下执行(由Logger对象进入Handler对象中),否则,处理流程结束。
- 执行Handler对象中的filter方法,该方法会依次执行注册到该Handler对象中的Filter。如果有一个Filter判断该日志信息为假,则此后的所有Filter都不再执行,而直接将该日志信息丢弃,处理流程结束。
- 使用Formatter类格式化最终的输出结果。注:Formatter同上述第2步的字符串格式化不同,它会添加额外的信息,比如日志产生的时间,产生日志的源代码所在的源文件的路径等等。
- 真正地输出日志信息(到网络,文件,终端,邮件等)。至于输出到哪个目的地,由Handler的种类来决定。
配置方式
- 显式创建记录器Logger、处理器Handler和格式化器Formatter,并进行相关设置;
- 通过简单方式进行配置,使用basicConfig()函数直接进行配置;
- 通过配置文件进行配置,使用fileConfig()函数读取配置文件;
- 通过配置字典进行配置,使用dictConfig()函数读取配置信息;
- 通过网络进行配置,使用listen()函数进行网络配置。