【拓展】Loguru：更为优雅、简洁的Python 日志管理模块

2023-12-04 05:04
文章标签 python 模块 日志 优雅 管理 拓展 简洁 loguru 更为

本文主要是介绍【拓展】Loguru：更为优雅、简洁的Python 日志管理模块，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

目录

一、简单介绍

二、安装与简单使用

​三、常见用法

3.1 显示格式

3.2 写入文件

3.3 json日志

3.4 日志绕接

3.5 并发安全

四、高级用法

4.1 接管标准日志logging

4.2 输出日志到网络服务器

4.2.1 自定义日志服务器

​4.2.2 第三方库日志服务器

4.3 与pytest结合

一、简单介绍

python中的日志库logging使用起来有点像log4j，但配置通常比较复杂，构建日志服务器时也不是方便。标准库logging的替代品是loguru，loguru使用起来就简单的多。

loguru默认的输出格式是：时间、级别、模块、行号以及日志内容。loguru不需要手动创建 logger，开箱即用，比logging使用方便得多；另外，日志输出内置了彩色功能，颜色和非颜色控制很方便，更加友好。

二、安装与简单使用

  • 使用 pip 安装即可，Python 3 版本的安装如下：
pip3 install loguru
  • 简单使用
    • 我们直接通过导入loguru 封装好的logger 类的实例化对象，不需要手动创建 logger，直接进行调用不同级别的日志输出方法。
from loguru import loggerlogger.debug('This is debug information')
logger.info('This is info information')
logger.warning('This is warn information')
logger.error('This is error information')

上述代码输出： 

 日志打印到文件的用法也很简单，代码如下：

from loguru import loggerlogger.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，也可以打印到文件中去。

三、常见用法

3.1 显示格式

loguru默认格式是时间、级别、名称+模块和日志内容，其中名称+模块是写死的，是当前文件的__name__变量，此变量最好不要修改。

工程比较复杂的情况下，自定义模块名称，是非常有用的，容易定界定位，避免陷入细节中。我们可以通过logger.configure手工指定模块名称。如下：

import sysfrom loguru import loggerlogger.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**：表示显示颜色。

上述代码的输出为：

 这里写死了模块名称，每个日志都这样设置也是比较繁琐。下面会介绍指定不同模块名称的方法。

3.2 写入文件

loguru默认格式是时间、级别、名称+模块和日志内容，其中名称+模块是写死的，是当前文件的__name__变量，此变量最好不要修改。

工程比较复杂的情况下，自定义模块名称，是非常有用的，容易定界定位，避免陷入细节中。我们可以通过logger.configure手工指定模块名称。如下：

import sysfrom loguru import loggerlogger.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')

 与3.1.唯一不同的地方，logger.configure新增了一个handler，写入到日志文件中去。用法很简单。

上述只是通过logger.configure设置日志格式，但是模块名不是可变的，实际项目开发中，不同模块写日志，需要指定不同的模块名称。因此，模块名称需要参数化，这样实用性更强。样例代码如下：

import sysfrom loguru import loggerlogger.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方法，实现module_name的参数化。bind返回一个日志对象，可以通过此对象进行日志输出，这样就可以实现不同模块的日志格式。

loguru中自定义模块名称的功能比标准日志库有点不同。通过bind方法，可以轻松实现标准日志logging的功能。而且，可以通过bind和logger.configure，轻松实现结构化日志。

上述代码的输出如下：

3.3 json日志

loguru保存成结构化json格式非常简单，只需要设置serialize=True参数即可。代码如下：

from loguru import loggerlogger.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')

输出内容如下：

3.4 日志绕接

loguru日志文件支持三种设置：循环、保留、压缩。设置也比较简单。尤其是压缩格式，支持非常丰富，常见的压缩格式都支持，比如："gz", "bz2", "xz", "lzma", "tar", "tar.gz", "tar.bz2", "tar.xz", "zip"。样例代码如下：

from loguru import loggerlogger.add("file_1.log", rotation="500 MB")  # 自动循环过大的文件
logger.add("file_2.log", rotation="12:00")  # 每天中午创建新文件
logger.add("file_3.log", rotation="1 week")  # 一旦文件太旧进行循环
logger.add("file_X.log", retention="10 days")  # 定期清理
logger.add("file_Y.log", compression="zip")  # 压缩节省空间

3.5 并发安全

loguru默认是线程安全的，但不是多进程安全的，如果使用了多进程安全，需要添加参数enqueue=True，样例代码如下：

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

四、高级用法

4.1 接管标准日志logging

更换日志系统或者设计一套日志系统，比较难的是兼容现有的代码，尤其是第三方库，因为不能因为日志系统的切换，而要去修改这些库的代码，也没有必要。好在loguru可以方便的接管标准的日志系统。

样例代码如下：

import logging
import logging.handlers
import sysfrom loguru import loggerhandler = logging.handlers.SysLogHandler(address=('localhost', 514))
logger.add(handler)class LoguruHandler(logging.Handler):def emit(self, record):try:level = logger.level(record.levelname).nameexcept ValueError:level = record.levelnoframe, depth = logging.currentframe(), 2while frame.f_code.co_filename == logging.__file__:frame = frame.f_backdepth += 1logger.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')# 使用标注日志系统输出
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系统输出
logger.info('hello world, that is from loguru')

输出为：

4.2 输出日志到网络服务器

如果有需要，不同进程的日志，可以输出到同一个日志服务器上，便于日志的统一管理。我们可以利用自定义或者第三方库进行日志服务器和客户端的设置。下面介绍两种日志服务器的用法。

4.2.1 自定义日志服务器

日志客户端段代码如下：

# client.py
import pickle
import socket
import struct
import timefrom loguru import loggerclass 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.recorddata = 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")

日志服务器代码如下：

# server.py
import pickle
import socketserver
import structfrom loguru import loggerclass LoggingStreamHandler(socketserver.StreamRequestHandler):def handle(self):while True:chunk = self.connection.recv(4)if len(chunk) < 4:breakslen = 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()

运行结果如下：

4.2.2 第三方库日志服务器

日志客户端代码如下：

# client.py
import zmq
from zmq.log.handlers import PUBHandler
from loguru import loggersocket = zmq.Context().socket(zmq.PUB)
socket.connect("tcp://127.0.0.1:12345")
handler = PUBHandler(socket)logger.add(handler)
logger.info("Logging from client")

日志服务器代码如下：

# server.py
import sys
import zmq
from loguru import loggersocket = 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())

4.3 与pytest结合

官方帮助中有一个讲解loguru与pytest结合的例子，讲得有点含糊不是很清楚。简单的来说，pytest有个fixture，可以捕捉被测方法中的logging日志打印，从而验证打印是否触发。

下面就详细讲述如何使用loguru与pytest结合的代码，如下：

import pytest
from _pytest.logging import LogCaptureFixture
from loguru import loggerdef 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 caploglogger.remove(handler_id)def test_some_func_logs_warning(caplog):assert some_func(-1, 3) == 2assert "Oh no!" in caplog.text

测试输出如下：

这篇关于【拓展】Loguru：更为优雅、简洁的Python 日志管理模块的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/452210。

相关文章

python: 多模块(.py)中全局变量的导入

python: 多模块(.py)中全局变量的导入

文章目录 global关键字可变类型和不可变类型数据的内存地址单模块(单个py文件)的全局变量示例总结 多模块(多个py文件)的全局变量from x import x导入全局变量示例 import x导入全局变量示例 总结 global关键字 global 的作用范围是模块(.py)级别： 当你在一个模块（文件）中使用 global 声明变量时，这个变量只在该模块的全局命名空
阅读更多...
康拓展开（hash算法中会用到）

康拓展开（hash算法中会用到）

康拓展开是一个全排列到一个自然数的双射（也就是某个全排列与某个自然数一一对应） 公式： X=a[n]*(n-1)!+a[n-1]*(n-2)!+...+a[i]*(i-1)!+...+a[1]*0! 其中,a[i]为整数,并且0<=a[i]<i,1<=i<=n。（a[i]在不同应用中的含义不同）； 典型应用： 计算当前排列在所有由小到大全排列中的顺序，也就是说求当前排列是第
阅读更多...
深入探索协同过滤：从原理到推荐模块案例

深入探索协同过滤：从原理到推荐模块案例

文章目录 前言一、协同过滤1. 基于用户的协同过滤（UserCF）2. 基于物品的协同过滤（ItemCF）3. 相似度计算方法 二、相似度计算方法1. 欧氏距离2. 皮尔逊相关系数3. 杰卡德相似系数4. 余弦相似度 三、推荐模块案例1.基于文章的协同过滤推荐功能2.基于用户的协同过滤推荐功能 前言     在信息过载的时代，推荐系统成为连接用户与内容的桥梁。本文聚焦于
阅读更多...
综合安防管理平台LntonAIServer视频监控汇聚抖动检测算法优势

综合安防管理平台LntonAIServer视频监控汇聚抖动检测算法优势

LntonAIServer视频质量诊断功能中的抖动检测是一个专门针对视频稳定性进行分析的功能。抖动通常是指视频帧之间的不必要运动，这种运动可能是由于摄像机的移动、传输中的错误或编解码问题导致的。抖动检测对于确保视频内容的平滑性和观看体验至关重要。 优势 1. 提高图像质量 - 清晰度提升：减少抖动，提高图像的清晰度和细节表现力，使得监控画面更加真实可信。 - 细节增强：在低光条件下，抖
阅读更多...
【Python编程】Linux创建虚拟环境并配置与notebook相连接

【Python编程】Linux创建虚拟环境并配置与notebook相连接

1.创建 使用 venv 创建虚拟环境。例如，在当前目录下创建一个名为 myenv 的虚拟环境： python3 -m venv myenv 2.激活 激活虚拟环境使其成为当前终端会话的活动环境。运行： source myenv/bin/activate 3.与notebook连接 在虚拟环境中，使用 pip 安装 Jupyter 和 ipykernel： pip instal
阅读更多...
【机器学习】高斯过程的基本概念和应用领域以及在python中的实例

【机器学习】高斯过程的基本概念和应用领域以及在python中的实例

引言 高斯过程（Gaussian Process，简称GP）是一种概率模型，用于描述一组随机变量的联合概率分布，其中任何一个有限维度的子集都具有高斯分布 文章目录 引言一、高斯过程1.1 基本定义1.1.1 随机过程1.1.2 高斯分布 1.2 高斯过程的特性1.2.1 联合高斯性1.2.2 均值函数1.2.3 协方差函数（或核函数） 1.3 核函数1.4 高斯过程回归（Gauss
阅读更多...
软考系统规划与管理师考试证书含金量高吗？

软考系统规划与管理师考试证书含金量高吗？

2024年软考系统规划与管理师考试报名时间节点： 报名时间：2024年上半年软考将于3月中旬陆续开始报名 考试时间：上半年5月25日到28日，下半年11月9日到12日 分数线：所有科目成绩均须达到45分以上（包括45分）方可通过考试 成绩查询：可在“中国计算机技术职业资格网”上查询软考成绩 出成绩时间：预计在11月左右 证书领取时间：一般在考试成绩公布后3~4个月，各地领取时间有所不同
阅读更多...
【学习笔记】 陈强-机器学习-Python-Ch15 人工神经网络（1）sklearn

【学习笔记】 陈强-机器学习-Python-Ch15 人工神经网络（1）sklearn

系列文章目录 监督学习：参数方法 【学习笔记】 陈强-机器学习-Python-Ch4 线性回归 【学习笔记】 陈强-机器学习-Python-Ch5 逻辑回归 【课后题练习】 陈强-机器学习-Python-Ch5 逻辑回归（SAheart.csv） 【学习笔记】 陈强-机器学习-Python-Ch6 多项逻辑回归 【学习笔记 及 课后题练习】 陈强-机器学习-Python-Ch7 判别分析 【学
阅读更多...
安全管理体系化的智慧油站开源了。

安全管理体系化的智慧油站开源了。

AI视频监控平台简介 AI视频监控平台是一款功能强大且简单易用的实时算法视频监控系统。它的愿景是最底层打通各大芯片厂商相互间的壁垒，省去繁琐重复的适配流程，实现芯片、算法、应用的全流程组合，从而大大减少企业级应用约95%的开发成本。用户只需在界面上进行简单的操作，就可以实现全视频的接入及布控。摄像头管理模块用于多种终端设备、智能设备的接入及管理。平台支持包括摄像头等终端感知设备接入，为整个平台提
阅读更多...
nudepy，一个有趣的 Python 库！

nudepy，一个有趣的 Python 库！

更多资料获取 📚 个人网站：ipengtao.com 大家好，今天为大家分享一个有趣的 Python 库 - nudepy。 Github地址：https://github.com/hhatto/nude.py 在图像处理和计算机视觉应用中，检测图像中的不适当内容（例如裸露图像）是一个重要的任务。nudepy 是一个基于 Python 的库，专门用于检测图像中的不适当内容。该
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2