python第三方非同步紀錄檔庫loguru簡介

2022-12-25 14:01:33

3.1 開箱即用
3.2 無需初始化，匯入函數即可使用
3.3 更容易的檔案紀錄檔記錄與轉存/保留/壓縮方式
3.4 更優雅的字串格式化輸出
3.5 可以線上程或主執行緒中捕獲異常
3.6 可以支援自定義顏色
3.7 支援非同步，且執行緒和多程序安全
3.8 支援異常完整性描述
3.9 更好的日期時間處理
3.10 支援郵件通知

四、總結

一、引言

在編寫偵錯Python程式碼過程中，我們經常需要記錄紀錄檔，通常我們會採用python自帶的內建標準庫logging，但是使用該庫，設定較為繁瑣。為了提升程式設計效率，本文重點介紹最近發現的一個寶藏第三方紀錄檔庫Loguru，該庫名字來自於印度語，含義為紀錄檔大師。

我們先來做個直觀的對比，來說明Loguru的優雅之處。使用python自帶的logging，樣例程式碼如下：

樣例輸出如下：

使用Loguru庫，樣例程式碼如下：

使用Loguru輸出紀錄檔，終端執行後出現帶顏色的紀錄檔，而且使用超級方便。

二、安裝loguru

直接使用pip進行安裝即可，命令如下：

pip install loguru

輸出到終端使用方式：

from loguru import logger
logger.debug("msg msg msg!")

輸出到檔案使用方式：

from loguru import logger
logger.add("file_name.log")
logger.debug("msg msg msg!")

三、特性

參考官方github，裡面給出了Loguru庫豐富的特性，這裡挑選幾個重要的特性進行講解

3.1 開箱即用

Loguru庫設計的初衷就在於追求有且僅有一個logger，為了使用方便，提前預置輸出樣式。如果需要列印紀錄檔僅需採取如下方式：

from loguru import logger
logger.debug("That's it, beautiful and simple logging!")

3.2 無需初始化，匯入函數即可使用

在Loguru中，我們如何自定義輸出樣式？如何過濾輸出資訊？如何設定紀錄檔級別？

答案是呼叫 add() 函數

logger.add(sys.stderr, format="{time} {level} {message}", filter="my_module", level="INFO")

範例如下：

from loguru import logger
logger.add("info.log", format="{time} {level} {message}", filter="", level="INFO")
logger.debug("This is a debug msg")
logger.info("This is a info msg")

我們檢視info.log，結果如下:

3.3 更容易的檔案紀錄檔記錄與轉存/保留/壓縮方式

我們可以通過簡單的設定，來讓紀錄檔儲存更加人性化。比如我們想要刪除老的紀錄檔，或者我們希望自動壓縮儲存好的紀錄檔，可以參考一下命令：

logger.add("file_1.log", rotation="500 MB")    # 檔案過大（超過500M）就會重新生成一個檔案
logger.add("file_2.log", rotation="12:00")     # 每天12點建立新檔案
logger.add("file_3.log", rotation="1 week")    # 檔案時間過長就會建立新檔案
logger.add("file_4.log", retention="10 days")  # 一段時間後會清空
logger.add("file_5.log", compression="zip")    # 儲存zip格式

3.4 更優雅的字串格式化輸出

Loguru庫對字串的處理功能更加強大，字串格式化輸出支援{} 來替換%，功能類似於str.format()

logger.info("If you're using Python {}, prefer {feature} of course!", 3.6, feature="f-strings")

3.5 可以線上程或主執行緒中捕獲異常

我們經常會遇到程式碼出現crash時，我們在log裡看不到任何錯誤的資訊。在Loguru庫中，可以通過 @logger.catch 裝飾器來確保發生異常時，將錯誤資訊儲存下來。

範例如下：

@logger.catch
def main(x, y, z):
    return x * y / z

res = main(1,2,0)
print(res)

3.6 可以支援自定義顏色

Loguru 是支援自定義顏色的，如果你不喜歡它預設的顏色，可以這麼改：

logger.add(sys.stdout, colorize=True, format="<green>{time}</green> <level>{message}</level>")

3.7 支援非同步，且執行緒和多程序安全

Loguru 預設情況下是執行緒安全的，但它不是多程序安全的。不過如果你需要多程序/非同步記錄紀錄檔，它也能支援，只需要新增一個 enqueue 引數：

logger.add("somefile.log", enqueue=True)

3.8 支援異常完整性描述

對於紀錄檔而言，沒有錯誤堆疊的紀錄檔是沒有靈魂的。Loguru 允許顯示整個堆疊資訊來幫助你發現問題（包括變數）。

logger.add("out.log", backtrace=True, diagnose=True)  # Caution, may leak sensitive data in prod

def func(a, b):
    return a / b

def nested(c):
    try:
        func(5, c)
    except ZeroDivisionError:
        logger.exception("What?!")

nested(0)

執行結果如下:

3.9 更好的日期時間處理

我們可以自定義日期輸出樣式，如下所示：

logger.add("file.log", format="{time:YYYY-MM-DD at HH:mm:ss} | {level} | {message}")  #定義日期樣式

3.10 支援郵件通知

Loguru 可以和強大的郵件通知模組 notifiers 庫結合使用，以在程式意外失敗時接收電子郵件，或傳送許多其他型別的通知。

import notifiers

params = {
    "username": "you@gmail.com",
    "password": "abc123",
    "to": "dest@gmail.com"
}

# 初始化時傳送一封郵件
notifier = notifiers.get_notifier("gmail")
notifier.notify(message="The application is running!", **params)

# 發生Error時，發郵件進行告警
from notifiers.logging import NotificationHandler

handler = NotificationHandler("gmail", defaults=params)
logger.add(handler, level="ERROR")

這樣設定之後，每次產生 Error 紀錄檔，程式都會自動向你的郵箱傳送告知郵件，真的是足夠人性化了。