Python常用庫 - logging日誌庫
logging的簡單介紹
用作記錄日誌,預設分為六種日誌級別(括號為級別對應的數值)
- NOTSET(0)
- DEBUG(10)
- INFO(20)
- WARNING(30)
- ERROR(40)
- CRITICAL(50)
special
- 在自定義日誌級別時注意不要和預設的日誌級別數值相同
- logging 執行時輸出大於等於設定的日誌級別的日誌資訊,如設定日誌級別是 INFO,則 INFO、WARNING、ERROR、CRITICAL 級別的日誌都會輸出。
logging常見物件
- Logger:日誌,暴露函式給應用程式,基於日誌記錄器和過濾器級別決定哪些日誌有效。
- LogRecord :日誌記錄器,將日誌傳到相應的處理器處理。
- Handler :處理器, 將(日誌記錄器產生的)日誌記錄傳送至合適的目的地。
- Filter :過濾器, 提供了更好的粒度控制,它可以決定輸出哪些日誌記錄。
- Formatter:格式化器, 指明瞭最終輸出中日誌記錄的格式。
logging基本使用
logging 使用非常簡單,使用 basicConfig() 方法就能滿足基本的使用需要;如果方法沒有傳入引數,會根據預設的配置建立Logger 物件,預設的日誌級別被設定為 WARNING,該函式可選的引數如下表所示。
引數名稱 |
引數描述 |
---|---|
filename |
日誌輸出到檔案的檔名 |
filemode |
檔案模式,r[+]、w[+]、a[+] |
format |
日誌輸出的格式 |
datefat |
日誌附帶日期時間的格式 |
style |
格式佔位符,預設為 "%" 和 “{}” |
level |
設定日誌輸出級別 |
stream |
定義輸出流,用來初始化 StreamHandler 物件,不能 filename 引數一起使用,否則會ValueError 異常 |
handles |
定義處理器,用來建立 Handler 物件,不能和 filename 、stream 引數一起使用,否則也會丟擲 ValueError 異常 |
logging程式碼
1 logging.debug("debug") 2 logging.info("info") 3 logging.warning("warning") 4 logging.error("error")5 logging.critical("critical")
測試結果
1 WARNING:root:warning 2 ERROR:root:error 3 CRITICAL:root:critical
但是當發生異常時,直接使用無引數的 debug() 、 info() 、 warning() 、 error() 、 critical() 方法並不能記錄異常資訊,需要設定 exc_info=True 才可以,或者使用 exception() 方法,還可以使用 log() 方法,但還要設定日誌級別和 exc_info 引數
1 a = 5 2 b = 0 3 try: 4 c = a / b 5 except Exception as e: 6 # 下面三種方式三選一,推薦使用第一種 7 logging.exception("Exception occurred") 8 logging.error("Exception occurred", exc_info=True) 9 logging.log(level=logging.ERROR, msg="Exception occurred", exc_info=True)
logging之Formatter物件
Formatter 物件用來設定具體的輸出格式,常用格式如下表所示
格式 |
變數描述 |
---|---|
%(asctime)s |
將日誌的時間構造成可讀的形式,預設情況下是精確到毫秒,如 2018-10-13 23:24:57,832,可以額外指定 datefmt 引數來指定該變數的格式 |
%(name) |
日誌物件的名稱 |
%(filename)s |
不包含路徑的檔名 |
%(pathname)s |
包含路徑的檔名 |
%(funcName)s |
日誌記錄所在的函式名 |
%(levelname)s |
日誌的級別名稱 |
%(message)s |
具體的日誌資訊 |
%(lineno)d |
日誌記錄所在的行號 |
%(pathname)s |
完整路徑 |
%(process)d |
當前程序ID |
%(processName)s |
當前程序名稱 |
%(thread)d |
當前執行緒ID |
%threadName)s |
當前執行緒名稱 |
logging封裝類
1 #!/usr/bin/env python 2 # -*- coding: utf-8 -*- 3 4 """ 5 __title__ = logging工具類 6 __Time__ = 2019/8/8 19:26 7 """ 8 import logging 9 from logging import handlers 10 11 12 class Loggers: 13 __instance = None 14 15 def __new__(cls, *args, **kwargs): 16 if not cls.__instance: 17 cls.__instance = object.__new__(cls, *args, **kwargs) 18 return cls.__instance 19 20 def __init__(self): 21 # 設定輸出格式 22 formater = logging.Formatter( 23 '[%(asctime)s]-[%(levelname)s]-[%(filename)s]-[%(funcName)s:%(lineno)d] : %(message)s') 24 # 定義一個日誌收集器 25 self.logger = logging.getLogger('log') 26 # 設定級別 27 self.logger.setLevel(logging.DEBUG) 28 # 輸出渠道一 - 檔案形式 29 self.fileLogger = handlers.RotatingFileHandler("./test.log", maxBytes=5242880, backupCount=3) 30 31 # 輸出渠道二 - 控制檯 32 self.console = logging.StreamHandler() 33 # 控制檯輸出級別 34 self.console.setLevel(logging.DEBUG) 35 # 輸出渠道對接輸出格式 36 self.console.setFormatter(formater) 37 self.fileLogger.setFormatter(formater) 38 # 日誌收集器對接輸出渠道 39 self.logger.addHandler(self.fileLogger) 40 self.logger.addHandler(self.console) 41 42 def debug(self, msg): 43 self.logger.debug(msg=msg) 44 45 def info(self, msg): 46 self.logger.info(msg=msg) 47 48 def warn(self, msg): 49 self.logger.warning(msg=msg) 50 51 def error(self, msg): 52 self.logger.error(msg=msg) 53 54 def excepiton(self, msg): 55 self.logger.exception(msg=msg) 56 57 58 loggers = Loggers() 59 60 if __name__ == '__main__': 61 loggers.debug('debug') 62 loggers.info('info')
logzero封裝類
1 #!/usr/bin/env python 2 # -*- coding: utf-8 -*- 3 4 """ 5 __title__ = logzero日誌封裝類 6 __Time__ = 2019/8/8 19:26 7 """ 8 import logging 9 10 import logzero 11 from logzero import logger 12 13 14 class Logzero(object): 15 __instance = None 16 17 def __new__(cls, *args, **kwargs): 18 if not cls.__instance: 19 cls.__instance = object.__new__(cls, *args, **kwargs) 20 return cls.__instance 21 22 def __init__(self): 23 self.logger = logger 24 # console控制檯輸入日誌格式 - 帶顏色 25 self.console_format = '%(color)s' \ 26 '[%(asctime)s]-[%(levelname)1.1s]-[%(filename)s]-[%(funcName)s:%(lineno)d] 日誌資訊: %(message)s ' \ 27 '%(end_color)s ' 28 # 建立一個Formatter物件 29 self.formatter = logzero.LogFormatter(fmt=self.console_format) 30 # 將formatter提供給setup_default_logger方法的formatter引數 31 logzero.setup_default_logger(formatter=self.formatter) 32 33 # 設定日誌檔案輸出格式 34 self.formater = logging.Formatter( 35 '[%(asctime)s]-[%(levelname)s]-[%(filename)s]-[%(funcName)s:%(lineno)d] 日誌資訊: %(message)s') 36 # 設定日誌檔案等級 37 logzero.loglevel(logging.DEBUG) 38 # 輸出日誌檔案路徑和格式 39 logzero.logfile("F:\\imocInterface\\log/tests.log", formatter=self.formater) 40 41 def debug(self, msg): 42 self.logger.debug(msg=msg) 43 44 def info(self, msg): 45 self.logger.info(msg=msg) 46 47 def warning(self, msg): 48 self.logger.warning(msg=msg) 49 50 def error(self, msg): 51 self.logger.error(msg=msg) 52 53 def exception(self, msg): 54 self.logger.exception(msg=msg) 55 56 57 logzeros = Logzero() 58 59 if __name__ == '__main__': 60 logzeros.debug("debug") 61 logzeros.info("info") 62 logzeros.warning("warning") 63 logzeros.error("error") 64 a = 5 65 b = 0 66 try: 67 c = a / b 68 except Exception as e: 69 logzeros.exception("Exception occurred")
&n