Python中使用logging模块打印log日志详解
学一门新技术或者新语言,我们都要首先学会如何去适应这们新技术,其中在适应过程中,我们必须得学习如何调试程序并打出相应的log信息来,正所谓“只要log打的好,没有bug解不了”,在我们熟知的一些信息技术中,log4xxx系列以及开发Androidapp时的android.util.Log包等等都是为了开发者更好的得到log信息服务的。在Python这门语言中,我们同样可以根据自己的程序需要打出log。
log信息不同于使用打桩法打印一定的标记信息,log可以根据程序需要而分出不同的log级别,比如info、debug、warn等等级别的信息,只要实时控制log级别开关就可以为开发人员提供更好的log信息,与log4xx类似,logger,handler和日志消息的调用可以有具体的日志级别(Level),只有在日志消息的级别大于logger和handler的设定的级别,才会显示。下面我就来谈谈我在Python中使用的logging模块一些方法。
logging模块介绍
Python的logging模块提供了通用的日志系统,熟练使用logging模块可以方便开发者开发第三方模块或者是自己的Python应用。同样这个模块提供不同的日志级别,并可以采用不同的方式记录日志,比如文件,HTTP、GET/POST,SMTP,Socket等,甚至可以自己实现具体的日志记录方式。下文我将主要介绍如何使用文件方式记录log。
logging模块包括logger,handler,filter,formatter这四个基本概念。
logger:提供日志接口,供应用代码使用。logger最长用的操作有两类:配置和发送日志消息。可以通过logging.getLogger(name)获取logger对象,如果不指定name则返回root对象,多次使用相同的name调用getLogger方法返回同一个logger对象。
handler:将日志记录(logrecord)发送到合适的目的地(destination),比如文件,socket等。一个logger对象可以通过addHandler方法添加0到多个handler,每个handler又可以定义不同日志级别,以实现日志分级过滤显示。
filter:提供一种优雅的方式决定一个日志记录是否发送到handler。
formatter:指定日志记录输出的具体格式。formatter的构造方法需要两个参数:消息的格式字符串和日期字符串,这两个参数都是可选的。
基本使用方法
一些小型的程序我们不需要构造太复杂的log系统,可以直接使用logging模块的basicConfig函数即可,代码如下:
''' Createdon2012-8-12 @author:walfred @module:loggingmodule.BasicLogger ''' importlogging log_file="./basic_logger.log" logging.basicConfig(filename=log_file,level=logging.DEBUG) logging.debug("thisisadebugmsg!") logging.info("thisisainfomsg!") logging.warn("thisisawarnmsg!") logging.error("thisisaerrormsg!") logging.critical("thisisacriticalmsg!")
运行程序时我们就会在该文件的当前目录下发现basic_logger.log文件,查看basic_logger.log内容如下:
INFO:root:thisisainfomsg! DEBUG:root:thisisadebugmsg! WARNING:root:thisisawarnmsg! ERROR:root:thisisaerrormsg! CRITICAL:root:thisisacriticalmsg!
需要说明的是我将level设定为DEBUG级别,所以log日志中只显示了包含该级别及该级别以上的log信息。信息级别依次是:notset、debug、info、warn、error、critical。如果在多个模块中使用这个配置的话,只需在主模块中配置即可,其他模块会有相同的使用效果。
较高级版本
上述的基础使用比较简单,没有显示出logging模块的厉害,适合小程序用,现在我介绍一个较高级版本的代码,我们需要依次设置logger、handler、formatter等配置。
''' Createdon2012-8-12 @author:walfred @module:loggingmodule.NomalLogger ''' importlogging log_file="./nomal_logger.log" log_level=logging.DEBUG logger=logging.getLogger("loggingmodule.NomalLogger") handler=logging.FileHandler(log_file) formatter=logging.Formatter("[%(levelname)s][%(funcName)s][%(asctime)s]%(message)s") handler.setFormatter(formatter) logger.addHandler(handler) logger.setLevel(log_level) #test logger.debug("thisisadebugmsg!") logger.info("thisisainfomsg!") logger.warn("thisisawarnmsg!") logger.error("thisisaerrormsg!") logger.critical("thisisacriticalmsg!")
这时我们查看当前目录的nomal_logger.log日志文件,如下:
[DEBUG][][2012-08-1217:43:59,295]thisisadebugmsg! [INFO][][2012-08-1217:43:59,295]thisisainfomsg! [WARNING][][2012-08-1217:43:59,295]thisisawarnmsg! [ERROR][][2012-08-1217:43:59,295]thisisaerrormsg! [CRITICAL][][2012-08-1217:43:59,295]thisisacriticalmsg!
这个对照前面介绍的logging模块,不难理解,下面的最终版本将会更加完整。
完善版本
这个最终版本我用singleton设计模式来写一个Logger类,代码如下:
''' Createdon2012-8-12 @author:walfred @module:loggingmodule.FinalLogger ''' importlogging.handlers classFinalLogger: logger=None levels={"n":logging.NOTSET, "d":logging.DEBUG, "i":logging.INFO, "w":logging.WARN, "e":logging.ERROR, "c":logging.CRITICAL} log_level="d" log_file="final_logger.log" log_max_byte=10*1024*1024; log_backup_count=5 @staticmethod defgetLogger(): ifFinalLogger.loggerisnotNone: returnFinalLogger.logger FinalLogger.logger=logging.Logger("oggingmodule.FinalLogger") log_handler=logging.handlers.RotatingFileHandler(filename=FinalLogger.log_file,\ maxBytes=FinalLogger.log_max_byte,\ backupCount=FinalLogger.log_backup_count) log_fmt=logging.Formatter("[%(levelname)s][%(funcName)s][%(asctime)s]%(message)s") log_handler.setFormatter(log_fmt) FinalLogger.logger.addHandler(log_handler) FinalLogger.logger.setLevel(FinalLogger.levels.get(FinalLogger.log_level)) returnFinalLogger.logger if__name__=="__main__": logger=FinalLogger.getLogger() logger.debug("thisisadebugmsg!") logger.info("thisisainfomsg!") logger.warn("thisisawarnmsg!") logger.error("thisisaerrormsg!") logger.critical("thisisacriticalmsg!")
当前目录下的final_logger.log内容如下:
[DEBUG][][2012-08-1218:12:23,029]thisisadebugmsg! [INFO][][2012-08-1218:12:23,029]thisisainfomsg! [WARNING][][2012-08-1218:12:23,029]thisisawarnmsg! [ERROR][][2012-08-1218:12:23,029]thisisaerrormsg! [CRITICAL][][2012-08-1218:12:23,029]thisisacriticalmsg!
这个final版本,也是我一直用的,读者朋友也可以再加上其他的一些Handler,比如StreamHandler等等来获取更多的log信息,当然也可以将你的log信息通过配置文件来完成。