首頁 > 軟體

python自定義封裝帶顏色的logging模組

2022-02-18 19:00:45

python 自定義封裝帶顏色的logging模組

自己在搭建python介面自動化框架 分享一些內容過程中想自己封裝一個logger方法 根據logging進行二次封裝 程式碼如下

import logging
import os
import time
import colorlog
from logging.handlers import RotatingFileHandler
# 建立檔案目錄
cur_path = os.path.dirname(os.path.realpath(__file__))  # log_path是存放紀錄檔的路徑
log_path = os.path.join(os.path.dirname(cur_path), 'logs')
if not os.path.exists(log_path): os.mkdir(log_path)  # 如果不存在這個logs資料夾,就自動建立一個
# 修改log儲存位置
timestamp = time.strftime("%Y-%m-%d", time.localtime())
logfile_name = '%s.log' % timestamp
logfile_path = os.path.join(log_path, logfile_name)
# 定義不同紀錄檔等級顏色
log_colors_config = {
   'DEBUG': 'bold_cyan',
   'INFO': 'bold_green',
   'WARNING': 'bold_yellow',
   'ERROR': 'bold_red',
   'CRITICAL': 'red',
}


class Logger(logging.Logger):
   def __init__(self, name, level='DEBUG', file=None, encoding='utf-8'):
       super().__init__(name)
       self.encoding = encoding
       self.file = file
       self.level = level
       # 針對所需要的紀錄檔資訊 手動調整顏色
       formatter = colorlog.ColoredFormatter(
           '%(log_color)s%(levelname)1.1s %(asctime)s %(reset)s| %(message_log_color)s%(levelname)-8s %(reset)s| %('
           'log_color)s[%(filename)s%(reset)s:%(log_color)s%(module)s%(reset)s:%(log_color)s%(funcName)s%('
           'reset)s:%(log_color)s%(''lineno)d] %(reset)s- %(white)s%(message)s',
           reset=True,
           log_colors=log_colors_config,
           secondary_log_colors={
               'message': {
                   'DEBUG': 'blue',
                   'INFO': 'blue',
                   'WARNING': 'blue',
                   'ERROR': 'red',
                   'CRITICAL': 'bold_red'
               }
           },
           style='%'
       )  # 紀錄檔輸出格式
       # 建立一個FileHandler,用於寫到本地
       rotatingFileHandler = logging.handlers.RotatingFileHandler(filename=logfile_path,
                                                                  maxBytes=1024 * 1024 * 50,
                                                                  backupCount=5)
       rotatingFileHandler.setFormatter(formatter)
       rotatingFileHandler.setLevel(logging.DEBUG)
       self.addHandler(rotatingFileHandler)
       # 建立一個StreamHandler,用於輸出到控制檯
       console = colorlog.StreamHandler()
       console.setLevel(logging.DEBUG)
       console.setFormatter(formatter)
       self.addHandler(console)
       self.setLevel(logging.DEBUG)


logger = Logger(name=logfile_path, file=logfile_path)

使用時我們只需要引入封裝好的類就行 直觀美麗大方~

# 引入封裝好的logger模組
from common.logger_handler import logger

def physical_strength(self, abnormal):
  """兌換體力異常通用方法"""
  if self.attrs.__contains__('costType'):
      attrs_Type = {
          "costType": abnormal,
          "count": self.attrs["count"]
      }
      response_Type = r().response(self.send_uid, self.code, self.event, attrs_Type)
      # 使用時直接呼叫logger.info()就行
      logger.info(f"physical_strength_{abnormal},response_Type:{response_Type}")
      assert response_Type["code"] != 0
      time.sleep(2)
      attrs_count = {
          "costType": self.attrs["costType"],
          "count": abnormal
      }
      response_count = r().response(self.send_uid, self.code, self.event, attrs_count)
      logger.info(f"physical_strength_{abnormal},response_count:{response_count}")
      assert response_count["code"] != 0
      time.sleep(2)
      attrs_all = {
          "costType": abnormal,
          "count": abnormal
      }
      response_all = r().response(self.send_uid, self.code, self.event, attrs_all)
      logger.info(f"physical_strength_{abnormal},response_all:{response_all}")
      assert response_all["code"] != 0
      time.sleep(2)
  else:
      attrs_count = {
          "count": abnormal
      }
      response_count = r().response(self.send_uid, self.code, self.event, attrs_count)
      logger.info(f"physical_strength_{abnormal},response_count:{response_count}")
      assert response_count["code"] != 0
      time.sleep(2)

效果:按照 日期/時間/紀錄檔等級/檔名稱/類/方法名稱/程式碼行數展示(這裡可以自己手動調整formatter引數 如果感覺展示太長的話)
%(levelno)s: 列印紀錄檔級別的數值
%(levelname)s: 列印紀錄檔級別名稱
%(pathname)s: 列印當前執行程式的路徑,其實就是sys.argv[0]
%(filename)s: 列印當前執行程式名
%(funcName)s: 列印紀錄檔的當前函數
%(lineno)d: 列印紀錄檔的當前行號
%(asctime)s: 列印紀錄檔的時間
%(thread)d: 列印執行緒ID
%(threadName)s: 列印執行緒名稱
%(process)d: 列印程序ID
%(message)s: 列印紀錄檔資訊

避坑:不要用這種方式去呼叫紀錄檔等級方法 會出現紀錄檔列印定位路徑錯誤 只能定位在log封裝類當前方法下

  def debug(self, message):
      self.__console('debug', message)

  def info(self, message):
      self.__console('info', message)

  def warning(self, message):
      self.__console('warning', message)

  def error(self, message):
      self.__console('error', message)
      

到此這篇關於python自定義封裝帶顏色的logging模組的文章就介紹到這了,更多相關python logging模組內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com!


IT145.com E-mail:sddin#qq.com