详解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实现的最近最少使用算法
Jul 10 Python
Python中运算符"=="和"is"的详解
Oct 08 Python
Python 出现错误TypeError: ‘NoneType’ object is not iterable解决办法
Jan 12 Python
python字符串中的单双引
Feb 16 Python
深入了解Django中间件及其方法
Jul 26 Python
python获取Linux发行版名称
Aug 30 Python
Python 、Pycharm、Anaconda三者的区别与联系、安装过程及注意事项
Oct 11 Python
Pycharm创建项目时如何自动添加头部信息
Nov 14 Python
Python如何定义有默认参数的函数
Aug 10 Python
解决python3.6用cx_Oracle库连接Oracle的问题
Dec 07 Python
Windows安装Anaconda3的方法及使用过程详解
Jun 11 Python
Python将CSV文件转化为HTML文件的操作方法
Jun 30 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 中dirname(_file_)讲解
2007/03/18 PHP
php 需要掌握的东西 不做浮躁的人
2009/12/28 PHP
php 使用post,get的一种简洁方式
2010/04/25 PHP
PHP获取和操作配置文件php.ini的几个函数介绍
2013/06/24 PHP
php通过获取头信息判断图片类型的方法
2015/06/26 PHP
php 实现301重定向跳转实例代码
2016/07/18 PHP
可实现多表单提交的javascript函数
2007/08/01 Javascript
js Select下拉列表框进行多选、移除、交换内容的具体实现方法
2013/08/13 Javascript
JavaScript+CSS实现仿天猫侧边网页菜单效果
2015/08/25 Javascript
AngularJS身份验证的方法
2016/02/17 Javascript
JS+CSS3模拟溢出滚动效果
2016/08/12 Javascript
AngularJS 入门教程之事件处理器详解
2016/08/19 Javascript
JavaScript实战(原生range和自定义特效)简单实例
2016/08/21 Javascript
基于javascript实现数字英文验证码
2017/01/25 Javascript
windows下vue-cli导入bootstrap样式
2017/04/25 Javascript
jQuery Validate 校验多个相同name的方法
2017/05/18 jQuery
浅谈angular2路由预加载策略
2017/10/04 Javascript
vue-cli3.0 环境变量与模式配置方法
2018/11/08 Javascript
超详细动手搭建一个VuePress 站点及开启PWA与自动部署的方法
2019/01/27 Javascript
jquery实现弹窗(系统提示框)效果
2019/12/10 jQuery
[00:10]DOTA2 TI9勇士令状明日上线
2019/05/07 DOTA
python3编码问题汇总
2016/09/06 Python
Python实现的摇骰子猜大小功能小游戏示例
2017/12/18 Python
对python指数、幂数拟合curve_fit详解
2018/12/29 Python
Python构建图像分类识别器的方法
2019/01/12 Python
Django 静态文件配置过程详解
2019/07/23 Python
详解Anconda环境下载python包的教程(图形界面+命令行+pycharm安装)
2019/11/11 Python
Tensorflow不支持AVX2指令集的解决方法
2020/02/03 Python
Django REST Swagger实现指定api参数
2020/07/07 Python
索引覆盖(Index Covering)查询含义
2012/02/18 面试题
上学迟到的检讨书
2014/01/11 职场文书
干部下基层实施方案
2014/03/14 职场文书
2014年人事行政工作总结
2014/12/03 职场文书
天鹅湖观后感
2015/06/09 职场文书
学会Python数据可视化必须尝试这7个库
2021/06/16 Python
Spring Boot项目如何优雅实现Excel导入与导出功能
2022/06/10 Java/Android