Python logging模塊handlers用法詳解

更新時間：2020年08月14日 11:55:16 作者：藍寅

這篇文章主要介紹了Python logging模塊handlers用法詳解,文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下

一、handlers是什么？

logging模塊中包含的類

用來自定義日志對象的規(guī)則（比如：設(shè)置日志輸出格式、等級等）

常用3個子類：StreamHandler、FileHandler、TimedRotatingFileHandler

二、handlers基礎(chǔ)應(yīng)用

2.1 StreamHandler 控制臺輸出日志

import logging

#創(chuàng)建一個logger日志對象
logger = logging.getLogger('test_logger')
logger.setLevel(logging.DEBUG)  #設(shè)置默認的日志級別

#創(chuàng)建日志格式對象
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

#創(chuàng)建StreamHandler對象
sh = logging.StreamHandler()
#StreamHandler對象自定義日志級別
sh.setLevel(logging.DEBUG)
#StreamHandler對象自定義日志格式
sh.setFormatter(formatter)

logger.addHandler(sh)  #logger日志對象加載StreamHandler對象
#日志輸出
logger.info('newdream')

上面代碼執(zhí)行后，會在控制臺輸出日志信息。

2.2 FileHandler 日志輸出到文件

import logging

#創(chuàng)建一個logger日志對象
logger = logging.getLogger('test_logger')
logger.setLevel(logging.DEBUG)  #設(shè)置默認的日志級別

#創(chuàng)建日志格式對象
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

#創(chuàng)建FileHandler對象
fh = logging.FileHandler('test.log')
#FileHandler對象自定義日志級別
fh.setLevel(logging.DEBUG)
#FileHandler對象自定義日志格式
fh.setFormatter(formatter)

logger.addHandler(fh)  #logger日志對象加載FileHandler對象
#日志輸出
logger.info('newdream')

上面代碼執(zhí)行后，控制臺不會輸出日志信息，而會在當(dāng)前文件夾新建一個test.log日志文件進行日志記錄。

2.3 TimedRotatingFileHandler 日志分割

import logging
from logging import handlers

#創(chuàng)建一個logger日志對象
logger = logging.getLogger('test_logger')
logger.setLevel(logging.DEBUG)  #設(shè)置默認的日志級別

#創(chuàng)建日志格式對象
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

#創(chuàng)建TimedRotatingFileHandler對象
rh = handlers.TimedRotatingFileHandler("test.log", when='S', interval=1, backupCount=5)
#TimedRotatingFileHandler對象自定義日志級別
rh.setLevel(logging.DEBUG)
#TimedRotatingFileHandler對象自定義日志級別
rh.suffix = "%Y_%m_%d_%H_%M_%S.log"
#TimedRotatingFileHandler對象自定義日志格式
rh.setFormatter(formatter)

logger.addHandler(rh)  #logger日志對象加載TimedRotatingFileHandler對象
#日志輸出
logger.info('newdream')

上面代碼執(zhí)行后，控制臺不會輸出日志信息，而會在當(dāng)前文件夾新建一個 test_年_月_日_時_分_秒.log 日志文件進行日志記錄。

在使用TimedRotatingFileHandler創(chuàng)建對象時，它的構(gòu)造函數(shù)定義如下：

TimedRotatingFileHandler(filename [,when [,interval [,backupCount]]])
filename：是輸出日志文件名的前綴，比如log/myapp.log
when：按什么日期格式切分，接收指定字符串參數(shù)，接收的值如下：

“S”: Seconds
“M”: Minutes
“H”: Hours
“D”: Days
“W”: Week day (0=Monday)
“midnight”: Roll over at midnight

interval 是指等待多少個單位when的時間后，Logger會自動重建文件，這個文件的創(chuàng)建取決于filename+suffix，若這個文件跟之前的文件有重名，則會自動覆蓋掉以前的文件，所以有些情況suffix要定義不能因為when而重復(fù)。
backupCount 是保留日志個數(shù)。默認的0是不會自動刪除掉日志。若設(shè)為5，則在文件的創(chuàng)建過程中庫會判斷是否有超過這個5，若超過，則會從最先創(chuàng)建的開始刪除。

三、小結(jié)

以上的日志實例為了讓讀者更清晰的操作和理解，分開代碼單獨實現(xiàn)

在 2.3 中如果想實現(xiàn)看是否達到5個日志就刪除的效果，可以把日志用循環(huán)輸出，如下：