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