python中更優(yōu)雅的記錄日志
前言
在以往我們使用日志冗澈,更多的是使用python
自帶的logging
模塊钦勘,它可以設(shè)置錯(cuò)誤等級(jí)、輸出方式等亚亲。
但使用方式相對(duì)比較復(fù)雜彻采,想要更好的使用需要如log4net
一樣單獨(dú)配置,這在python
中感覺(jué)不是很優(yōu)雅捌归。
下面介紹一個(gè)python
庫(kù):loguru
颊亮。guru
是印度語(yǔ)中大師的意思,loguru
直譯就是“日志大師”陨溅。
安裝使用
pip install loguru
快速上手
如圖logging
一樣终惑,loguru
也有定義日志等級(jí)。不同的日志等級(jí)门扇,輸出效果也不一樣(默認(rèn)的等級(jí)由低到高是DEBUG
雹有、INFO
、WARNING
臼寄、ERROR
霸奕、CRITICAL
,也可以自己使用level
函數(shù)定義)吉拳。
from loguru import logger
logger.debug("That's it, beautiful and simple logging!")
logger.info("this is a info message!")
類(lèi)似logging
中的logger.addHandler
质帅,loguru統(tǒng)一使用add
函數(shù)來(lái)管理格式、文件輸出、過(guò)濾等操作煤惩,它提供了許多參數(shù)來(lái)實(shí)現(xiàn)logger.addHandler
中的配置更加簡(jiǎn)單方便嫉嘀。
其中sink
是最重要的參數(shù),可以傳入不同的數(shù)據(jù)類(lèi)型魄揉。傳入文件路徑剪侮、文件句柄、sys.stderr
洛退、甚至logging
模塊的Handler
如FileHandler
瓣俯、StreamHandler
等,這樣就可以快速實(shí)現(xiàn)自定義的Handler
配置兵怯。
通過(guò)給remove
方法傳遞add
方法返回的對(duì)象彩匕, 可以刪除add
方法添加的sink
,這里的remove
并不是刪除test2.log
文件媒区,而是停止向該文件輸出日志推掸,需要需要繼續(xù)記錄日志則需要重新add
日志文件。
from loguru import logger
obj = logger.add(sink='info.txt', format="{time} {level} {message}", filter="my_module", level="INFO")
logger.info("That's it, beautiful and simple logging!")
logger.remove(obj)
用rotation
驻仅、retention
谅畅、compression
進(jìn)行日志窗口、更新噪服、壓縮管理毡泻。
logger.add("file_1.log", rotation="10 MB") # 日志文件的大小是10M,過(guò)大就會(huì)重新生成一個(gè)文件
logger.add("file_2.log", rotation="00:00") # 每天0點(diǎn)創(chuàng)建新日志文件
logger.add("file_3.log", rotation="1 week") # 自動(dòng)更新舊文件
logger.add("file_X.log", retention="3 days") # 每3天自動(dòng)清理舊文件
logger.add("file_Y.log", compression="zip") # zip壓縮文件
支持控制臺(tái)輸出添加顏色粘优, 除了基礎(chǔ)色仇味,loguru
甚至允許16進(jìn)制、RGB格式的顏色值和加粗雹顺、下劃線(xiàn)等樣式丹墨。
logger.add(sys.stdout, colorize=True, format="<green>{time}</green> <level>{message}</level>")
使用裝飾器@logger.catch
可以和logging
一樣使用logger.exception
函數(shù)來(lái)記錄異常信息。
@logger.catch
def my_function(x, y, z):
# An error? It's caught anyway!
return 1 / (x + y + z)
def func(a, b):
return a / b
def nested(c):
try:
func(5, c)
except ZeroDivisionError:
logger.exception("What?!")
nested(0)
使用exception
方法輸出的異常信息包含堆棧信息和當(dāng)前變量的值嬉愧,方便問(wèn)題定位贩挣。
2018-07-17 01:38:43.975 | ERROR | __main__:nested:10 - What?!
Traceback (most recent call last):
File "test.py", line 12, in <module>
nested(0)
└ <function nested at 0x7f5c755322f0>
> File "test.py", line 8, in nested
func(5, c)
│ └ 0
└ <function func at 0x7f5c79fc2e18>
File "test.py", line 4, in func
return a / b
│ └ 0
└ 5
ZeroDivisionError: division by zero
使用serialize
可以將日志轉(zhuǎn)換為JSON
格式,enqueue
可以保證多線(xiàn)程没酣、多進(jìn)程安全王财。
logger.add("somefile.log", serialize=True) # 序列化為json
logger.add("somefile.log", enqueue=True)
修改時(shí)間格式。
logger.add("file.log", format="{time:YYYY-MM-DD at HH:mm:ss} | {level} | {message}")