程序员文章、书籍推荐和程序员创业信息与资源分享平台

网站首页 > 技术文章 正文

Python | Loguru一个强大的日志记录模块

hfteth 2025-01-21 17:54:30 技术文章 22 ℃

今天给大家介绍一款强大的日志记录工具Loguru,它可以彻底提升你的日志记录体验,而且简单易用。

Loguru日志模块,即插即用具有多种方式滚动日志、自动压缩日志文件、定时删除等功能。此外,多线程安全、日志高亮、日志告警等功能也不是问题。

loguru安装

安装 Loguru 也非常简单,只需在使用pip命令即可

pip install loguru

使用

在 Loguru 中,如果需要将 debug 日志输出到终端,可以执行以下操作:

from loguru import logger
logger.debug("start use loguru")

输出将如下所示:


如果你需要将日志输出到文件,只需执行以下操作:

from loguru import logger
logger.add("file_{time}.log")
logger.debug("start use loguru")

这会在当前运行的文件夹中生成一个file_current time.log的日志文件,如下图所示:

处理程序/格式化程序/过滤器?

如何添加处理程序?如何设置日志格式?如何过滤消息?如何设置日志级别?在 Loguru 中,所有这些配置都可以一次性完成。

logger.add(sys.stderr, format="{time} {level} {message}", 
           filter="my_module", level="INFO")

滚动日志和压缩

使用 Loguru,你可以轻松实现滚动日志。

  • 按时间滚动

比如按时间滚动,只需要在参数中添加一个rotation参数即可logger.add

from loguru import logger
logger.add("file_2.log", rotation="12:00") # Create new file at 12AM
logger.debug("start use loguru")

这样,如果当前时间超过了这个设定的时间,就会生成一个新的日志文件。如果不是这个时间就会使用原始日志文件。

  • 按大小滚动

除了按时间滚动日志,Loguru 还可以按日志大小滚动:

from loguru import logger
logger.add("file_1.log", rotation="1 MB")
logger.debug("start use loguru")

这样,一旦日志文件大小超过1MB,就会生成一个新的日志文件。

  • 压缩日志

如果不想删除原来的日志文件,Loguru也支持直接压缩日志:

from loguru import logger
logger.add("file_Y.log", compression="zip")

其它功能

  • 自定义颜色

Loguru 支持自定义颜色,如果你不喜欢它的默认颜色,你可以这样改:

logger.add(sys.stdout,
           colorize=True, 
           format="<green>{time}</green> <level>{message}</level>")

像 HTML 标签 <green></green> 标签这样的文本会被标记为绿色。

  • 多进程安全

Loguru 默认是线程安全的,但不是多进程安全的。但是如果你需要多进程/异步日志记录,它也支持,只需要添加一个enqueue参数:

logger.add("somefile.log", enqueue=True)
  • 回溯支持

至于日志,没有错误堆栈的日志是没有灵魂的。Loguru 允许你显示整个堆栈信息以帮助你发现问题(包括变量)。例如:

logger.add("out.log", backtrace=True, diagnose=True)
def func(a, b):
    return a / b

def nested(c):
    try:
        func(5, c)
    except ZeroDivisionError:
        logger.exception("What?!")

nested(0)

日志将是这样的,你可以看到它非常清楚地显示了错误的地方。

  • 电子邮件提醒

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

import notifiers

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

notifier = notifiers.get_notifier("mail")
notifier.notify(message="The application is running!", **params)

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

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

这样配置后,每次产生Error日志时,程序都会自动发送一个alert到你的邮箱,真是方便。

除了这些特性,Loguru 还支持兼容 Python 原生的 Logging 模块,你可以将原来标准 logger 记录的所有信息都转移到 Loguru 中。

如果你发现我的任何文章对你有帮助或者有用,麻烦点赞或者转发。 谢谢!

Tags:

最近发表
标签列表