Logging——Python 的日志记录工具使用
Logging——Python 的日志记录工具
1.定义
logging模块,是Python内置的标准模块,主要用于输出运行日志,可以设置输出日志的等级、日志保存路径、日志文件回滚等;相比print,具备如下优点:
- 可以通过设置不同的日志等级,在release版本中只输出重要信息,而不必显示大量的调试信息;
- print将所有信息都输出到标准输出中,严重影响开发者从标准输出中查看其它数据;logging则可以由开发者决定将信息输出到什么地方,以及怎么输出;
2.简单使用
import logging
logging.debug('debug message')
logging.info('info message')
logging.warn('warn message')
logging.error('error message')
logging.critical('critical message')
输出:
WARNING:root:warn message
ERROR:root:error message
CRITICAL:root:critical message
默认情况下,logging模块将日志打印到屏幕上(stdout),日志级别为WARNING(即只有日志级别高于WARNING的日志信息才会输出)
日志格式如下图所示:
3.简单配置
3.1 日志级别
级别 | 何时使用 |
---|---|
DEBUG | 详细信息,典型地调试问题时会感兴趣。 |
INFO | 证明事情按预期工作。 |
WARNING | 表明发生了一些意外,或者不久的将来会发生问题(如‘磁盘满了’)。软件还是在正常工作。 |
ERROR | 由于更严重的问题,软件已不能执行一些功能了。 |
CRITICAL | 严重错误,表明软件已不能继续运行了。 |
3.2 简单配置
import logging
# 通过下面的方式进行简单配置输出方式与日志级别
logging.basicConfig(filename='logger.log', level=logging.INFO)
logging.debug('debug message')
logging.info('info message')
logging.warn('warn message')
logging.error('error message')
logging.critical('critical message')
输出:
INFO:root:info message
WARNING:root:warn message
ERROR:root:error message
CRITICAL:root:critical message
4.基础类和函数
该模块定义的基础类和函数都列在下面:
- Logger记录器,暴露了应用程序代码直接使用的接口。
- Handler 处理器,将日志记录(由记录器创建)发送到适当的目标。
- Filter 过滤器,提供了更精细的附加功能,用于确定要输出的日志记录。
- Formatter 格式化器,指定最终输出中日志记录的样式。
4.1 Logger记录器
Logger是一个树形层级结构,在使用接口debug,info,warn,error,critical之前必须创建Logger实例,即创建一个记录器
创建方法: logger = logging.getLogger(logger_name)
创建Logger实例后,可以使用以下方法进行日志级别设置,增加处理器Handler:
方法 | 作用 |
---|---|
logger.setLevel(logging.ERROR) | 设置日志级别为ERROR,即只有日志级别大于等于ERROR的日志才会输出 |
logger.addHandler(handler_name) | 为Logger实例增加一个处理器 |
logger.removeHandler(handler_name) | 为Logger实例删除一个处理器 |
4.2 Handler 处理器
Handler处理器类型有很多种,比较常用的有StreamHandler,FileHandler
StreamHandler
创建方法: sh = logging.StreamHandler(stream=None)
FileHandler
创建方法: fh = logging.FileHandler(filename, mode=‘a’, encoding=None,delay=False)
方法 | 作用 |
---|---|
ch.setLevel(logging.WARN) | 指定日志级别,低于WARN级别的日志将被忽略 |
ch.setFormatter(formatter_name) | 设置一个格式化器formatter |
ch.addFilter(filter_name) | 增加一个过滤器,可以增加多个 |
ch.removeFilter(filter_name) | 删除一个过滤器 |
4.3 Filter 过滤器
Filter基类只允许特定Logger层次以下的事件。如果用空字符串来初始化,所有的事件都接受。
创建方法: filter = logging.Filter(name=’’)
4.4 Formatter 格式化器
使用Formatter对象设置日志信息最后的规则、结构和内容,默认的时间格式为 %Y-%m-%d %H:%M:%S
创建方法: formatter = logging.Formatter(fmt=None, datefmt=None)
其中,fmt是消息的格式化字符串,datefmt是日期字符串。如果不指明fmt,将使用’%(message)s’。如果不指明datefmt,将使用ISO8601日期格式。
5.Logger是一个树形层级结构
Logger可以包含一个或多个Handler和Filter,即Logger与Handler或Fitler是一对多的关系;
一个Logger实例可以新增多个Handler,一个Handler可以新增多个格式化器或多个过滤器,而且日志级别将会继承。
6. Logging工作流程
6.1 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等方法记录日志信息。
6.2 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的种类来决定。
6.3 配置日志
配置方式
- 显式创建记录器Logger、处理器Handler和格式化器Formatter,并进行相关设置;
- 通过简单方式进行配置,使用basicConfig()函数直接进行配置;
- 通过配置文件进行配置,使用fileConfig()函数读取配置文件;
- 通过配置字典进行配置,使用dictConfig()函数读取配置信息;
- 通过网络进行配置,使用listen()函数进行网络配置。
basicConfig关键字参数
关键字 | 描述 |
---|---|
filename | 创建一个FileHandler,使用指定的文件名,而不是使用StreamHandler。 |
filemode | 如果指明了文件名,指明打开文件的模式(如果没有指明filemode,默认为’a’)。 |
format | handler使用指明的格式化字符串。 |
datefmt | 使用指明的日期/时间格式。 |
level | 指明根logger的级别。 |
stream | 使用指明的流来初始化StreamHandler。该参数与’filename’不兼容,如果两个都有,'stream’被忽略。 |
常用format格式
格式 | 描述 |
---|---|
%(levelno)s | 打印日志级别的数值 |
%(levelname)s | 打印日志级别名称 |
%(pathname)s | 打印当前执行程序的路径 |
%(filename)s | 打印当前执行程序名称 |
%(funcName)s | 打印日志的当前函数 |
%(lineno)d | 打印日志的当前行号 |
%(asctime)s | 打印日志的时间 |
%(thread)d | 打印线程id |
%(threadName)s | 打印线程名称 |
%(process)d | 打印进程ID |
%(message)s | 打印日志信息 |
配置示例
# -*- encoding:utf-8 -*-
import logging
# create logger
logger_name = "example"
logger = logging.getLogger(logger_name)
logger.setLevel(logging.DEBUG)
# create file handler
log_path = "./log.log"
fh = logging.FileHandler(log_path)
fh.setLevel(logging.WARN)
# create formatter
fmt = "%(asctime)-15s %(levelname)s %(filename)s %(lineno)d %(process)d %(message)s"
datefmt = "%a %d %b %Y %H:%M:%S"
formatter = logging.Formatter(fmt, datefmt)
# add handler and formatter to logger
fh.setFormatter(formatter)
logger.addHandler(fh)
# print log info
logger.debug('debug message')
logger.info('info message')
logger.warn('warn message')
logger.error('error message')
logger.critical('critical message')```
##### 文件配置
配置文件logging.conf如下:
```[loggers]
keys=root,example01
[logger_root]
level=DEBUG
handlers=hand01,hand02
[logger_example01]
handlers=hand01,hand02
qualname=example01
propagate=0
[handlers]
keys=hand01,hand02
[handler_hand01]
class=StreamHandler
level=INFO
formatter=form02
args=(sys.stderr,)
[handler_hand02]
class=FileHandler
level=DEBUG
formatter=form01
args=('log.log', 'a')
[formatters]
keys=form01,form02
[formatter_form01]
format=%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s```
使用程序logger.py如下:
```#!/usr/bin/python
# -*- encoding:utf-8 -*-
import logging
import logging.config
logging.config.fileConfig("./logging.conf")
# create logger
logger_name = "example"
logger = logging.getLogger(logger_name)
logger.debug('debug message')
logger.info('info message')
logger.warn('warn message')
logger.error('error message')
logger.critical('critical message')```
##### 字典配置
使用```logging.config.dictConfig(config)```
##### 监听配置
使用```logging.config.listen(port=DEFAULT_LOGGING_CONFIG_PORT)```
本文地址:https://blog.csdn.net/adamlay/article/details/110280554
推荐阅读
-
python logging日志模块的详解
-
python中使用sys模板和logging模块获取行号和函数名的方法
-
详解Python中的日志模块logging
-
Google开源的Python格式化工具YAPF的安装和使用教程
-
在Python的Django框架中simple-todo工具的简单使用
-
使用CDN之后APACHE日志记录中IP地址不正确的解决方案
-
Python使用logging结合decorator模式实现优化日志输出的方法
-
使用Python3+PyQT5+Pyserial 实现简单的串口工具方法
-
python改变日志(logging)存放位置的示例
-
Python使用修饰器进行异常日志记录操作示例