详解Python中的日志模块logging


Posted in Python onJune 19, 2015

许多应用程序中都会有日志模块,用于记录系统在运行过程中的一些关键信息,以便于对系统的运行状况进行跟踪。在.NET平台中,有非常著名的第三方开源日志组件log4net,c++中,有人们熟悉的log4cpp,而在python中,我们不需要第三方的日志组件,因为它已经为我们提供了简单易用、且功能强大的日志模块:logging。logging模块支持将日志信息保存到不同的目标域中,如:保存到日志文件中;以邮件的形式发送日志信息;以http get或post的方式提交日志到web服务器;以windows事件的形式记录等等。这些日志保存方式可以组合使用,每种方式可以设置自己的日志级别以及日志格式。日志模块的内容比较多,今天先学习logging模块的基本使用,下次具体学习日志的处理。

先看一个比较简单的例子,让我们对logging模块有个感性的认识:
 

import logging
logging.basicConfig(filename = os.path.join(os.getcwd(), 'log.txt'), level = logging.DEBUG)
logging.debug('this is a message')

运行上面例子的代码,将会在程序的根目录下创建一个log.txt文件,打开该文件,里面有一条日志记录:”DEBUG:root:this is a message”。
4个主要的组件

  1. logger: 日志类,应用程序往往通过调用它提供的api来记录日志;
  2. handler: 对日志信息处理,可以将日志发送(保存)到不同的目标域中;
  3. filter: 对日志信息进行过滤;
  4. formatter:日志的格式化;

日志级别

在记录日志时, 日志消息都会关联一个级别(“级别”本质上是一个非负整数)。系统默认提供了6个级别,它们分别是:

详解Python中的日志模块logging

可以给日志对象(Logger Instance)设置日志级别,低于该级别的日志消息将会被忽略,也可以给Hanlder设置日志级别,对于低于该级别的日志消息, Handler也会忽略。

logging模块中的常用函数:
logging.basicConfig([**kwargs]):

为日志模块配置基本信息。kwargs 支持如下几个关键字参数:

  • filename :日志文件的保存路径。如果配置了些参数,将自动创建一个FileHandler作为Handler;
  • filemode :日志文件的打开模式。 默认值为'a',表示日志消息以追加的形式添加到日志文件中。如果设为'w', 那么每次程序启动的时候都会创建一个新的日志文件;
  • format :设置日志输出格式;
  • datefmt :定义日期格式;
  • level :设置日志的级别.对低于该级别的日志消息将被忽略;
  • stream :设置特定的流用于初始化StreamHandler;

下面是一个简单的例子:
 

#coding=gbk
import logging
logging.basicConfig(filename = os.path.join(os.getcwd(), 'log.txt'), /
  level = logging.WARN, filemode = 'w', format = '%(asctime)s - %(levelname)s: %(message)s')
logging.debug('debug') 
#被忽略
logging.info('info')  
#被忽略
logging.warning('warn')
logging.error('error')
#----- 结果
#2009-07-13 21:42:15,592 - WARNING: warn
#2009-07-13 21:42:15,640 - ERROR: error
logging.getLogger([name])

创建Logger对象。日志记录的工作主要由Logger对象来完成。在调用getLogger时要提供Logger的名称(注:多次使用相同名称来调用getLogger,返回的是同一个对象的引用。),Logger实例之间有层次关系,这些关系通过Logger名称来体现,如:

p = logging.getLogger(“root”)

c1 = logging.getLogger(“root.c1″)

c2 = logging.getLogger(“root.c2″)

例子中,p是父logger, c1,c2分别是p的子logger。c1, c2将继承p的设置。如果省略了name参数, getLogger将返回日志对象层次关系中的根Logger。
logging.setLoggerClass(klass)
logging.getLoggerClass()

获取/设置日志类型。用户可以自定义日志类来代替系统提供的logging.Logger类。
logging.getLevelName(lvl)

获取日志级别对应的名称。例如:
 

print logging.getLevelName(logging.NOTSET)
print logging.getLevelName(10) 
#logging.DEBUG
print logging.getLevelName(logging.DEBUG)
print logging.getLevelName(30) 
#logging.WARN
print logging.getLevelName(logging.ERROR)
print logging.getLevelName(50) 
#logging.CRITICAL
logging.shutdown()

当不再使用日志系统的时候,调用该方法,它会将日志flush到对应的目标域上。一般在系统退出的时候调用。

Logger对象 通过调用logging.getLogger(name)来创建,它有如下常用的方法和属性:
Logger.setLevel(lvl):

设置日志的级别。对于低于该级别的日志消息将被忽略。下面一个例子演示setLevel方法:
 

#coding=gbk
import logging
logging.basicConfig(filename = os.path.join(os.getcwd(), 'log.txt'), level = logging.DEBUG)
log = logging.getLogger('root.test')
log.setLevel(logging.WARN) #日志记录级别为WARNNING
log.info('info')  #不会被记录
log.debug('debug') #不会被记录
log.warning('warnning')
log.error('error')
Logger.debug(msg [ ,*args [, **kwargs]])

记录DEBUG级别的日志信息。参数msg是信息的格式,args与kwargs分别是格式参数。

import logging
logging.basicConfig(filename = os.path.join(os.getcwd(), 'log.txt'), level = logging.DEBUG)
log = logging.getLogger('root')
log.debug('%s, %s, %s', *('error', 'debug', 'info'))
log.debug('%(module)s, %(info)s', {'module': 'log', 'info': 'error'})
Logger.info(msg[ , *args[ , **kwargs] ] )
Logger.warnning(msg[ , *args[ , **kwargs] ] )
Logger.error(msg[ , *args[ , **kwargs] ] )
Logger.critical(msg[ , *args[ , **kwargs] ] )

记录相应级别的日志信息。参数的含义与Logger.debug一样。
Logger.log(lvl, msg[ , *args[ , **kwargs] ] )

记录日志,参数lvl用户设置日志信息的级别。参数msg, *args, **kwargs的含义与Logger.debug一样。
Logger.exception(msg[, *args])

以ERROR级别记录日志消息,异常跟踪信息将被自动添加到日志消息里。Logger.exception通过用在异常处理块中,如:
 

import logging
logging.basicConfig(filename = os.path.join(os.getcwd(), 'log.txt'), level = logging.DEBUG)
log = logging.getLogger('root')
try:
  raise Exception, 'this is a exception'
except:
  log.exception('exception') 
#异常信息被自动添加到日志消息中
Logger.addFilter(filt)
Logger.removeFilter(filt)

添加/移除日志消息过滤器。在讲述Filter时具体介绍。
Logger.addHandler(hdlr)
Logger.removeHandler(hdlr)

添加/移除日志消息处理器。在讲述Handler时具体介绍。
Logger.makeRecord(name, lvl, fn, lno, msg, args, exc_info[, func, extra])

创建LogRecord对象。日志消息被实例为一个LogRecord对象,并在日志类内处理。

Python 相关文章推荐
Python实现获取操作系统版本信息方法
Apr 08 Python
Python使用matplotlib绘制动画的方法
May 20 Python
python的else子句使用指南
Feb 27 Python
基于Python实现对PDF文件的OCR识别
Aug 05 Python
Python内建模块struct实例详解
Feb 02 Python
PyQt4实现下拉菜单可供选择并打印出来
Apr 20 Python
python队列queue模块详解
Apr 27 Python
python识别文字(基于tesseract)代码实例
Aug 24 Python
python os模块在系统管理中的应用
Jun 22 Python
使用keras实现非线性回归(两种加激活函数的方式)
Jul 05 Python
关于Python 解决Python3.9 pandas.read_excel(‘xxx.xlsx‘)报错的问题
Nov 28 Python
基于python+selenium自动健康打卡的实现代码
Jan 13 Python
使用httplib模块来制作Python下HTTP客户端的方法
Jun 19 #Python
举例详解Python中threading模块的几个常用方法
Jun 18 #Python
Python的time模块中的常用方法整理
Jun 18 #Python
Python抽象类的新写法
Jun 18 #Python
Python实现的彩票机选器实例
Jun 17 #Python
Python基于Tkinter实现的记事本实例
Jun 17 #Python
Python基于Tkinter的HelloWorld入门实例
Jun 17 #Python
You might like
建立动态的WML站点(一)
2006/10/09 PHP
PHP设计模式之命令模式的深入解析
2013/06/13 PHP
php简单生成一组与多组随机字符串的方法
2017/05/09 PHP
js prototype截取字符串函数
2010/04/01 Javascript
javascript制作游戏开发碰撞检测的封装代码
2015/03/31 Javascript
javascript事件委托的方式绑定详解
2015/06/10 Javascript
JavaScript中利用Array和Object实现Map的方法
2015/07/27 Javascript
如何解决easyui自定义标签 datagrid edit combobox 手动输入保存不上
2015/12/26 Javascript
Javascript数组Array基础介绍
2016/03/13 Javascript
Vue组件中的data必须是一个function的原因浅析
2018/09/03 Javascript
JS使用百度地图API自动获取地址和经纬度操作示例
2019/04/16 Javascript
Vue中props的详解
2019/05/16 Javascript
原生js实现的移动端可拖动进度条插件功能详解
2019/08/15 Javascript
vue组件库的在线主题编辑器的实现思路
2020/04/03 Javascript
Element Input输入框的使用方法
2020/07/26 Javascript
JS实现斐波那契数列的五种方式(小结)
2020/09/09 Javascript
JavaScript实现音乐导航效果
2020/11/19 Javascript
[02:51]2018年度DOTA2最佳中单位选手-完美盛典
2018/12/17 DOTA
在Python中操作列表之List.pop()方法的使用
2015/05/21 Python
Python内置的HTTP协议服务器SimpleHTTPServer使用指南
2016/03/30 Python
利用Python开发微信支付的注意事项
2016/08/19 Python
详解如何为eclipse安装合适版本的python插件pydev
2018/11/04 Python
Python代码打开本地.mp4格式文件的方法
2019/01/03 Python
Python数据可视化:泊松分布详解
2019/12/07 Python
Python使用socketServer包搭建简易服务器过程详解
2020/06/12 Python
JBL英国官网:JBL UK
2018/07/04 全球购物
如何在C# winform中异步调用web services
2015/09/21 面试题
行政管理毕业生自荐信
2014/02/24 职场文书
经济担保书范文
2014/04/02 职场文书
人事任命书格式
2014/06/05 职场文书
征兵宣传标语
2014/06/20 职场文书
2014第二批党员干部对照“四风”找差距检查材料思想汇报
2014/09/18 职场文书
安阳殷墟导游词
2015/02/10 职场文书
手把手教你使用TensorFlow2实现RNN
2021/07/15 Python
Vue.Draggable实现交换位置
2022/04/07 Vue.js
MongoDB数据库之添删改查
2022/04/26 MongoDB