（转）一篇写的简明易懂的logging模块

转：http://kenby.iteye.com/blog/1162698

 

1、从一个使用场景开始

 

开发一个日志系统， 既要把日志输出到控制台， 还要写入日志文件

 

import logging

# 建立一个logger
logger = logging.getLogger('mylogger')
logger.setLevel(logging.DEBUG)

# 建立一个handler，用于写入日志文件
fh = logging.FileHandler('test.log')
fh.setLevel(logging.DEBUG)

# 再建立一个handler，用于输出到控制台
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)

# 定义handler的输出格式
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
fh.setFormatter(formatter)
ch.setFormatter(formatter)

# 给logger添加handler
logger.addHandler(fh)
logger.addHandler(ch)

# 记录一条日志
logger.info('foorbar')

 

 

运行后， 在控制台和日志文件都有一条日志：

 

2011-08-31 19:18:29,816 - mylogger - INFO - foorbar

 

 

2、logging模块的API

 

结合上面的例子，咱们说下几个最常使用的API

logging. getLogger ( [name])返回一个logger实例，若是没有指定name，返回root logger。只要name相同，返回的logger实例都是同一个并且只有一个，即name和logger实例是一一对应的。这意味着，无需把logger实例在各个模块中传递。只要知道name，就能获得同一个logger实例
Logger. setLevel ( lvl )设置logger的level， level有如下几个级别：

NOTSET < DEBUG < INFO < WARNING < ERROR < CRITICAL
若是把looger的级别设置为INFO， 那么小于INFO级别的日志都不输出， 大于等于INFO级别的日志都输出

logger.debug("foobar")    # 不输出
logger.info("foobar")        # 输出
logger.warning("foobar") # 输出
logger.error("foobar")      # 输出
logger.critical("foobar")    # 输出

  Logger. addHandler ( hdlr )logger能够雇佣handler来帮它处理日志， handler主要有如下几种： StreamHandler: 输出到控制台 FileHandler:   输出到文件handler还能够设置本身的level以及输出格式。
logging. basicConfig ( [**kwargs])* 这个函数用来配置root logger， 为root logger建立一个StreamHandler，   设置默认的格式。* 这些函数： logging.debug()、logging.info()、logging.warning()、   logging.error()、logging.critical() 若是调用的时候发现root logger没有任何   handler， 会自动调用basicConfig添加一个handler* 若是root logger已有handler， 这个函数不作任何事情
使用basicConfig来配置root logger的输出格式和level：

import logging
logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG)
logging.debug('This message should appear on the console')

 
3、关于root logger以及logger的父子关系
前面屡次提到root logger， 实际上logger实例之间还有父子关系， root logger就是处于最顶层的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实例。
默认的levelroot logger默认的level是logging.WARNING
如何表示父子关系logger的name的命名方式能够表示logger之间的父子关系. 好比：parent_logger = logging.getLogger('foo')child_logger = logging.getLogger('foo.bar')
什么是effective levellogger有一个概念，叫effective level。 若是一个logger没有显示地设置level，那么它就用父亲的level。若是父亲也没有显示地设置level， 就用父亲的父亲的level，以此推....最后到达root logger，必定设置过level。默认为logging.WARNINGchild loggers获得消息后，既把消息分发给它的handler处理，也会传递给全部祖先logger处理，
来看一个例子

import logging

# 设置root logger
r = logging.getLogger()
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)
formatter = logging.Formatter('%(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('%(asctime)s - %(message)s')
ch.setFormatter(formatter)
p.addHandler(ch)

# 建立一个孩子logger
c = logging.getLogger('foo.bar')
c.debug('foo')

 输出以下：

2011-08-31 21:04:29,893 - foo
2011-08-31 21:04:29,893 - DEBUG - foo

可见， 孩子logger没有任何handler，因此对消息不作处理。可是它把消息转发给了它的父亲以及root logger。最后输出两条日志。

• 大小: 2 KB

• 大小: 10.1 KB