Loguru ：徹底解放你的日志記錄器

Loguru 一個能徹底解放你的日志記錄器。

它即插即用，具備多種方式滾動日志、自動壓縮日志文件、定時刪除等功能。

除此之外，多線程安全、高亮日志、日志告警等功能也不在話下。

下面就給大家介紹一下這個強大工具的基本使用方法。

Loguru 安裝方式很簡單，打開終端輸入：

pip install loguru

即可完成安裝。

1.即開即用

如果你需要輸出 debug 日志到終端，可以這么做：

from loguru import logger

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

其輸出自帶高亮：

如果你需要把日志輸出到文件，只需要這樣：

from loguru import logger
logger.add("file_{time}.log")
logger.debug("That's it, beautiful and simple logging!")

這樣就會在當前運行的文件夾下生成 file_當前時間.log 的日志文件：

2.滾動日志與壓縮

使用 Loguru 我們可輕易地實現滾動日志。

按時間滾動

比如按時間滾動，我們只需要在 logger.add 參數中添加一個 rotation 參數：

from loguru import logger
logger.add("file_2.log", rotation="12:00") # 每天12:00會創(chuàng)建一個新的文件
logger.debug("That's it, beautiful and simple logging!")

這樣，如果當前時間過了這個設定的時間，它就會生成一個新的日志文件。如果沒有則使用原來的日志文件：

如圖所示，過了設定的時間，則將原來的 file_2.log 重命名，并添加一個新的 file_2.log 文件。

按大小滾動

除了按時間滾動日志外，Loguru 還可以按日志大小滾動：

from loguru import logger
logger.add("file_1.log", rotation="1 MB") # 滾動大日志文件
logger.debug("That's it, beautiful and simple logging!")

這樣，一旦日志文件大小超過 1 MB 就會產生新的日志文件。

壓縮日志

如果你不想刪除原有日志文件，Loguru 還支持將日志直接壓縮：

from loguru import logger
logger.add("file_Y.log", compression="zip") # 壓縮日志

3.其他特性

自定義顏色

Loguru 是支持自定義顏色的，如果你不喜歡它默認的顏色，可以這么改：

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

類似于HTML標簽 標簽中間的文字將會被標記為綠色。

多進程安全

Loguru 默認情況下是線程安全的，但它不是多進程安全的。不過如果你需要多進程/異步記錄日志，它也能支持，只需要添加一個 enqueue 參數：

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

支持Backtrace

對于日志而言，沒有錯誤堆棧的日志是沒有靈魂的。Loguru 允許顯示整個堆棧信息來幫助你發(fā)現問題（包括變量）。

比如下面這個例子：

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)

日志將會是這樣的：

非常清晰明了。

郵件告警

Loguru 可以和強大的郵件通知模塊 notifiers 庫結合使用，以在程序意外失敗時接收電子郵件，或發(fā)送許多其他類型的通知。

import notifiers

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

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

# 發(fā)生Error日志時，發(fā)郵件進行警報
from notifiers.logging import NotificationHandler

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

這樣配置之后，每次產生 Error 日志，程序都會自動向你的郵箱發(fā)送告警，真的極其方便。

除了這些特性外，Loguru 還支持與 Python 原生的 Logging 模塊兼容使用，你可以將原始的標準日志記錄器記錄的所有信息轉移到Loguru中。