這篇文章主要介紹了Python中的日志模塊logging,包括Python下的日志級別以及模塊內常用方法的使用,需要的朋友可以參考下
許多應用程序中都會有日志模塊,用於記錄系統在運行過程中的一些關鍵信息,以便於對系統的運行狀況進行跟蹤。在.NET平台中,有非常著名的第三方開源日志組件log4net,c++中,有人們熟悉的log4cpp,而在python中,我們不需要第三方的日志組件,因為它已經為我們提供了簡單易用、且功能強大的日志模塊:logging。logging模塊支持將日志信息保存到不同的目標域中,如:保存到日志文件中;以郵件的形式發送日志信息;以http get或post的方式提交日志到web服務器;以windows事件的形式記錄等等。這些日志保存方式可以組合使用,每種方式可以設置自己的日志級別以及日志格式。日志模塊的內容比較多,今天先學習logging模塊的基本使用,下次具體學習日志的處理。
先看一個比較簡單的例子,讓我們對logging模塊有個感性的認識:
?
1 2 3 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個主要的組件
logger: 日志類,應用程序往往通過調用它提供的api來記錄日志;
handler: 對日志信息處理,可以將日志發送(保存)到不同的目標域中;
filter: 對日志信息進行過濾;
formatter:日志的格式化;
日志級別
在記錄日志時, 日志消息都會關聯一個級別(“級別”本質上是一個非負整數)。系統默認提供了6個級別,它們分別是:
可以給日志對象(Logger Instance)設置日志級別,低於該級別的日志消息將會被忽略,也可以給Hanlder設置日志級別,對於低於該級別的日志消息, Handler也會忽略。
logging模塊中的常用函數:
logging.basicConfig([**kwargs]):
為日志模塊配置基本信息。kwargs 支持如下幾個關鍵字參數:
filename :日志文件的保存路徑。如果配置了些參數,將自動創建一個FileHandler作為Handler;
filemode :日志文件的打開模式。 默認值為'a',表示日志消息以追加的形式添加到日志文件中。如果設為'w', 那麼每次程序啟動的時候都會創建一個新的日志文件;
format :設置日志輸出格式;
datefmt :定義日期格式;
level :設置日志的級別.對低於該級別的日志消息將被忽略;
stream :設置特定的流用於初始化StreamHandler;
下面是一個簡單的例子:
?
1 2 3 4 5 6 7 8 9 10 11 12 13 14 #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名稱來體現,如:
?
1 2 3 4 5 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)
獲取日志級別對應的名稱。例如:
?
1 2 3 4 5 6 7 8 9 10 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方法:
?
1 2 3 4 5 6 7 8 9 10 #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分別是格式參數。
?
1 2 3 4 5 6 7 8 9 10 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通過用在異常處理塊中,如:
?
1 2 3 4 5 6 7 8 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對象,並在日志類內處理。