Python通過logging模塊提供日志功能，關於logging模塊的使用網絡上已經有很多詳細的資料，這里要分享的是怎樣在實際工程中使用日志功能。
假設要開發一個自動化腳本工具，工程結構如下，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 if __name__ == '__main__': logger.info('This is info') logger.warning('This is warning') logger.error('This is error')
來測試一下，在腳本script1和script2中分別編寫下面代碼：
if __name__ == '__main__':
logger.info('This is info')
logger.warning('This is warning')
logger.error('This is error')
分別運行兩個腳本，控制台輸出為：
產生的日志文件：
文件內容：
好了，現在不管是在框架的其他文件中，或是在用戶腳本中，都可以方便的通過logger類的日志接口記錄日志。