許多應用程式中都會有日誌模組，用於記錄系統在執行過程中的一些關鍵資訊，以便於對系統的執行狀況進行跟蹤。在.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個級別，它們分別是：
| 級別 | 對應的值 |
|---|---|
| CRITICAL | 50 |
| ERROR | 40 |
| WARNING | 30 |
| INFO | 20 |
| DEBUG | 10 |
| NOTSET | 0 |
可以給日誌物件(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 |
#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名稱來體現，如：
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 |
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 |
#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 |
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 |
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物件，並在日誌類內處理。