标签归档：日志

github、工具

Loguru — 最强大的 Python 日志记录器

留下评论

Loguru 一个能彻底解放你的日志记录器。

它即插即用，具备多种方式滚动日志、自动压缩日志文件、定时删除等功能。

除此之外，多线程安全、高亮日志、日志告警等功能也不在话下。

下面就给大家介绍一下这个强大工具的基本使用方法。

Loguru 安装方式很简单，打开终端输入：

pip install loguru

即可完成安装。

1.即开即用

如果你需要输出 debug 日志到终端，可以这么做：

from loguru import logger

logger.debug("That's it, beautiful and simple logging!")

其输出自带高亮：

如果你需要把日志输出到文件，只需要这样：

from loguru import logger
logger.add("file_{time}.log")
logger.debug("That's it, beautiful and simple logging!")

这样就会在当前运行的文件夹下生成 file_当前时间.log 的日志文件：

2.滚动日志与压缩

使用 Loguru 我们可轻易地实现滚动日志。

按时间滚动

比如按时间滚动，我们只需要在 logger.add 参数中添加一个 rotation 参数：

from loguru import logger
logger.add("file_2.log", rotation="12:00")     # 每天12:00会创建一个新的文件
logger.debug("That's it, beautiful and simple logging!")

这样，如果当前时间过了这个设定的时间，它就会生成一个新的日志文件。如果没有则使用原来的日志文件：

如图所示，过了设定的时间，则将原来的 file_2.log 重命名，并添加一个新的 file_2.log 文件。

按大小滚动

除了按时间滚动日志外，Loguru 还可以按日志大小滚动：

from loguru import logger
logger.add("file_1.log", rotation="1 MB")    # 滚动大日志文件
logger.debug("That's it, beautiful and simple logging!")

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

压缩日志

如果你不想删除原有日志文件，Loguru 还支持将日志直接压缩：

from loguru import logger
logger.add("file_Y.log", compression="zip")    # 压缩日志

3.其他特性

自定义颜色

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)

支持Backtrace

对于日志而言，没有错误堆栈的日志是没有灵魂的。Loguru 允许显示整个堆栈信息来帮助你发现问题（包括变量）。

比如下面这个例子：

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)

日志将会是这样的：

非常清晰明了。

邮件告警

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

import notifiers

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

# 初始化时发送一封邮件
notifier = notifiers.get_notifier("gmail")
notifier.notify(message="The application is running!", **params)

# 发生Error日志时，发邮件进行警报
from notifiers.logging import NotificationHandler

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

这样配置之后，每次产生 Error 日志，程序都会自动向你的邮箱发送告警，真的极其方便。

除了这些特性外，Loguru 还支持与 Python 原生的 Logging 模块兼容使用，你可以将原始的标准日志记录器记录的所有信息转移到Loguru中。

你还可以基于 Loguru 定制新的日志 Level，定制自己喜欢的结构化数据，详情可见 Loguru 的官方文档：

https://github.com/Delgan/loguru

我们的文章到此就结束啦，如果你喜欢今天的 Python 教程，请持续关注Python实用宝典。

有任何问题，可以在公众号后台回复：加群，回答相应验证信息，进入互助群询问。

原创不易，希望你能在下面点个赞和在看支持我继续创作，谢谢！

我要打赏
给作者打赏，选择打赏金额
¥1¥5¥10¥20¥50¥100¥200 自定义
立即支付

​Python实用宝典 ( pythondict.com )
不只是一个宝典
欢迎关注公众号：Python实用宝典

Python 基础教程、解决方案、设计模式

Python 简单实用的日志装饰器

留下评论

在写代码的时候，往往会漏掉日志这个关键因素，导致功能在使用的时候出错却无法溯源。

其实，只需要写一个非常简单的日志装饰器，我们就能大大提升排查问题的效率。

1.简陋版

写一个装饰器非常简单，因为本质上装饰器就是一个返回函数的“高阶”函数而已：

1.函数作为参数传递进装饰器。
2.装饰器内定义一个函数，处理作为参数传递进来的函数。
3.返回这个装饰器内定义的函数

import datetime


def log(func):
    """
    日志装饰器，简单记录函数的日志

    Args:
        func (function): 函数
    """
    def inner(*args):
        timestamp = str(datetime.datetime.now()).split(".")[0]
        res = func(*args)
        print(f"[{timestamp}] ({func.__name__}) {args} -> {res}")
        return res
    return inner

用一下试试看：

@log
def pluser(a, b):
    return a + b

pluser(1, 2)

效果如下：

虽然这样可以实现我们所需要的功能，但其实有很大的优化空间。

2.普通版

第一版代码中有一个显而易见的问题，装饰器内定义的处理函数不支持kwargs，而在装饰器中支持kwargs仅仅是举手之劳而已。

第二个问题是，生成时间戳的时候采用字符串截取的形式，这种形式过于粗暴。其实可以使用strftime做字符串转换。

修改如下：

import datetime


def log(func):
    """
    日志装饰器，简单记录函数的日志

    Args:
        func (function): 函数
    """
    def inner(*args, **kwargs):
        timestamp = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
        res = func(*args, **kwargs)
        print(f"[{timestamp}] ({func.__name__}) {args} -> {res}")
        return res
    return inner

似乎优化地差不多了，不过依然存在改进空间。

3.优化版

在前两版代码中，我们使用print进行日志输出，其实这种处理日志的方式并不标准。

使用logging模块控制日志输出是一个更好地选择。

为了使用logging模块记录日志，我们需要先配置好logging相关的选项。

1.首先，生成一个日志记录器，并配置日志等级：

import logging

# 获取日志记录器，配置日志等级
logger = logging.getLogger(__name__)
logger.setLevel('DEBUG')

2.配置日志格式、增加handler控制输出流：

# 默认日志格式
formatter = logging.Formatter("%(asctime)s - [%(levelname)s] - %(message)s")
# 输出到控制台的handler
chlr = logging.StreamHandler()
# 配置默认日志格式
chlr.setFormatter(formatter)

此处可以设置handler所需要处理的日志等级，没有设置则默认使用logger自身的Level，即DEBUG等级。

3.最后，将此handler加入到日志记录器内：

# 日志记录器增加此handler
logger.addHandler(chlr)

logging 完整配置如下：

import logging

# 获取日志记录器，配置日志等级
logger = logging.getLogger(__name__)
logger.setLevel('DEBUG')

# 默认日志格式
formatter = logging.Formatter("%(asctime)s - [%(levelname)s] - %(message)s")
# 输出到控制台的handler
chlr = logging.StreamHandler()
# 配置默认日志格式
chlr.setFormatter(formatter)

# 日志记录器增加此handler
logger.addHandler(chlr)

使用的时候非常简单，就是把print换成logger.debug即可：

def log(func):
    """
    日志装饰器，简单记录函数的日志

    Args:
        func (function): 函数
    """
    def inner(*args, **kwargs):
        timestamp = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
        res = func(*args, **kwargs)
        logger.debug(f"func: {func.__name__} {args} -> {res}")
        return res
    return inner

效果如下：

这样，一个比较完善的日志装饰器就完成了。

附常用的日志等级配置：

我们的文章到此就结束啦，如果你喜欢今天的Python 实战教程，请持续关注Python实用宝典。

有任何问题，可以在公众号后台回复：加群，回答相应验证信息，进入互助群询问。

原创不易，希望你能在下面点个赞和在看支持我继续创作，谢谢！

​Python实用宝典 (pythondict.com)
不只是一个宝典
欢迎关注公众号：Python实用宝典