Python logging 模块

Python日志模块简介使用Python写程序，有时要用上日志系统。特别是Python这样的动态语言，很多错误都只能在运行的时候才能发现，一个好的日志系统对于Python程序相当重要。最简单的解决方案当然是直接使用print输出运行信息。但是这样太简单了，没有分级功能，如果在发布的时候想去掉调试用的运行信息还得找出所有的print语句进行修改。再者，print只能输出到控制台，想要输出到文件或者通过电子邮件发送到其他地方，一个 print语句就没办法解决了。通过使用Python的日志系统，就可以解决以上问题。 首先看一下这个示例：

import logging
logger=logging.getLogger(’应用程序名’)
logger.setLevel(logging.DEBUG)
console = logging.StreamHandler()
console.setLevel(logging.INFO)
logger.addHandler(console)
logger.debug(’调试信息’)
logger.info(’有用的信息’)
logger.warning(’警告信息’)
logger.error(’错误信息’)
logger.critical(’严重错误信息’)

上面的代码想控制台输出了五种错误信息。分为五个从低到高的级别，从DEBUG到CRITICAL。此外，我们还指定了程序输出的级别，只有INFO级别以上的信息才会被输出。Python的日志核心组件：1. “Logger”。每个程序在输出信息之前都要获得一个Logger。Logger通常对应了程序的模块名，比如聊天工具的图形界面模块可以这样获得它的Logger：

logger=logging.getLogger(”chat.gui”)

而核心模块可以这样：

logger=logging.getLogger(”chat.kernel”)

我们接下来可以看到使用这种命名方法的用途。 还有直接使用：

logger= logging.getLogger()
#或
logger = logging.basicConfig(**kwargs)

其中默认的日志name为root，直接使用logging模块的info、debug等函数，会把日志都记录在root层。2. "formatter"：日志格式化日志的输出格式是通过logging.Formatter来设定的，其初始化的参数如下： 例如：

logger=logging.getLogger(”chat.gui”)
console = logging.StreamHandler()
formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
console .setFormatter(formatter)
logger.addHandler(console)
#或
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

3. “Handler”。用于处理程序的输出。 Python的日志系统有多种Handler可以使用。有些Handler可以把信息输出到控制台，有些Logger可以把信息输出到文件，还有些 Handler可以把信息发送到网络上。如果觉得不够用，还可以编写自己的Handler。所有的Handler可以支持三个操作：A.设置输出格式。比如设置输出的信息中包含时间和级别信息：

logger=logging.getLogger(”chat.gui”)
console = logging.StreamHandler()
console.setLevel(logging.INFO)
formatter = logging.Formatter(’%(asctime)s - %(levelname)s - %(message)s’)
console.setFormatter(formatter)
logger.addHandler(console)

B. 设置输出级别在上面我们已经演示了如何设置输出级别了。除了Python内置的五种级别，我们还可以自定义输出级别。日志对象对于不同的级别信息提供不同的函数进行输出，如：info(), error(), debug()等。当写入日志时，小于指定级别的信息将被忽略。因此为了输出想要的日志级别一定要设置好此参数。这里我设为NOTSET（值为0），也就是想输出所有信息。系统默认的日志级别排序为，CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET。比如说我们要输出的信息为CRITICAL，但是我们的日志级别为DEBUG，那么这个信息将被忽略掉。C.设置过滤器前文调用logging.getLogger()时参数的格式类似于“A.B.C”。采取这样的格式其实就是为了可以配置过滤器。看一下这段代码：

logger=logging.getLogger(”chat.gui.statistic”)console = logging.StreamHandler()console.setLevel(logging.INFO)formatter = logging.Formatter(’%(asctime)s %(levelname)s %(message)s’)console.setFormatter(formatter)filter=logging.Filter(”chat.gui”)console.addFilter(filter)logger.addHandler(console

和前面不同的是我们在Handler上添加了一个过滤器。现在我们输出日志信息的时候就会经过过滤器的处理。名为“A.B”的过滤器只让名字带有 “A.B”前缀的Logger输出信息。可以添加多个过滤器，只要有一个过滤器拒绝，日志信息就不会被输出。另外，在Logger中也可以添加过滤器。 每个Logger可以附加多个Handler。接下来我们就来介绍一些常用的Handler：logging.StreamHandler使用这个Handler可以向类似与sys.stdout或者sys.stderr的任何文件对象(file object)输出信息。它的构造函数是： StreamHandler([strm]) 其中strm参数是一个文件对象。默认是sys.stderrlogging.FileHandler和StreamHandler类似，用于向一个文件输出日志信息。不过FileHandler会帮你打开这个文件。它的构造函数是： FileHandler(filename[,mode]) filename是文件名，必须指定一个文件名。 mode是文件的打开方式。参见Python内置函数open()的用法。默认是’a'，即添加到文件末尾。logging.handlers.RotatingFileHandler这个Handler类似于上面的FileHandler，但是它可以管理文件大小。当文件达到一定大小之后，它会自动将当前日志文件改名，然后创建 一个新的同名日志文件继续输出。比如日志文件是chat.log。当chat.log达到指定的大小之后，RotatingFileHandler自动把 文件改名为chat.log.1。不过，如果chat.log.1已经存在，会先把chat.log.1重命名为chat.log.2。。。最后重新创建 chat.log，继续输出日志信息。它的构造函数是： RotatingFileHandler( filename[, mode[, maxBytes[, backupCount]]]) 其中filename和mode两个参数和FileHandler一样。 maxBytes用于指定日志文件的最大文件大小。如果maxBytes为0，意味着日志文件可以无限大，这时上面描述的重命名过程就不会发生。 backupCount用于指定保留的备份文件的个数。比如，如果指定为2，当上面描述的重命名过程发生时，原有的chat.log.2并不会被更名，而是被删除。logging.handlers.TimedRotatingFileHandler这个Handler和RotatingFileHandler类似，不过，它没有通过判断文件大小来决定何时重新创建日志文件，而是间隔一定时间就 自动创建新的日志文件。重命名的过程与RotatingFileHandler类似，不过新的文件不是附加数字，而是当前时间。它的构造函数是： TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]]) 其中filename参数和backupCount参数和RotatingFileHandler具有相同的意义。 interval是时间间隔。 when参数是一个字符串。表示时间间隔的单位，不区分大小写。它有以下取值： S 秒 M 分 H 小时 D 天 W 每星期（interval==0时代表星期一） midnight 每天凌晨logging.handlers.SocketHandlerlogging.handlers.DatagramHandler以上两个Handler类似，都是将日志信息发送到网络。不同的是前者使用TCP协议，后者使用UDP协议。它们的构造函数是： Handler(host, port) 其中host是主机名，port是端口名logging.handlers.SysLogHandlerlogging.handlers.NTEventLogHandlerlogging.handlers.SMTPHandlerlogging.handlers.MemoryHandlerlogging.handlers.HTTPHandler学习资料：http://onlamp.com/pub/a/python/2005/06/02/logging.html