python+pytest接口自動化(15)-日誌管理模塊loguru簡介

python自帶日誌管理模塊logging，使用時可進行模塊化配置，詳細可參考博文Python日誌採集（詳細）。

但logging配置起來比較繁瑣，且在多進行多線程等場景下使用時，如果不經過特殊處理，則容易出現日誌丟失或記錄錯亂的情況。

python中有一個用起來非常簡便的第三方日誌管理模塊–loguru，不僅可以避免logging的繁瑣配置，而且可以很簡單地避免在logging中多進程多線程記錄日誌時出現的問題，甚至還可以自定義控制台輸出的日誌顏色。

接下來我們來學習怎麼使用loguru模塊進行日誌管理。

安裝

第三方模塊，需要先安裝，安裝命令如下：

pip install loguru

簡單示例

簡單使用示例如下：

from loguru import logger

# 日誌寫入文件則需使用add()方法，"../log/test.log"即日誌文件路徑，可自定義。
# 寫入文件的日誌里有中文的話，需要加上encoding="utf-8"，否則會顯示亂碼。
logger.add("../log/test.log", encoding="utf-8", rotation="500MB",
           enqueue=True, retention="7 days")

# 打印不同類型的日誌
logger.debug("這是一段debug級別日誌")
logger.info("這是一段info級別日誌")
logger.warning("這是一段warning級別日誌")
logger.critical("這是一段critical級別日誌")

上面的示例代碼運行之後，會在控制台打印如下日誌：

同時也會在 “../log/test.log” 路徑中寫入日誌，如下：

由以上結果可以看出：

loguru中直接提供了一個日誌記錄對象logger，拿來即用；
loguru默認的輸出格式為：時間 | 級別 | 模塊名 | 行號 | 日誌信息；
不同級別的日誌在控制台顯示顏色不一樣。

當然，在實際項目中我們還需要日誌管理器有更豐富的配置，loguru中的add()方法便具有強大的配置功能，接下來介紹add()方法提供的常用配置功能。

add()常用參數說明

loguru模塊源碼中add()方法的參數如下：

sink(官方文檔簡單翻譯如下)：

可以傳入類file對象，如sys.stderr或者open('test.log', 'w')。
可以傳入文件路徑str或pathlib，如示例代碼中的寫入日誌文件路徑。路徑可以使用一些附加參數對其進行參數化，如test_{time}.log，{time}即時間參數，創建文件時文件名稱中會加入時間。
可以傳入像lambda這樣的可調用函數的簡單函數，如lambda msg:print(msg)。這允許完全由用戶偏好和需求定義日誌記錄過程。
還可以是使用async def語句定義的異步協程函數。該函數返回的協程對象將使用loop.create_task()添加到事件循環中。在使用complete()結束循環之前，應該等待這些任務。
也支持傳入logging模塊的Handler，如FileHandler、StreamHandler等，Loguru記錄會自動轉換為日誌模塊預期的結構。

level：發送到sink的日誌消息的最低日誌級別，即輸出的最低日誌級別。

format：定義日誌的輸出格式。

filter：過濾日誌。

colorize：終端日誌輸出的顏色。

serializer：bool值，輸出日誌時是否先格式化成JSON數據格式。

backtrace：bool值，是否進行異常跟蹤（即backtrace信息記錄）。

diagnose：bool值，異常跟蹤是否應顯示變量值以簡化調試。在生產中應將其設置為False，以避免泄漏敏感數據。

enqueue：bool值，日誌消息輸出之前是否先通過多進程安全隊列，多進程多線程運行寫入日誌時需用到，避免日誌記錄丟失或混亂。

catch：bool值，是否自動捕獲接收器處理日誌消息時發生的錯誤。如果為True，則在sys上顯示異常消息。

繼續看loguru模塊源碼，如下：

即我們需要將日誌寫入指定的文件時，可以使用截圖中新增的參數。常用的參數說明如下：

rotation：指定日誌文件記錄條件，日誌輸出太多需要隔一段時間寫入新文件時適用。

# rotation指定日誌文件最大為500MB，超過則新建文件記錄日誌
logger.add("../log/test.log", rotation="500MB")

# 指定每天12:00新建日誌記錄文件：rotation="12:00"
# 指定每隔10天新建日誌記錄文件：rotation="10 days"
# 指定每隔一個星期新建日誌記錄文件：rotation="1 week"
# 指定每隔兩個月新建日誌記錄文件：rotation="2 months"

retention：指定日誌保留時長，會清除超過指定時長的數據。

# rotation指定日誌保留時長，如"1 week", "3 days", "2 months"
logger.add("../log/test.log", retention="10 days")

compression：配置文件壓縮格式。

# rotation指定日誌保留時長，如"gz", "bz2", "xz", "lzma", "tar", "tar.gz", "tar.bz2", "tar.xz", "zip"
logger.add("../log/test.log", compression="zip")

encoding：指定寫入文件時的編碼格式，這在示例代碼中已說明。

使用

接下來，我們使用常用的參數來組合定義日誌記錄方式。

from loguru import logger
import sys

# format建議直接使用默認的格式
logger.add("../log/test_{time}.log", level="INFO", encoding="utf-8", enqueue=True, rotation="500MB", retention="1 week")

# 當然也可以自定義format，如下示例
# logger.add("../log/test_{time}.log", 
			format="{time:YYYY-MM-DD HH:mm:ss} | {level} | {name} | {line} | {message}", encoding="utf-8", 				enqueue=True, rotation="500MB", retention="1 week")

# 打印不同類型的日誌
logger.debug("這是一段debug級別日誌")
logger.info("這是一段info級別日誌")
logger.warning("這是一段warning級別日誌")
logger.critical("這是一段critical級別日誌")

參數說明：

sink="../log/test_{time}.log"，即指定日誌文件路徑，且加入了{time}，創建.log文件時名稱會加上時間。
level="INFO"，寫入文件時只會寫入INFO及以上級別的日誌 (需要大寫)，即INFO、WARNING、CRITICAL。
encoding="utf-8"，日誌寫入文件時指定編碼格式為”utf-8″，否則有中文的話會顯示亂碼。
enqueue=True，支持多線程多進程執行時按照隊列寫入。
rotation="500MB"，日誌文件最大為500MB，超過則新建。
retention="1 week"，日誌保留一周，過後則清除。
format沒有指定即使用默認格式，建議直接使用默認的格式，見代碼注釋。

執行代碼後，結果如下：

從結果中可以看出來，輸出內容中模塊部分顯示的是如__main__:<module>:20的形式，而並不是我們想要看到的對應的模塊名稱，這是因為直接執運行了當前文件的文件，如果是其他模塊調用執行便會顯示對應的模塊名稱。

Tags: Python+Pytest接口自動化接口自動化