python使用loguru优雅记录日志

python中更优雅的记录日志

前言

在以往我们使用日志,更多的是使用python自带的logging模块,它可以设置错误等级、输出方式等。

但使用方式相对比较复杂,想要更好的使用需要如log4net一样单独配置,这在python中感觉不是很优雅。

下面介绍一个python库:loguruguru是印度语中大师的意思,loguru直译就是“日志大师”。

安装使用

pip install loguru

快速上手

如图logging一样,loguru也有定义日志等级。不同的日志等级,输出效果也不一样(默认的等级由低到高是DEBUGINFOWARNINGERRORCRITICAL,也可以自己使用level函数定义)。

from loguru  import logger 

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

logger.info("this is a info message!")

类似logging中的logger.addHandler,loguru统一使用add函数来管理格式、文件输出、过滤等操作,它提供了许多参数来实现logger.addHandler中的配置更加简单方便。

其中sink是最重要的参数,可以传入不同的数据类型。传入文件路径、文件句柄、sys.stderr、甚至logging模块的HandlerFileHandlerStreamHandler等,这样就可以快速实现自定义的Handler配置。

通过给remove方法传递add方法返回的对象, 可以删除add方法添加的sink,这里的remove并不是删除test2.log文件,而是停止向该文件输出日志,需要需要继续记录日志则需要重新add日志文件。

from loguru import logger

obj = logger.add(sink='info.txt', format="{time} {level} {message}", filter="my_module", level="INFO")
logger.info("That's it, beautiful and simple logging!")
logger.remove(obj)

rotationretentioncompression进行日志窗口、更新、压缩管理。

logger.add("file_1.log", rotation="10 MB") # 日志文件的大小是10M,过大就会重新生成一个文件
logger.add("file_2.log", rotation="00:00") # 每天0点创建新日志文件
logger.add("file_3.log", rotation="1 week") # 自动更新旧文件
logger.add("file_X.log", retention="3 days") # 每3天自动清理旧文件
logger.add("file_Y.log", compression="zip") # zip压缩文件

支持控制台输出添加颜色, 除了基础色,loguru甚至允许16进制、RGB格式的颜色值和加粗、下划线等样式。

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

使用装饰器@logger.catch可以和logging一样使用logger.exception函数来记录异常信息。

@logger.catch
def my_function(x, y, z):
    # An error? It's caught anyway!
    return 1 / (x + y + z)
    
def func(a, b):
    return a / b

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

使用exception方法输出的异常信息包含堆栈信息和当前变量的值,方便问题定位。

2018-07-17 01:38:43.975 | ERROR    | __main__:nested:10 - What?!
Traceback (most recent call last):

  File "test.py", line 12, in <module>
    nested(0)
    └ <function nested at 0x7f5c755322f0>

> File "test.py", line 8, in nested
    func(5, c)
    │       └ 0
    └ <function func at 0x7f5c79fc2e18>

  File "test.py", line 4, in func
    return a / b
           │   └ 0
           └ 5

ZeroDivisionError: division by zero


使用serialize 可以将日志转换为JSON格式,enqueue 可以保证多线程、多进程安全。


logger.add("somefile.log", serialize=True) # 序列化为json 
logger.add("somefile.log", enqueue=True) 

修改时间格式。

logger.add("file.log", format="{time:YYYY-MM-DD at HH:mm:ss} | {level} | {message}") 

参考资料:

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容