python3 logging模塊
很多程序都有記錄日誌的需求,並且日誌包含的信息有正常的程序訪問日誌還可能有錯誤,警告等信息輸出,python的logging模塊提供了標準的日誌接口,可以通過它存儲各種格式的日誌,日誌級別等級:critical > error > warning > info > debug
看下各個日誌級別代表什麽意思:
簡單講日誌打印到屏幕:
1 >>> import logging 2 >>> logging.debug(‘test debug‘) 3 >>> logging.info(‘test info‘) 4 >>> logging.warning(‘test warning‘) 5 WARNING:root:test warning 6 >>> logging.error(‘test error‘) 7 ERROR:root:test error 8 >>> logging.critical(‘test critical‘) 9 CRITICAL:root:test critical 10 >>>
默認情況下只顯示了大於等於WARNING級別的日誌。
靈活配置日誌級別,日誌格式,輸出位置:
1 import logging 2 logging.basicConfig(filename=‘app.log‘,level=logging.DEBUG,format=‘%(asctime)s %(filename)s[line:%(lineno)d] %(message)s‘,datefmt=‘%Y-%m-%d‘) 3 logging.info(‘test info‘) 4 logging.debug(‘test debug‘) 5 logging.warning(‘test warning‘) 6 logging.error(‘test error‘) 7 logging.critical(‘test critical‘)
查看輸出:
2017-07-17 logging模塊.py[line:7] test info
2017-07-17 logging模塊.py[line:8] test debug
2017-07-17 logging模塊.py[line:9] test warning
2017-07-17 logging模塊.py[line:10] test error
2017-07-17 logging模塊.py[line:11] test critical
在logging.basicConfig()函數中可通過具體參數來更改logging模塊默認行為,可用參數有 filename:用指定的文件名創建FiledHandler(後邊會具體講解handler的概念),這樣日誌會被存儲在指定的文件中。 filemode:文件打開方式,在指定了filename時使用這個參數,默認值為“a”還可指定為“w”。 format:指定handler使用的日誌顯示格式。 datefmt:指定日期時間格式。 level:設置rootlogger(後邊會講解具體概念)的日誌級別 stream:用指定的stream創建StreamHandler。可以指定輸出到sys.stderr,sys.stdout或者文件,默認為sys.stderr。若同時列出了filename和stream兩個參數,則stream參數會被忽略。
format參數中可能用到的格式化串: %(name)s Logger的名字 %(levelno)s 數字形式的日誌級別 %(levelname)s 文本形式的日誌級別 %(pathname)s 調用日誌輸出函數的模塊的完整路徑名,可能沒有 %(filename)s 調用日誌輸出函數的模塊的文件名 %(module)s 調用日誌輸出函數的模塊名 %(funcName)s 調用日誌輸出函數的函數名 %(lineno)d 調用日誌輸出函數的語句所在的代碼行 %(created)f 當前時間,用UNIX標準的表示時間的浮 點數表示 %(relativeCreated)d 輸出日誌信息時的,自Logger創建以 來的毫秒數 %(asctime)s 字符串形式的當前時間。默認格式是 “2003-07-08 16:49:45,896”。逗號後面的是毫秒 %(thread)d 線程ID。可能沒有 %(threadName)s 線程名。可能沒有 %(process)d 進程ID。可能沒有 %(message)s用戶輸出的消息
若要對logging進行更多靈活的控制,必須了解Logger,Handler,Formatter,Filter的概念:
logger提供了應用程序可以直接使用的接口;
handler將(logger創建的)日誌記錄發送到合適的目的輸出;
filter提供了細度設備來決定輸出哪條日誌記錄;
formatter決定日誌記錄的最終輸出格式。
logger
每個程序在輸出信息之前都要獲得一個Logger。Logger通常對應了程序的模塊名,比如聊天工具的圖形界面模塊可以這樣獲得它的Logger:
LOG=logging.getLogger(”chat.gui”)
而核心模塊可以這樣:
LOG=logging.getLogger(”chat.kernel”)
Logger.setLevel(lel):指定最低的日誌級別,低於lel的級別將被忽略。debug是最低的內置級別,critical為最高
Logger.addFilter(filt)、Logger.removeFilter(filt):添加或刪除指定的filter
Logger.addHandler(hdlr)、Logger.removeHandler(hdlr):增加或刪除指定的handler
Logger.debug()、Logger.info()、Logger.warning()、Logger.error()、Logger.critical():可以設置的日誌級別
handler
handler對象負責發送相關的信息到指定目的地。Python的日誌系統有多種Handler可以使用。有些Handler可以把信息輸出到控制臺,有些Logger可以把信息輸出到文件,還有些 Handler可以把信息發送到網絡上。如果覺得不夠用,還可以編寫自己的Handler。可以通過addHandler()方法添加多個多handler
Handler.setLevel(lel):指定被處理的信息級別,低於lel級別的信息將被忽略
Handler.setFormatter():給這個handler選擇一個格式
Handler.addFilter(filt)、Handler.removeFilter(filt):新增或刪除一個filter對象
每個Logger可以附加多個Handler。接下來我們就來介紹一些常用的Handler:
1) logging.StreamHandler
使用這個Handler可以向類似與sys.stdout或者sys.stderr的任何文件對象(file object)輸出信息。它的構造函數是:
StreamHandler([strm])
其中strm參數是一個文件對象。默認是sys.stderr
2) logging.FileHandler
和StreamHandler類似,用於向一個文件輸出日誌信息。不過FileHandler會幫你打開這個文件。它的構造函數是:
FileHandler(filename[,mode])
filename是文件名,必須指定一個文件名。
mode是文件的打開方式。參見Python內置函數open()的用法。默認是’a‘,即添加到文件末尾。
3) 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並不會被更名,而是被刪除。
4) logging.handlers.TimedRotatingFileHandler
這個Handler和RotatingFileHandler類似,不過,它沒有通過判斷文件大小來決定何時重新創建日誌文件,而是間隔一定時間就 自動創建新的日誌文件。重命名的過程與RotatingFileHandler類似,不過新的文件不是附加數字,而是當前時間。它的構造函數是:
TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]])
其中filename參數和backupCount參數和RotatingFileHandler具有相同的意義。
interval是時間間隔。
when參數是一個字符串。表示時間間隔的單位,不區分大小寫。它有以下取值:
S 秒
M 分
H 小時
D 天
W 每星期(interval==0時代表星期一)
midnight 每天淩晨
屏幕輸出和文件輸出例子:
1 import logging 2 logger = logging.getLogger() #定義對應的程序模塊名name,默認是root 3 #logger.setLevel(logging.DEBUG) #指定最低的日誌級別 4 ch = logging.StreamHandler() #日誌輸出到屏幕控制臺 5 ch.setLevel(logging.WARNING) #設置日誌等級 6 7 fh = logging.FileHandler(‘access.log‘)#向文件access.log輸出日誌信息 8 fh.setLevel(logging.INFO) #設置輸出到文件最低日誌級別 9 10 #create formatter 11 formatter = logging.Formatter(‘%(asctime)s %(name)s- %(levelname)s - %(message)s‘) #定義日誌輸出格式 12 13 #add formatter to ch and fh 14 ch.setFormatter(formatter) #選擇一個格式 15 fh.setFormatter(formatter) 16 17 logger.addHandler(ch) #增加指定的handler 18 logger.addHandler(fh) 19 # ‘application‘ code 20 logger.debug(‘debug message‘) 21 logger.info(‘info message‘) 22 logger.warn(‘warn message‘) 23 logger.error(‘error message‘) 24 logger.critical(‘critical message‘)
import logging,os BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) #獲取上級目錄的絕對路徑 log_dir = BASE_DIR + ‘/log/record.log‘ def get_logger(): fh = logging.FileHandler(log_dir,encoding=‘utf-8‘) #創建一個文件流並設置編碼utf8 logger = logging.getLogger() #獲得一個logger對象,默認是root logger.setLevel(logging.DEBUG) #設置最低等級debug fm = logging.Formatter("%(asctime)s --- %(message)s") #設置日誌格式 logger.addHandler(fh) #把文件流添加進來,流向寫入到文件 fh.setFormatter(fm) #把文件流添加寫入格式 return logger
python3 logging模塊