Python中l(wèi)oguru日志庫的使用
1.概述
python中的日志庫logging使用起來有點像log4j，但配置通常比較復(fù)雜，構(gòu)建日志服務(wù)器時也不是方便。標準庫logging的替代品是loguru，loguru使用起來就簡單的多。
loguru默認的輸出格式是：時間、級別、模塊、行號以及日志內(nèi)容。loguru不需要手動創(chuàng)建 logger，開箱即用，比logging使用方便得多；另外，日志輸出內(nèi)置了彩色功能，顏色和非顏色控制很方便，更加友好。
loguru是非標準庫，需要事先安裝，命令是：**pip3 install loguru****。**安裝后，最簡單的使用樣例如下：
from loguru import logger
logger.debug('hello, this debug loguru')
logger.info('hello, this is info loguru')
logger.warning('hello, this is warning loguru')
logger.error('hello, this is error loguru')
logger.critical('hello, this is critical loguru')上述代碼輸出：
日志打印到文件的用法也很簡單，代碼如下：
from loguru import logger
logger.add('myloguru.log')
logger.debug('hello, this debug loguru')
logger.info('hello, this is info loguru')
logger.warning('hello, this is warning loguru')
logger.error('hello, this is error loguru')
logger.critical('hello, this is critical loguru')上述代碼運行時，可以打印到console，也可以打印到文件中去。
2.常見用法
2.1.顯示格式
loguru默認格式是時間、級別、名稱+模塊和日志內(nèi)容，其中名稱+模塊是寫死的，是當(dāng)前文件的__name__變量，此變量最好不要修改。
工程比較復(fù)雜的情況下，自定義模塊名稱，是非常有用的，容易定界定位，避免陷入細節(jié)中。我們可以通過logger.configure手工指定模塊名稱。如下如下：
import sys
from loguru import logger
logger.configure(handlers=[
{
"sink": sys.stderr,
"format": "{time:YYYY-MM-DD HH:mm:ss.SSS} |<lvl>{level:8}</>| {name} : {module}:{line:4} | <cyan>mymodule</> | - <lvl>{message}</>",
"colorize": True
},
])
logger.debug('this is debug')
logger.info('this is info')
logger.warning('this is warning')
logger.error('this is error')
logger.critical('this is critical')
handlers：表示日志輸出句柄或者目的地，sys.stderr表示輸出到命令行終端。
"sink": sys.stderr，表示輸出到終端
"format":表示日志格式化。<lvl>{level:8}</>表示按照日志級別顯示顏色。8表示輸出寬度為8個字符。
"colorize":True**：表示顯示顏色。
上述代碼的輸出為：
這里寫死了模塊名稱，每個日志都這樣設(shè)置也是比較繁瑣。下面會介紹指定不同模塊名稱的方法。
2.2.寫入文件
日志一般需要持久化，除了輸出到命令行終端外，還需要寫入文件。標準日志庫可以通過配置文件配置logger，在代碼中也可以實現(xiàn)，但過程比較繁瑣。loguru相對而已就顯得稍微簡單一些，我們看下在代碼中如何實現(xiàn)此功能。日志代碼如下：
import sys
from loguru import logger
logger.configure(handlers=[
{
"sink": sys.stderr,
"format": "{time:YYYY-MM-DD HH:mm:ss.SSS} |<lvl>{level:8}</>| {name} : {module}:{line:4} | <cyan>mymodule</> | - <lvl>{message}</>",
"colorize": True
},
{
"sink": 'first.log',
"format": "{time:YYYY-MM-DD HH:mm:ss.SSS} |{level:8}| {name} : {module}:{line:4} | mymodule | - {message}",
"colorize": False
},
])
logger.debug('this is debug')
logger.info('this is info')
logger.warning('this is warning')
logger.error('this is error')
logger.critical('this is critical')與2.1.唯一不同的地方，
logger.configure新增了一個handler，寫入到日志文件中去。用法很簡單。
上述只是通過logger.configure設(shè)置日志格式，但是模塊名不是可變的，實際項目開發(fā)中，不同模塊寫日志，需要指定不同的模塊名稱。因此，模塊名稱需要參數(shù)化，這樣實用性更強。樣例代碼如下：
import sys
from loguru import logger
logger.configure(handlers=[
{
"sink": sys.stderr,
"format": "{time:YYYY-MM-DD HH:mm:ss.SSS} |<lvl>{level:8}</>| {name} : {module}:{line:4} | <cyan>{extra[module_name]}</> | - <lvl>{message}</>",
"colorize": True
},
{
"sink": 'first.log',
"format": "{time:YYYY-MM-DD HH:mm:ss.SSS} |{level:8}| {name} : {module}:{line:4} | {extra[module_name]} | - {message}",
"colorize": False
},
])
log = logger.bind(module_name='my-loguru')
log.debug("this is hello, module is my-loguru")
log2 = logger.bind(module_name='my-loguru2')
log2.info("this is hello, module is my-loguru2")
logger.bind(module_name='my-loguru')通過bind方法，實現(xiàn)module_name的參數(shù)化。bind返回一個日志對象，可以通過此對象進行日志輸出，這樣就可以實現(xiàn)不同模塊的日志格式。loguru中自定義模塊名稱的功能比標準日志庫有點不同。通過bind方法，可以輕松實現(xiàn)標準日志
logging的功能。而且，可以通過bind和logger.configure，輕松實現(xiàn)結(jié)構(gòu)化日志。
上述代碼的輸出如下：
2.3.json日志
loguru保存成結(jié)構(gòu)化json格式非常簡單，只需要設(shè)置serialize=True參數(shù)即可。代碼如下：
from loguru import logger
logger.add('json.log', serialize=True, encoding='utf-8')
logger.debug('this is debug message')
logger.info('this is info message')
logger.error('this is error message')
輸出內(nèi)容如下：
2.4.日志繞接
loguru日志文件支持三種設(shè)置：循環(huán)、保留、壓縮。設(shè)置也比較簡單。尤其是壓縮格式，支持非常豐富，常見的壓縮格式都支持，比如："gz", "bz2", "xz", "lzma", "tar", "tar.gz", "tar.bz2", "tar.xz", "zip"。樣例代碼如下：
from loguru import logger
logger.add("file_1.log", rotation="500 MB") # 自動循環(huán)過大的文件
logger.add("file_2.log", rotation="12:00") # 每天中午創(chuàng)建新文件
logger.add("file_3.log", rotation="1 week") # 一旦文件太舊進行循環(huán)
logger.add("file_X.log", retention="10 days") # 定期清理
logger.add("file_Y.log", compression="zip") # 壓縮節(jié)省空間
2.5.并發(fā)安全
loguru默認是線程安全的，但不是多進程安全的，如果使用了多進程安全，需要添加參數(shù)enqueue=True，樣例代碼如下：
logger.add("somefile.log", enqueue=True)
loguru另外還支持協(xié)程，有興趣可以自行研究。
3.高級用法
3.1.接管標準日志logging
更換日志系統(tǒng)或者設(shè)計一套日志系統(tǒng)，比較難的是兼容現(xiàn)有的代碼，尤其是第三方庫，因為不能因為日志系統(tǒng)的切換，而要去修改這些庫的代碼，也沒有必要。好在loguru可以方便的接管標準的日志系統(tǒng)。
樣例代碼如下：
import logging
import logging.handlers
import sys
from loguru import logger
handler = logging.handlers.SysLogHandler(address=('localhost', 514))
logger.add(handler)
class LoguruHandler(logging.Handler):
def emit(self, record):
try:
level = logger.level(record.levelname).name
except ValueError:
level = record.levelno
frame, depth = logging.currentframe(), 2
while frame.f_code.co_filename == logging.__file__:
frame = frame.f_back
depth += 1
logger.opt(depth=depth, exception=record.exc_info).log(level, record.getMessage())
logging.basicConfig(handlers=[LoguruHandler()], level=0, format='%(asctime)s %(filename)s %(levelname)s %(message)s',
datefmt='%Y-%M-%D %H:%M:%S')
logger.configure(handlers=[
{
"sink": sys.stderr,
"format": "{time:YYYY-MM-DD HH:mm:ss.SSS} |<lvl>{level:8}</>| {name} : {module}:{line:4} | [ModuleA] | - <lvl>{message}</>",
"colorize": True
},
])
log = logging.getLogger('root')
# 使用標注日志系統(tǒng)輸出
log.info('hello wrold, that is from logging')
log.debug('debug hello world, that is from logging')
log.error('error hello world, that is from logging')
log.warning('warning hello world, that is from logging')
# 使用loguru系統(tǒng)輸出
logger.info('hello world, that is from loguru')
輸出為：
3.2.輸出日志到網(wǎng)絡(luò)服務(wù)器
如果有需要，不同進程的日志，可以輸出到同一個日志服務(wù)器上，便于日志的統(tǒng)一管理。我們可以利用自定義或者第三方庫進行日志服務(wù)器和客戶端的設(shè)置。下面介紹兩種日志服務(wù)器的用法。
3.2.1.自定義日志服務(wù)器
日志客戶端段代碼如下：
# client.py
import pickle
import socket
import struct
import time
from loguru import logger
class SocketHandler:
def __init__(self, host, port):
self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
self.sock.connect((host, port))
def write(self, message):
record = message.record
data = pickle.dumps(record)
slen = struct.pack(">L", len(data))
self.sock.send(slen + data)
logger.configure(handlers=[{"sink": SocketHandler('localhost', 9999)}])
while True:
time.sleep(1)
logger.info("Sending info message from the client")
logger.debug("Sending debug message from the client")
logger.error("Sending error message from the client")
日志服務(wù)器代碼如下：
# server.py
import pickle
import socketserver
import struct
from loguru import logger
class LoggingStreamHandler(socketserver.StreamRequestHandler):
def handle(self):
while True:
chunk = self.connection.recv(4)
if len(chunk) < 4:
break
slen = struct.unpack('>L', chunk)[0]
chunk = self.connection.recv(slen)
while len(chunk) < slen:
chunk = chunk + self.connection.recv(slen - len(chunk))
record = pickle.loads(chunk)
level, message = record["level"].no, record["message"]
logger.patch(lambda record: record.update(record)).log(level, message)
server = socketserver.TCPServer(('localhost', 9999), LoggingStreamHandler)
server.serve_forever()
運行結(jié)果如下：
3.2.2.第三方庫日志服務(wù)器
日志客戶端代碼如下：
# client.py
import zmq
from zmq.log.handlers import PUBHandler
from loguru import logger
socket = zmq.Context().socket(zmq.PUB)
socket.connect("tcp://127.0.0.1:12345")
handler = PUBHandler(socket)logger.add(handler)
logger.info("Logging from client")
日志服務(wù)器代碼如下：
# server.py
import sys
import zmq
from loguru import logger
socket = zmq.Context().socket(zmq.SUB)
socket.bind("tcp://127.0.0.1:12345")
socket.subscribe("")
logger.configure(handlers=[{"sink": sys.stderr, "format": "{message}"}])
while True:
_, message = socket.recv_multipart()
logger.info(message.decode("utf8").strip())
3.3.與pytest結(jié)合
官方幫助中有一個講解loguru與pytest結(jié)合的例子，講得有點含糊不是很清楚。簡單的來說，pytest有個fixture，可以捕捉被測方法中的logging日志打印，從而驗證打印是否觸發(fā)。
下面就詳細講述如何使用loguru與pytest結(jié)合的代碼，如下：
import pytest
from _pytest.logging import LogCaptureFixture
from loguru import logger
def some_func(i, j):
logger.info('Oh no!')
logger.info('haha')
return i + j
@pytest.fixture
def caplog(caplog: LogCaptureFixture):
handler_id = logger.add(caplog.handler, format="{message}")
yield caplog
logger.remove(handler_id)
def test_some_func_logs_warning(caplog):
assert some_func(-1, 3) == 2
assert "Oh no!" in caplog.text
測試輸出如下：
附錄
1.官方幫助文檔：https://loguru.readthedocs.io/en/stable/index.html
到此這篇關(guān)于Python中l(wèi)oguru日志庫的使用的文章就介紹到這了,更多相關(guān)Python loguru日志庫內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
這篇文章主要介紹了python中g(shù)event庫的用法詳情，Greenlet全部運行在主程序操作系統(tǒng)的過程中，但是它們是協(xié)作調(diào)度的，文章圍繞主題展開詳細的內(nèi)容介紹，具有一定的參考價值2022-07-07
Python調(diào)用工具包實現(xiàn)發(fā)送郵件服務(wù)
這篇文章主要為大家詳細介紹了Python圖畫調(diào)用工具包實現(xiàn)發(fā)送郵件服務(wù)的功能，文中的示例代碼講解詳細，感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2023-05-05
今天小編就為大家分享一篇tensorflow 初始化未初始化的變量實例，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-02-02
Python api構(gòu)建tensorrt加速模型的步驟詳解
小編個人認為python比c++更容易讀并且已經(jīng)有很多包裝很好的科學(xué)運算庫（numpy，scikit等）,今天通過本文給大家分享Python api構(gòu)建tensorrt加速模型的步驟，感興趣的朋友一起看看吧2021-09-09
這篇文章主要介紹了python匿名函數(shù)用法,結(jié)合實例形式分析了Python匿名函數(shù)的特點、功能及相關(guān)使用方法,需要的朋友可以參考下2019-08-08
跟老齊學(xué)Python之集成開發(fā)環(huán)境(IDE)
IDE的全稱是：Integrated Development Environment，簡稱IDE，也稱為Integration Design Environment、Integration Debugging Environment，翻譯成中文叫做“集成開發(fā)環(huán)境”，在臺灣那邊叫做“整合開發(fā)環(huán)境”。2014-09-09
這篇文章主要介紹了如何通過python實現(xiàn)語音錄入識別,文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2020-01-01
這篇文章主要介紹了Python入門教程(四)Python注釋介紹,Python是一門非常強大好用的語言,也有著易上手的特性,本文為入門教程,需要的朋友可以參考下2023-04-04
Python中optionParser模塊的使用方法實例教程
這篇文章主要介紹了Python中optionParser模塊的使用方法,功能非常強大,需要的朋友可以參考下2014-08-08
詳解如何通過Python實現(xiàn)批量數(shù)據(jù)提取
每天面對成堆的發(fā)票，無論是發(fā)票還是承兌單據(jù)，抑或是其他各類公司數(shù)據(jù)要從照片、PDF等不同格式的內(nèi)容中提取，我們都有必要進行快速辦公的能力提升。本文就教你如何利用Python實現(xiàn)批量數(shù)據(jù)提取吧2023-03-03