Python优雅的日志——loguru

迅捷小莫 2021-09-02

2438

loguru

RECOMMENDATION

影视loguru

据小提莫观察，在python的使用者中，善于聪明“偷懒”以及不重复造轮子已经成为大家的共识，正所谓“人生苦短，我用python”，作为python的爱好者，肯定是喜欢python大量的类库，而loguru就是日志模块中的王者。

相对于python自带的logging，loguru省去了一些日志的配置，有着更好的可读性，受到了更多python爱好者的喜爱。

安装

python的安装大家都知道非常简单，直接来！

pip install loguru # 安装
Collecting loguru
  Downloading loguru-0.5.3-py3-none-any.whl (57 kB)
     |█████▊                          | 10 kB 194 kB/s eta 0:0
     |███████████▌                    | 20 kB 68 kB/s eta 0:00
     |█████████████████▏              | 30 kB 102 kB/s eta 0:0
     |███████████████████████         | 40 kB 136 kB/s eta 0:0
     |████████████████████████████▋   | 51 kB 171 kB/s eta 0:0
     |████████████████████████████████| 57 kB 200 kB/s
Installing collected packages: loguru
Successfully installed loguru-0.5.3
复制

不多BB，像👆上面这样就是已经安装好了。

基础使用

在探索一个新包之前，我们第一步要做的应该是要了解它的api，也就是它具有哪些方法提供给使用者。于是熟练的打开我们的Terminal，启用python3

>>> from loguru import logger
>>> logger
<loguru.logger handlers=[(id=0, level=10, sink=<stderr>)]>
>>> logger.
logger.add(            logger.disable(        logger.parse(
logger.bind(           logger.enable(         logger.patch(
logger.catch(          logger.error(          logger.remove(
logger.complete(       logger.exception(      logger.start(
logger.configure(      logger.info(           logger.stop(
logger.contextualize(  logger.level(          logger.success(
logger.critical(       logger.log(            logger.trace(
logger.debug(          logger.opt(            logger.warning(
复制

于是乎蹦出了这么多方法，让我一时不知所措，不过不慌，我们慢慢来看。首先我第一眼就瞄见了熟悉的：

logger.info()
logger.debug()
logger.warning()
logger.error()
复制

这四个日志等级，如果大家有用过日志，应该非常熟悉了，那么我们也顾不了那么多了，先试试！

>>> logger.info("我是小提莫")
2021-07-08 22:19:23.349 | INFO     | __main__:<module>:1 - 我是小提莫
>>> logger.debug("我是小提莫")
2021-07-08 22:19:36.441 | DEBUG    | __main__:<module>:1 - 我是小提莫
>>> logger.warning("我是小提莫")
2021-07-08 22:19:45.038 | WARNING  | __main__:<module>:1 - 我是小提莫
>>> logger.error("我是小提莫")
2021-07-08 22:19:54.951 | ERROR    | __main__:<module>:1 - 我是小提莫
复制

是不是不用吹灰之力就输出了几行日志，并且可以看到对应的日期以及日志内容都比较符合我们的预期，并且这是在零配置的情况下。其实小提莫想告诉大家的是，这个日志牛逼的地方还没有看到，就是它自带颜色！

非常的酷炫有木有！小提莫第一次看到的时候也是惊了，就决定是它了。

如果你们想说，这也没啥大不了的，那么我们来看看如果使用logging模块来实现同等功能，需要多少代码

import logging
import os
import sys
from logging import handlers


log = logging.getLogger(__name__)
log.setLevel(logging.DEBUG)
fmt = logging.Formatter("%(asctime)s | %(levelname)s | %(message)s")
LOGFILE = os.path.expanduser("~/Desktop/testlog.log")


console_handler = logging.StreamHandler(sys.stderr)
console_handler.setFormatter(fmt)
log.addHandler(console_handler)


file_handler = handlers.RotatingFileHandler(LOGFILE)
file_handler.setFormatter(fmt)
log.addHandler(file_handler)


log.info("hello, world")
复制

这样心里是不是明白多了，懂我意思吧！

日志格式与文件

上面我们在控制台打印了loguru日志，那么我们怎么将日志写入文件呢？并且如何修改日志的格式呢？带着这些疑问，继续往下看。

loguru给我们提供了logger.add方法，可以轻松实现这一需求。

>>> from loguru import logger
>>> logger.add("info.log", format="{time}|{level}|{message}", level="INFO")
1 # 返回了1
复制

这个1我们不知道什么意思，大概猜想一下，1在python中为真，那么相当于True，在这里结合上面，也就是说我文件成功生成了！后来发现并不是哦，实际上这里指的是日志文件的个数。所以我去当前目录下找一找这个info.log文件，于是在一堆错乱的文件中，我还是发现了它

get-store-list-svip.jmx
get-user-auth.jmx
get-wx-bind-openid.jmx
getBusinessOrder.jmx
index.js_c4eb18b51b498ad2230e
info.log # 在这里
java_sdk_v3.0.9
jmeter-plugins-dubbo-1.3.7-jar-with-dependencies.jar
jmeter.log
launch.json
复制

我们打开文件看一下，发现文件中什么玩意都没有，仔细想了下，我们还没有输出呢！当然没有日志在里面了，于是我们尝试输出

>>> logger.info("我是小提莫")
2021-07-08 22:51:23.732 | INFO     | __main__:<module>:1 - 我是小提莫
复制

接着我找到了info.log，惊喜发现，此时的我只想惊呼，奶思啊

日志切割

在实际应用中，随着日志量的增多，我们不可能把所有日志全部存在同一个日志文件里，那么就需要把日志进行切割。

在loguru中，提供了rotation配置，我们可以在使用logger.add时，加上参数rotation

logger.add('runtime_{time}.log', rotation="500 MB")
复制

在上面的配置中，我们把rotation设置为500MB,那么当我们的日志文件超过500MB时，会自动生辰一个新的日志文件，于是乎会存在2个日志文件，也就是我们说的日志切割。

日志保留时间

有时候，我们不想要日志一直存放在我们的磁盘中，有些太老的日志对于我们来说也是没有什么太大的用处，那loguru也提供了相关的参数retention来设置日志的保留时间

logger.add('runtime.log', retention='10 days')
复制

在上面我们设置了该日志文件保留10天，超过10天则进行自动删除，再也不用担心日志冗余的问题啦！

其他功能

loguru提供了非常非常多的功能，在这里小提莫无法给大家全部展示，有些功能就大概罗列一下，有需要的小伙伴们自行了解

compression 配置

loguru可以为日志设置压缩格式，如设置为zip压缩

logger.add('runtime.log', compression='zip')
复制

enqueue配置

loguru可以设置日志的异步写入

logger.add("somefile.log", enqueue=True)  # 异步写入
复制

字符串格式化

可以在写入日志的时候进行字符串格式化

logger.info('I love Python {}', 3.6)
复制

Traceback 记录

这个功能就非常的牛批了，利用@logger.catch装饰器我们可以对执行异常进行记录

比如我们有下面一个函数

@logger.catch
def function(x, y, z):
    return 1  (x + y + z)
复制

然后我对这个函数进行调用，可以看到在日志文件中已经有了相关的日志记录。

那么今天的分享就到此结束啦～大家多多关注，小提莫也会尽快出高质量的技术文章，敬请期待！请大家喝奶茶

点击痛饮这杯奶茶

左

右

滑

动

点击蓝字关注我们 ////

NEW///ARRIVAL

关注我们

扫二维码

python

文章转载自迅捷小莫，如果涉嫌侵权，请发送邮件至：contact@modb.pro进行举报，并提供相关证据，一经查实，墨天轮将立刻删除相关内容。

Python优雅的日志——loguru

评论