使用Python腳本日誌功能

　假設要開發一個自動化腳本工具，工程結構如下，Common這個package是框架功能的實現，Scripts目錄是我們寫的測試案例腳本（請忽略其他不相關的目錄）。

　　我們對日誌功能的需求如下：

　　     1 為了方便日誌的查看，每個腳本對應一個日誌文件，日誌檔案以腳本的名字命名

　　     2 日誌路徑以及每個腳本保存的日誌容量可以設置，例如設置為5MB，則超過後最舊日誌被自動覆蓋

　　     3 日誌功能要使用方便，減少與框架業務功能的耦合

　　

　　現在來逐一分析上述需求。

　　1 要實現每個腳本一個日誌文件，則需要在日誌模組中，根據用例腳本的名字來產生日誌文件，這裡的關鍵問題是在日誌模組中如何取得用例腳本的名字。

　　取得檔案名稱的常用方法有：os.getcwd(), sys.argv[0], __file__，來看下各種的作用：

　　先在一個檔案(假設為test.py）中寫如下程式碼：

　　

　　然後在另一個檔案中（假設為script1.py）中import test#，然後呼叫func方法：

　　

#　　運行script1.py，結果為：

　　

#　　可見，os.getcwd()取得的是執行腳本的目錄， sys.argv[0]是執行腳本的絕對路徑名， __file__是被執行程式碼所在檔案的絕對路徑名。

　　現在就清楚了，我們應該用sys.argv[0]來取得執行腳本的名字，由於取得到的是絕對路徑，需要做一點處理：sys .argv[0].split('/')[-1].split('.')[0]

##　　

2 日誌容量問題，要實現超過容量後自動覆蓋最舊日誌，採用logging中的RotatingFileHandler類別即可，可以設定日誌檔案的大小，以及備份個數。

　　那麼日誌路徑和容量配置放在哪裡呢？讓使用者直接修改

RotatingFileHandler的參數顯然不好，最好不要讓使用者修改框架文件，使用者只需呼叫介面寫自己的腳本即可。

　　這裡採用的方案是將配置資訊寫入一個文件，XML文件比較適合用來作為配置文件，用戶透過修改XML文件來製定配置，日誌模組從XML文件讀取參數。

　　這裡為了方便將XML檔案放入

Common下面，命名為config.xml，內容為：

<?xml version="1.0" encoding="utf-8"?>

<config>
  <!-- 日志保存路径 -->
  <logpath>E:\PythonLog</logpath>

  <!-- 每个脚本对应的日志文件大小，单位MB -->
  <logsize>8</logsize>

  <!-- 每个脚本保存的日志文件个数 -->
  <lognum>3</lognum>
</config>

　　讀取XML檔案內容，使用

lxml函式庫非常簡單，後面再給程式碼。

　　

　　

3 日誌功能要使用方便，減少與框架業務功能的耦合，最好就是對日誌功能進行封裝，只提供記錄日誌的介面即可。

　　日誌接口採用類方法的形式就可以滿足上述要求，用戶只需要通過類調用日誌記錄接口，隨處調用，使用方便，並且無需定義類實例，與框架業務沒有耦合。　　　　

　　有了上述分析，我們來實作日誌模組。

　　由於日誌功能也是框架基礎的一部分，我們將日誌模組也放在

Common這個package中，在Common下新建log.py文件，程式碼如下：

# coding: utf-8

from lxml import etree
import logging.handlers
import logging
import os
import sys

# 提供日志功能
class logger:
  # 先读取XML文件中的配置数据
  # 由于config.xml放置在与当前文件相同的目录下，因此通过 __file__ 来获取XML文件的目录，然后再拼接成绝对路径
  # 这里利用了lxml库来解析XML
  root = etree.parse(os.path.join(os.path.dirname(__file__), 'config.xml')).getroot()
  # 读取日志文件保存路径
  logpath = root.find('logpath').text
  # 读取日志文件容量，转换为字节
  logsize = 1024*1024*int(root.find('logsize').text)
  # 读取日志文件保存个数
  lognum = int(root.find('lognum').text)

  # 日志文件名：由用例脚本的名称，结合日志保存路径，得到日志文件的绝对路径
  logname = os.path.join(logpath, sys.argv[0].split('/')[-1].split('.')[0])

  # 初始化logger
  log = logging.getLogger()
  # 日志格式，可以根据需要设置
  fmt = logging.Formatter('[%(asctime)s][%(filename)s][line:%(lineno)d][%(levelname)s] %(message)s', '%Y-%m-%d %H:%M:%S')

  # 日志输出到文件，这里用到了上面获取的日志名称，大小，保存个数
  handle1 = logging.handlers.RotatingFileHandler(logname, maxBytes=logsize, backupCount=lognum)
  handle1.setFormatter(fmt)
  # 同时输出到屏幕，便于实施观察
  handle2 = logging.StreamHandler(stream=sys.stdout)
  handle2.setFormatter(fmt)
  log.addHandler(handle1)
  log.addHandler(handle2)

  # 设置日志基本，这里设置为INFO，表示只有INFO级别及以上的会打印
  log.setLevel(logging.INFO)

  # 日志接口，用户只需调用这里的接口即可，这里只定位了INFO, WARNING, ERROR三个级别的日志，可根据需要定义更多接口
  @classmethod
  def info(cls, msg):
    cls.log.info(msg)
    return

  @classmethod
  def warning(cls, msg):
    cls.log.warning(msg)
    return

  @classmethod
  def error(cls, msg):
    cls.log.error(msg)
    return

#　　來測試一下，在腳本

script1和script2 中分別寫下面程式碼：

from Common.log import *

logger.info('This is info')
logger.warning('This is warning')
logger.error('This is error')

　　分別執行兩個腳本，控制台輸出為：

　　

　　產生的日誌文件：

　　

　　文件內容：

　　

更多使用Python腳本日誌功能相關文章請關注PHP中文網！