日誌模塊python loguru 下載 pip install loguru 開箱即用 Loguru 的主要概念是只有一個:logger from loguru import logger logger.info("This is log info!") logger.warning("This ...
日誌模塊python loguru
下載
pip install loguru
開箱即用
Loguru 的主要概念是只有一個:logger
from loguru import logger
logger.info("This is log info!")
logger.warning("This is log warn!")
logger.error("This is log error!")
logger.debug("This is log debug!")
可以看到不需要手動設置,Loguru 會提前配置一些基礎信息,自動輸出時間、日誌級別、模塊名、行號等信息,而且根據等級的不同,還自動設置了不同的顏色,方便觀察,真正做到了開箱即用!
如果想自定義日誌級別,自定義日誌格式,保存日誌到文件該怎麼辦?
與 logging 模塊不同,不需要 Handler,不需要 Formatter,只需要一個 add()
函數就可以了,
from loguru import logger
logger.add('test.log')
logger.debug('this is a debug')
我們不需要像 logging 模塊一樣再聲明一個 FileHandler 了,就一行 add()
語句搞定,運行之後會發現目錄下 test.log 裡面同樣出現了剛剛控制台輸出的 debug 信息。
與 add()
語句相反,remove()
語句可以刪除我們添加的配置:
from loguru import logger
log_file = logger.add('test.log')
logger.debug('This is log debug!')
logger.remove(log_file)
logger.debug('This is another log debug!')
完整參數
Loguru 對輸出到文件的配置有非常強大的支持,比如支持輸出到多個文件,分級別分別輸出,過大創建新文件,過久自動刪除等等。 下麵我們來詳細看一下 add()
語句的詳細參數:
基本語法:
add(sink, *, level='DEBUG', format='<green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green> | <level>{level: <8}</level> | <cyan>{name}</cyan>:<cyan>{function}</cyan>:<cyan>{line}</cyan> - <level>{message}</level>', filter=None, colorize=None, serialize=False, backtrace=True, diagnose=True, enqueue=False, catch=True, **kwargs)
基本參數
sink:可以是一個 file 對象,例如 sys.stderr 或 open('file.log', 'w'),也可以是 str 字元串或者 pathlib.Path 對象,即文件路徑,也可以是一個方法,可以自行定義輸出實現,也可以是一個 logging 模塊的 Handler,比如 FileHandler、StreamHandler 等,還可以是 coroutine function,即一個返回協程對象的函數等。
level:日誌輸出和保存級別。
format:日誌格式模板。
filter:一個可選的指令,用於決定每個記錄的消息是否應該發送到 sink。
colorize:格式化消息中包含的顏色標記是否應轉換為用於終端著色的 ansi 代碼,或以其他方式剝離。 如果沒有,則根據 sink 是否為 tty(電傳打字機縮寫) 自動做出選擇。
serialize:在發送到 sink 之前,是否應首先將記錄的消息轉換為 JSON 字元串。
backtrace:格式化的異常跟蹤是否應該向上擴展,超出捕獲點,以顯示生成錯誤的完整堆棧跟蹤。
diagnose:異常跟蹤是否應顯示變數值以簡化調試。建議在生產環境中設置 False,避免泄露敏感數據。
enqueue:要記錄的消息是否應在到達 sink 之前首先通過多進程安全隊列,這在通過多個進程記錄到文件時很有用,這樣做的好處還在於使日誌記錄調用是非阻塞的。
catch:是否應自動捕獲 sink 處理日誌消息時發生的錯誤,如果為 True,則會在 sys.stderr 上顯示異常消息,但該異常不會傳播到 sink,從而防止應用程式崩潰。
\kwargs:僅對配置協程或文件接收器有效的附加參數(見下文)。
當且僅當 sink 是協程函數時,以下參數適用:
loop:將在其中調度和執行非同步日誌記錄任務的事件迴圈。如果為 None,將使用 asyncio.get_event_loop() 返回的迴圈。
當且僅當 sink 是文件路徑時,以下參數適用:
rotation:一種條件,指示何時應關閉當前記錄的文件並開始新的文件。
*retention *:過濾舊文件的指令,在迴圈或程式結束期間會刪除舊文件。
compression:日誌文件在關閉時應轉換為的壓縮或存檔格式。
delay:是在配置 sink 後立即創建文件,還是延遲到第一條記錄的消息時再創建。預設為 False。
mode:內置 open() 函數的打開模式,預設為 a(以追加模式打開文件)。
buffering:內置 open() 函數的緩衝策略,預設為1(行緩衝文件)。
encoding:內置 open() 函數的文件編碼,如果 None,則預設為 locale.getpreferredencoding()。
\kwargs:其他傳遞給內置 open() 函數的參數。
這麼多參數可以見識到 add() 函數的強大之處,僅僅一個函數就能實
當且僅當 sink 是文件路徑時,以下參數適用:
rotation:一種條件,指示何時應關閉當前記錄的文件並開始新的文件。
*retention *:過濾舊文件的指令,在迴圈或程式結束期間會刪除舊文件。
compression:日誌文件在關閉時應轉換為的壓縮或存檔格式。
delay:是在配置 sink 後立即創建文件,還是延遲到第一條記錄的消息時再創建。預設為 False。
mode:內置 open() 函數的打開模式,預設為 a(以追加模式打開文件)。
buffering:內置 open() 函數的緩衝策略,預設為1(行緩衝文件)。
encoding:內置 open() 函數的文件編碼,如果 None,則預設為 locale.getpreferredencoding()。
rotation 日誌文件分隔
add()
函數的 rotation 參數,可以實現按照固定時間創建新的日誌文件,比如設置每天 0 點新創建一個 log 文件:
logger.add('runtime_{time}.log', rotation='00:00')
設置超過 500 MB 新創建一個 log 文件:
logger.add('runtime_{time}.log', rotation="500 MB")
設置每隔一個周新創建一個 log 文件:
logger.add('runtime_{time}.log', rotation='1 week')
retention 日誌保留時間
dd()
函數的 retention 參數,可以設置日誌的最長保留時間,比如設置日誌文件最長保留 15 天:
logger.add('runtime_{time}.log', retention='15 days')
設置日誌文件最多保留 10 個:
logger.add('runtime_{time}.log', retention=10)
也可以是一個 datetime.timedelta
對象,比如設置日誌文件最多保留 5 個小時:
import datetime
from loguru import logger
logger.add('runtime_{time}.log', retention=datetime.timedelta(hours=5))
compression 日誌壓縮格式
add()
函數的 compression 參數,可以配置日誌文件的壓縮格式,這樣可以更加節省存儲空間,比如設置使用 zip 文件格式保存:
logger.add('runtime_{time}.log', compression='zip')
其格式支持:gz
、bz2
、xz
、lzma
、tar
、tar.gz
、tar.bz2
、tar.xz
字元串格式化
Loguru 在輸出 log 的時候還提供了非常友好的字元串格式化功能,相當於 str.format()
:
logger.info('If you are using Python {}, prefer {feature} of course!', 3.6, feature='f-strings')
輸出:
2021-10-19 14:59:06.412 | INFO | __main__:<module>:3 - If you are using Python 3.6, prefer
異常追溯
在 Loguru 里可以直接使用它提供的裝飾器就可以直接進行異常捕獲,而且得到的日誌是無比詳細的:
from loguru import logger
@logger.catch
def my_function(x, y, z):
# An error? It's caught anyway!
return 1 / (x + y + z)
my_function(0, 0, 0)
日誌輸出:
Traceback (most recent call last):
> File "D:\python27\djku\sanbanfu\app01\tests.py", line 40, in <module>
my_function(0, 0, 0)
└ <function my_function at 0x000001CCC54F89D0>
File "D:\python27\djku\sanbanfu\app01\tests.py", line 37, in my_function
return 1 / (x + y + z)
│ │ └ 0
│ └ 0
└ 0
ZeroDivisionError: division by zero
在控制台的輸出是這樣的:
相關文獻
https://loguru.readthedocs.io/en/stable/