详解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中for循环控制语句用法实例
Jun 02 Python
举例讲解Python中的Null模式与桥接模式编程
Feb 02 Python
Python的装饰器使用详解
Jun 26 Python
Python使用PIL模块生成随机验证码
Nov 21 Python
python将txt文档每行内容循环插入数据库的方法
Dec 28 Python
​如何愉快地迁移到 Python 3
Apr 28 Python
django之对FileField字段的upload_to的设定方法
Jul 28 Python
OpenCV+python实现实时目标检测功能
Jun 24 Python
Django nginx配置实现过程详解
Sep 10 Python
详细总结Python常见的安全问题
May 21 Python
python 中的@运算符使用
May 26 Python
分享几种python 变量合并方法
Mar 20 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
php入门学习知识点六 PHP文件的读写操作代码
2011/07/14 PHP
win7+apache+php+mysql环境配置操作详解
2013/06/10 PHP
php生成数字字母的验证码图片
2015/07/14 PHP
详解PHP中foreach的用法和实例
2016/10/25 PHP
PHP如何读取由JavaScript设置的Cookie
2017/03/22 PHP
PHP变量的作用范围实例讲解
2020/12/22 PHP
JavaScript的面向对象方法以及差别
2008/03/31 Javascript
JavaScript 获得选中文本内容的方法
2009/02/15 Javascript
获取dom元素那些讨厌的位置封装代码
2010/06/23 Javascript
XENON基于JSON变种
2010/07/27 Javascript
js 得到文件后缀(通过正则实现)
2013/07/08 Javascript
框架页面高度自动刷新的Javascript脚本
2013/11/01 Javascript
js文本框输入点回车触发确定兼容IE、FF等
2013/11/19 Javascript
通过pjax实现无刷新翻页(兼容新版jquery)
2014/01/31 Javascript
利用vue写todolist单页应用
2016/12/15 Javascript
angular和BootStrap3实现购物车功能
2017/01/25 Javascript
iscroll-probe实现下拉刷新和下拉加载效果
2017/06/28 Javascript
JS实现微信摇一摇原理解析
2017/07/22 Javascript
Django中使用jquery的ajax进行数据交互的实例代码
2017/10/15 jQuery
angularjs实现猜大小功能
2017/10/23 Javascript
JS实现模糊查询带下拉匹配效果
2018/06/21 Javascript
原生JS实现DOM加载完成马上执行JS代码的方法
2018/09/07 Javascript
[05:31]DOTA2上海特级锦标赛主赛事第三日RECAP
2016/03/05 DOTA
Python 调用DLL操作抄表机
2009/01/12 Python
python实现从ftp服务器下载文件的方法
2015/04/30 Python
Python 基础知识之字符串处理
2017/01/06 Python
Python实现多条件筛选目标数据功能【测试可用】
2018/06/13 Python
python通过微信发送邮件实现电脑关机
2018/06/20 Python
Python字符串内置函数功能与用法总结
2019/04/16 Python
python 实现图片上传接口开发 并生成可以访问的图片url
2019/12/18 Python
CSS3中的content属性使用示例
2015/07/20 HTML / CSS
九年级历史教学反思
2014/01/27 职场文书
《一株紫丁香》教学反思
2014/02/19 职场文书
2014年居委会工作总结
2014/12/09 职场文书
详解TypeScript中的类型保护
2021/04/29 Javascript
html5调用摄像头实例代码
2021/06/28 HTML / CSS