python日志模块logging的使用

一、将日志打印在屏幕上

这种方法类似printf，直接将日志信息打印在屏幕上：

import logginglogging.debug('This is debug message')logging.info('This is info message')logging.warning('This is warning message')

屏幕上打印：

WARNING:root:This is warning message

默认情况下，logging将日志打印到屏幕，日志级别为WARNING。

日志级别大小关系为：CRITICAL > ERROR > WARNING > INFO > DEBUG > NOTSET，当然也可以自己定义日志级别。

二、使用basicConfig 配置logging的日志行为

import logginglogging.basicConfig(level=logging.DEBUG,                format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',                datefmt='%a, %d %b %Y %H:%M:%S',                filename='myapp.log',                filemode='w')logging.debug('This is debug message')logging.info('This is info message')logging.warning('This is warning message')

/myapp.log文件中内容为:

Sun, 24 May 2009 21:48:54 demo2.py[line:11] DEBUG This is debug message
Sun, 24 May 2009 21:48:54 demo2.py[line:12] INFO This is info message
Sun, 24 May 2009 21:48:54 demo2.py[line:13] WARNING This is warning message

logging.basicConfig函数各参数：

filename: 指定日志文件名filemode: 和file函数意义相同，指定日志文件的打开模式，'w'或'a'format: 指定输出的格式和内容，format可以输出很多有用信息，如上例所示: %(levelno)s: 打印日志级别的数值 %(levelname)s: 打印日志级别名称 %(pathname)s: 打印当前执行程序的路径，其实就是sys.argv[0] %(filename)s: 打印当前执行程序名 %(funcName)s: 打印日志的当前函数 %(lineno)d: 打印日志的当前行号 %(asctime)s: 打印日志的时间 %(thread)d: 打印线程ID %(threadName)s: 打印线程名称 %(process)d: 打印进程ID %(message)s: 打印日志信息datefmt: 指定时间格式，同time.strftime()level: 设置日志级别，默认为logging.WARNINGstream: 指定将日志的输出流，可以指定输出到sys.stderr,sys.stdout或者文件，默认输出到sys.stderr        当stream和filename同时指定时，stream被忽略

三、将日志同时输出到文件和屏幕中

logging日志模块使用的时候必须有logger，其实上面的logging.basicConfig 默认的使用logger root 。

import logginglogging.basicConfig(level=logging.DEBUG,                format='%(name) %(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',                datefmt='%a, %d %b %Y %H:%M:%S',                filename='myapp.log',                filemode='w')##################################################################################################定义一个StreamHandler，将INFO级别或更高的日志信息打印到标准错误，并将其添加到当前的日志处理对象#console = logging.StreamHandler()console.setLevel(logging.INFO)formatter = logging.Formatter('%(name)-12s: %(levelname)-8s %(message)s')console.setFormatter(formatter)logging.getLogger('').addHandler(console)#################################################################################################logging.debug('This is debug message')logging.info('This is info message')logging.warning('This is warning message')

输出的结果，屏幕上打印：

root : INFO This is info message
root : WARNING This is warning message

文件中的内容为：

root Sun, 24 May 2009 21:48:54 demo2.py[line:11] DEBUG This is debug message
root Sun, 24 May 2009 21:48:54 demo2.py[line:12] INFO This is info message
root Sun, 24 May 2009 21:48:54 demo2.py[line:13] WARNING This is warning message

四、通过logging.conf 模块配置日志

#logger.conf###############################################[loggers]keys=root,example01,example02[logger_root]level=DEBUGhandlers=hand01,hand02[logger_example01]handlers=hand01,hand02qualname=example01propagate=0[logger_example02]handlers=hand01,hand03qualname=example02propagate=0###############################################[handlers]keys=hand01,hand02,hand03[handler_hand01]class=StreamHandlerlevel=INFOformatter=form02args=(sys.stderr,)[handler_hand02]class=FileHandlerlevel=DEBUGformatter=form01args=('myapp.log', 'a')[handler_hand03]class=handlers.RotatingFileHandlerlevel=INFOformatter=form02args=('myapp.log', 'a', 10*1024*1024, 5)###############################################[formatters]keys=form01,form02[formatter_form01]format=%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)sdatefmt=%a, %d %b %Y %H:%M:%S[formatter_form02]format=%(name)-12s: %(levelname)-8s %(message)sdatefmt=%a, %d %b %Y %H:%M:%S

看几个使用上面配置文件的日志模块列子：

import loggingimport logging.configlogging.config.fileConfig("logger.conf")logger = logging.getLogger("example01")logger.debug('This is debug message')logger.info('This is info message')logger.warning('This is warning message')

---

import loggingimport logging.configlogging.config.fileConfig("logger.conf")logger = logging.getLogger("example02")logger.debug('This is debug message')logger.info('This is info message')logger.warning('This is warning message')

五、logging是线程安全的

在多线程环境中，使用logging时不需要额外的线程冲突考虑。

关于root logger 和logger 的继承关系:

root logger是默认的logger

如果不创建logger实例， 直接调用logging.debug()、logging.info()logging.warning()、logging.error()、logging.critical()这些函数，那么使用的logger就是 root logger， 它可以自动创建，也是单实例的。

如何得到root logger

通过logging.getLogger()或者logging.getLogger(””)得到root logger实例。
root logger默认的level是logging.WARNING

---

如何表示父子关系

logger的name的命名方式可以表示logger之间的父子关系. 比如：

parent_logger = logging.getLogger('foo')child_logger = logging.getLogger('foo.bar')

什么是effective level

logger有一个概念，叫effective level。 如果一个logger没有显示地设置level，那么它就用父亲的level。如果父亲也没有显示地设置level， 就用父亲的父亲的level，以此推….

最后到达root logger，一定设置过level。默认为logging.WARNING。

child loggers得到消息后，既把消息分发给它的handler处理，也会传递给所有祖先logger处理。

来看一个例子：

import logging# 设置root loggerr = logging.getLogger()ch = logging.StreamHandler()ch.setLevel(logging.DEBUG)formatter = logging.Formatter('[root:] %(asctime)s - %(levelname)s - %(message)s')ch.setFormatter(formatter)r.addHandler(ch)# 创建一个logger作为父亲p = logging.getLogger('foo')p.setLevel(logging.DEBUG)ch = logging.StreamHandler()ch.setLevel(logging.DEBUG)formatter = logging.Formatter('[parent:] %(asctime)s - %(message)s')ch.setFormatter(formatter)p.addHandler(ch)# 创建一个孩子loggerc = logging.getLogger('foo.bar')c.debug('This is debug message')  

打印结果：

[parent:] 2011-08-31 21:04:29,893 - This is debug message
[root:] 2011-08-31 21:04:29,893 - DEBUG - This is debug message

可见，虽然孩子 logger 没有定义他的handler处理，但是消息传递到了他的父类 logger ，之后父类 logger 有传递给了根 root logger 。所以在屏幕上打印两行日志信息。

也就是说：孩子 logger 没有任何 handler ，所以对消息不做处理。但是它把消息转发给了它的父 亲以及 root logger 。最后输出两条日志。

六、参考链接

1. http://www.pythonclub.org/modules/logging