Python 日志记录-loguru

最新推荐文章于 2025-04-13 18:00:52 发布
最新推荐文章于 2025-04-13 18:00:52 发布
阅读量1.3k 收藏 8
点赞数 2
分类专栏： Python新手入门 文章标签： python 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/yr1102358773/article/details/126032090
版权

Python 日志记录-loguru

引言

loguru是一个第三方库，用来记录日志的。使用起来比较方便，且功能比较全面。

官方文档

安装

pip install loguru

日志级别

Level nameSeverity valueLogger method
TRACE5logger.trace
DEBUG10logger.debug
INFO20logger.info
SUCCESS25logger.success
WARNING30logger.warning
ERROR40logger.error
CRITICAL50logger.critical

简单测试下

from loguru import logger

logger.debug("debug")
logger.info("info")
logger.success("success")
logger.warning("warning")
logger.error("error")
logger.critical("critical")

输出结果

在这里插入图片描述

特性

简介

此函数应用于注册接收器，这些接收器负责管理使用记录字典上下文化的日志消息。接收器可以采用多种形式：简单函数、字符串路径、类似文件的对象、协程函数或内置处理程序。

请注意：可以使用remove()函数来删除以前添加的处理程序。

例子：

import sys
from loguru import logger


logger.add("test.log", format="{time} {level} {message}", filter="", level="INFO", encoding="utf-8")
logger.debug("debug")
logger.info("info")
logger.success("success")
logger.warning("warning")
logger.error("error")
logger.critical("critical")

效果，输出日志到test.log文件

2022-07-27T17:14:36.393072+0800 INFO info
2022-07-27T17:14:36.394068+0800 SUCCESS success
2022-07-27T17:14:36.395066+0800 WARNING warning
2022-07-27T17:14:36.396063+0800 ERROR error
2022-07-27T17:14:36.397060+0800 CRITICAL critical

rotation/retension/compression

官方介绍：loguru.logger — loguru documentation

rotation:指示何时应关闭当前记录的文件并创建新文件,可以是文件大小/每天的时间点/时间间隔等。

logger.add("test1.log", rotation="500 MB") # 日志文件超过500M创建新的文件
logger.add("test2.log", rotation="12:00")  # 每天中午12点创建新的日志文件
logger.add("test3.log", rotation="1 week") # 当前使用的日志文件超过1周，创建新的日志文件

retension:指示合适应该删除旧文件。

logger.add("test4.log", retention="10 days") # 超过十天的日志文件删除

compression:日志文件在关闭时应转换为的压缩或归档格式。

logger.add("test5.log", compression="zip") # 日志文件关闭后，使用zip进行压缩

异常捕获

使用catch()装饰器或者上下文管理器可以捕获异常，确保任何错误都能够记录到log日志中。

装饰器

from loguru import logger

@logger.catch
def test(x, y, z):
    return 1 / (x + y + z)

test(0, 1, -1)

上下文装饰器

from loguru import logger


def test(x, y, z):
    return 1 / (x + y + z)

with logger.catch():
    test(0, 1, -1)

输出结果
在这里插入图片描述

完全描述性异常

记录代码中发生的异常对于跟踪BUG非常重要，loguru允许显示整个堆栈跟踪（包括变量值）来帮助定位BUG原因。

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)

输出结果
在这里插入图片描述

自定义颜色

logger.add(sys.stdout, colorize=True, format="<red>{time}</red> <level>{message}</level>")
logger.debug("debug")
logger.info("info")
logger.success("success")
logger.warning("warning")
logger.error("error")
logger.critical("critical")

输出结果
在这里插入图片描述

异步/线程安全/多进程安全

默认情况下，添加到log的所有接收器都是线程安全的，但他们不是多进程安全的。如果需要实现多进程安全，异步记录日志，需要添加一个enqueue参数：

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

结构化日志记录

将消息转化为json字符串以便于传递或者解析，可以使用serialize来配置：

logger.add("test.log", serialize=True, encoding="utf-8")
logger.debug("debug")
logger.info("info")
logger.success("success")
logger.warning("warning")
logger.error("error")
logger.critical("critical")

输出结果

{"text": "2022-07-28 11:25:44.434 | DEBUG    | __main__:<module>:43 - debug\n", "record": {"elapsed": {"repr": "0:00:00.127658", "seconds": 0.127658}, "exception": null, "extra": {}, "file": {"name": "logutil.py", "path": "e:\\GitPorject\\ZanguS1\\ZanguRecorder\\common\\logutil.py"}, "function": "<module>", "level": {"icon": "🐞", "name": "DEBUG", "no": 10}, "line": 43, "message": "debug", "module": "logutil", "name": "__main__", "process": {"id": 15768, "name": "MainProcess"}, "thread": {"id": 10228, "name": "MainThread"}, "time": {"repr": "2022-07-28 11:25:44.434074+08:00", "timestamp": 1658978744.434074}}}
{"text": "2022-07-28 11:25:44.436 | INFO     | __main__:<module>:44 - info\n", "record": {"elapsed": {"repr": "0:00:00.129653", "seconds": 0.129653}, "exception": null, "extra": {}, "file": {"name": "logutil.py", "path": "e:\\GitPorject\\ZanguS1\\ZanguRecorder\\common\\logutil.py"}, "function": "<module>", "level": {"icon": "ℹ️", "name": "INFO", "no": 20}, "line": 44, "message": "info", "module": "logutil", "name": "__main__", "process": {"id": 15768, "name": "MainProcess"}, "thread": {"id": 10228, "name": "MainThread"}, "time": {"repr": "2022-07-28 11:25:44.436069+08:00", "timestamp": 1658978744.436069}}}
{"text": "2022-07-28 11:25:44.438 | SUCCESS  | __main__:<module>:45 - success\n", "record": {"elapsed": {"repr": "0:00:00.131648", "seconds": 0.131648}, "exception": null, "extra": {}, "file": {"name": "logutil.py", "path": "e:\\GitPorject\\ZanguS1\\ZanguRecorder\\common\\logutil.py"}, "function": "<module>", "level": {"icon": "✔️", "name": "SUCCESS", "no": 25}, "line": 45, "message": "success", "module": "logutil", "name": "__main__", "process": {"id": 15768, "name": "MainProcess"}, "thread": {"id": 10228, "name": "MainThread"}, "time": {"repr": "2022-07-28 11:25:44.438064+08:00", "timestamp": 1658978744.438064}}}
{"text": "2022-07-28 11:25:44.439 | WARNING  | __main__:<module>:46 - warning\n", "record": {"elapsed": {"repr": "0:00:00.132645", "seconds": 0.132645}, "exception": null, "extra": {}, "file": {"name": "logutil.py", "path": "e:\\GitPorject\\ZanguS1\\ZanguRecorder\\common\\logutil.py"}, "function": "<module>", "level": {"icon": "⚠️", "name": "WARNING", "no": 30}, "line": 46, "message": "warning", "module": "logutil", "name": "__main__", "process": {"id": 15768, "name": "MainProcess"}, "thread": {"id": 10228, "name": "MainThread"}, "time": {"repr": "2022-07-28 11:25:44.439061+08:00", "timestamp": 1658978744.439061}}}
{"text": "2022-07-28 11:25:44.440 | ERROR    | __main__:<module>:47 - error\n", "record": {"elapsed": {"repr": "0:00:00.133642", "seconds": 0.133642}, "exception": null, "extra": {}, "file": {"name": "logutil.py", "path": "e:\\GitPorject\\ZanguS1\\ZanguRecorder\\common\\logutil.py"}, "function": "<module>", "level": {"icon": "❌", "name": "ERROR", "no": 40}, "line": 47, "message": "error", "module": "logutil", "name": "__main__", "process": {"id": 15768, "name": "MainProcess"}, "thread": {"id": 10228, "name": "MainThread"}, "time": {"repr": "2022-07-28 11:25:44.440058+08:00", "timestamp": 1658978744.440058}}}
{"text": "2022-07-28 11:25:44.442 | CRITICAL | __main__:<module>:48 - critical\n", "record": {"elapsed": {"repr": "0:00:00.135637", "seconds": 0.135637}, "exception": null, "extra": {}, "file": {"name": "logutil.py", "path": "e:\\GitPorject\\ZanguS1\\ZanguRecorder\\common\\logutil.py"}, "function": "<module>", "level": {"icon": "☠️", "name": "CRITICAL", "no": 50}, "line": 48, "message": "critical", "module": "logutil", "name": "__main__", "process": {"id": 15768, "name": "MainProcess"}, "thread": {"id": 10228, "name": "MainThread"}, "time": {"repr": "2022-07-28 11:25:44.442053+08:00", "timestamp": 1658978744.442053}}}

使用bind()添加额外的属性：

logger.add("test.log", format="{extra[ip]} {extra[user]} {message}")
context_logger = logger.bind(ip="192.168.0.1", user="someone")
context_logger.info("Contextualize your logger easily")
context_logger.bind(user="someone_else").info("Inline binding of extra attribute")
context_logger.info("Use kwargs to add context during formatting: {user}", user="anybody")

输出结果

192.168.0.1 someone Contextualize your logger easily
192.168.0.1 someone_else Inline binding of extra attribute
192.168.0.1 anybody Use kwargs to add context during formatting: anybody

使用bind()和filter对日志进行过滤：

logger.add("test.log", filter=lambda record: "special" in record["extra"])
logger.debug("This message is not logged to the file")
logger.bind(special=True).info("This message, though, is logged to the file!")

输出结果

2022-07-28 11:33:58.214 | INFO     | __main__:<module>:58 - This message, though, is logged to the file!

自定义级别

Loguru 附带了所有标准日志记录级别，额外添加了trace和success。如果需要自定义级别，可以使用level()函数来创建：

new_level = logger.level("test2", no=66, color="<black>", icon="🐍")

logger.log("test2", "Here we go!")

输出结果：
在这里插入图片描述

日期时间处理

logger.add("test.log", format="{time:YYYY-MM-DD at HH:mm:ss} | {level} | {message}")
logger.debug("debug")
logger.info("info")
logger.success("success")
logger.warning("warning")
logger.error("error")
logger.critical("critical")

输出结果：

2022-07-28 at 11:41:32 | DEBUG | debug
2022-07-28 at 11:41:32 | INFO | info
2022-07-28 at 11:41:32 | SUCCESS | success
2022-07-28 at 11:41:32 | WARNING | warning
2022-07-28 at 11:41:32 | ERROR | error
2022-07-28 at 11:41:32 | CRITICAL | critical

loguru配置

在脚本中使用记录器很容易，您可以在开始时configure()它。要从库中使用 Loguru，请记住永远不要调用 add()，而是使用 disable()，以便日志记录函数变为 no-op。如果开发人员希望查看库的日志，他可以再次enable() 它。

# For scripts
config = {
    "handlers": [
        {"sink": sys.stdout, "format": "{time} - {message}"},
        {"sink": "test.log", "serialize": True},
    ],
    "extra": {"user": "someone"}
}
logger.configure(**config)

# For libraries
logger.disable("my_library")
logger.info("No matter added sinks, this message is not displayed")
logger.enable("my_library")
logger.info("This message however is propagated to the sinks")

通知程序

Loguru 可以和强大的邮件通知模块 notifiers 库结合使用，以在程序意外失败时接收电子邮件，或发送许多其他类型的通知。

import notifiers

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

# Send a single notification
notifier = notifiers.get_notifier("gmail")
notifier.notify(message="The application is running!", **params)

# Be alerted on each error message
from notifiers.logging import NotificationHandler

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

尾语

希望能帮助到大家，如果又说的不对的地方，欢迎大家指正。

优快云开发云]

python3中超级好用的日志模块-loguru模块详解
数据知道的博客
07-21 12万+
一. 使用logging模块时 用python写代码时，logging模块最基本的几行配置，如下： import logging logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s') logger = logging.getLogger(__name__) logger.info('this is another debug message') logge
Python-Loguru：让记录日志更装13
06-12 389
Loguru 是一个功能强大且易于使用的开源日志记录库。它建立在 Python 标准库中的 logging 模块之上，并提供了更加简洁直观的接口。使用 Loguru，我们可以轻松地记录不同级别的日志消息，并根据需求输出到终端、文件或其他目标。Loguru允许我们自定义日志的格式。调用方法并设置format参数，可以指定日志的格式。测试玩家勇哥；我会不定期地分享更多的精彩内容，如果有任何问题或建议，请随时留言讨论。！如果你对 Loguru 感兴趣，可以前往官方文档了解更多详细的信息。
Python-Loguru是一个让Python日志记录变得超级简单
08-10
Loguru 是一个让Python日志记录变得超级简单
Python 比 logging 模块 人性化的log 模块loguru
从零开始学习python --zeropython
10-08 1151
本文章向大家介绍Python 第三方日志框架loguru使用，主要包括Python 第三方日志框架loguru使用使用实例、应用技巧、基本知识点总结和需要注意事项，具有一定的参考价值，需要的朋友可以参考一下。 解决中文乱码问题 项目地址 github: https://github.com/Delgan/loguru 文档...
Loguru 终极指南：Python 日志从未如此简单优雅
最新发布
YAnt的博客
04-13 404
【代码】Loguru 终极指南：Python 日志从未如此简单优雅。
loguru logger使用
qq_44889142的博客
09-11 704
【代码】loguru logger使用。
Python日志记录库——loguru
酒酿小圆子呀～
02-27 9479
在 Python 中用到日志记录，那就不可避免地会用到内置的 logging标准库。虽然logging 库采用的是模块化设计，你可以设置不同的 handler 来进行组合，但是在配置上通常较为繁琐；而且如果不是特别处理，在一些多线程或多进程的场景下使用 logging还会导致日志记录会出现错乱或是丢失的情况。Python 日志记录工具logging标准库logging的替代品是loguru，loguru使用起来就简单的多。
python logger 日志模块
weixin_30907523的博客
06-19 269
　　　　　　　　　　　　　　　　　　logger 日志 """logging配置""" import osimport logging.config # 定义三种日志输出格式 开始 standard_format = '[%(asctime)s][%(threadName)s:%(thread)d][task_id:%(name)s][%(filename)s:%(lineno)d]' \...
【python库对比】日志专题-loguru和logging对比
m0_74536743的博客
05-04 2170
介绍python日志出来常用模块，并重点通过代码示例 来对比loguru 和 logging两个库的差异
python-28-日志模块Loguru的应用
qq_20466211的博客
11-07 1411
日志模块Loguru和logging的对比
【拓展】Loguru：更为优雅、简洁的Python 日志管理模块
qq_53842456的博客
12-03 1840
python中的日志库logging使用起来有点像log4j，但配置通常比较复杂，构建日志服务器时也不是方便。标准库logging的替代品是loguru，loguru使用起来就简单的多。loguru默认的输出格式是：时间、级别、模块、行号以及日志内容。loguru不需要手动创建 logger，开箱即用，比logging使用方便得多；另外，日志输出内置了彩色功能，颜色和非颜色控制很方便，更加友好。break。
Python库 | log_utils-0.3.0.zip
05-25
资源分类：Python库 所属语言：Python 资源全名：log_utils-0.3.0.zip 资源来源：官方 安装方法：https://lanzao.blog.youkuaiyun.com/article/details/101784059
【python学习】loguru日志库用法大全！附代码示例
m0_54007171的博客
07-26 1528
Loguru 是一个用于 Python 的简单且强大的日志库。它的目标是使日志记录变得简单和优雅，同时提供许多有用的功能。Loguru 的 API 非常直观，使得记录日志变得简单高效。这些示例展示了它的基本用法，可以根据实际需求进行更复杂的配置和使用。
Python学习：loguru日志库
追风筝的人的专栏
03-25 4825
中的日志库使用起来有点像，但配置通常比较复杂，构建日志服务器时也不是方便。标准库的替代品是，使用起来就简单的多。默认的输出格式是：时间、级别、模块、行号以及日志内容。不需要手动创建 ，开箱即用，比使用方便得多；另外，日志输出内置了彩色功能，颜色和非颜色控制很方便，更加友好。是非标准库，需要事先安装，命令是：******。**安装后，最简单的使用样例如下： 上述代码输出： 日志打印到文件的用法也很简单，代码如下： 上述代码运行时，可以打印到console，也可以打印到文件中去。默认格式是时间、级别、名称+模块
Python - 日志管理模块: Loguru的使用
热门推荐
bailang_zhizun的博客
08-07 4万+
python的日志管理模块可以用自带的logging模块，也可以用第三方的Loguru模块，关于logging和loguru模块的简单使用可以参考以下文章，写的还是不错的：https://mp.weixin.qq.com/s?__biz=MzIzNzA4NDk3Nw==&mid=2457738232&idx=1&sn=bfc6437b494249270d2b6dc3469eda61&chksm=ff44b3a6c8333ab010268aed413da647f711839db
【Python第三方库】loguru日志模块
零碎@流年絮语 的博客
01-31 1151
【Python第三方库】loguru日志模块
python 异常捕获、断言（assert 、finally） 与日志（loguru.logger）
qq_35283902的博客
03-21 1133
代码执行顺序从上到下依次运行的，如果出错了，后面的代码不会出错。--所以要对异常做处理。常见的异常的类型，不需要记；平时写代码的时候 经常会报错，积累常见错误，排查问题。常见异常的报错的类型：NameError，IndexError,KeyError，ValueError，ZeroDivisionError对于自动化编程人员来说，代码报错了怎么排查？–具备基本能力。
loguru——Python优雅日志包
GeekZW的博客
08-16 2730
loguru——python优雅日志包 参考文档： 『Python』优雅的记录日志——loguru Github：Delgan / loguru 常用用法： from loguru import logger import sys logger.add(sys.stderr, format="{time} {level} {message}", filter="my_module",...
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

淡定九号

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值