在部署一些定时运行或者长期运行的任务时，为了留存一些导致程序出现异常或错误的信息，通常会才用日志的方式来进行记录这些信息。
在 Python 中用到日志记录，那就不可避免地会用到内置的 logging标准库 。虽然logging 库采用的是模块化设计，你可以设置不同的 handler 来进行组合，但是在配置上通常较为繁琐；而且如果不是特别处理，在一些多线程或多进程的场景下使用 logging还会导致日志记录会出现错乱或是丢失的情况。
但有这么一个库，它不仅能够减少繁琐的配置过程还能实现和logging类似的功能，同时还能保证日志记录的线程进程安全，又能够和logging 相兼容，并进一步追踪异常也能进行代码回溯。这个库叫loguru——一个专为像我这样懒人而生日志记录库。
一. 使用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')
logger.warning('this is another debug message')
logger.error('this is another debug message')
logger.info('this is another debug message')
执行结果如下：
二. loguru模块的基础使用
loguru 库的使用可以说是十分简单，我们直接可以通过导入它本身封装好的logger 类就可以直接进行调用。
logger 本身就是一个已经实例化好的对象，如果没有特殊的配置需求，那么自身就已经带有通用的配置参数；同时它的用法和logging库输出日志时的用法一致
用法如下：
from loguru import logger
logger.debug('this is a debug message')
logger.info('this is another debug message')
logger.warning('this is another debug message')
logger.error('this is another debug message')
logger.info('this is another debug message')
logger.success('this is success message!')
logger.critical('this is critical message!')
执行结果如下：
loguru默认的输出格式是上面的内容，有时间、级别、模块名、行号以及日志信息，不需要手动创建 logger，直接使用即可。当你在IDE 或终端里运行时会发现，loguru 还为输出的日志信息带上了不同的颜色样式（schema），使得结果更加美观。
如果想要输出到文件，只需要：
from loguru import logger
logger.add('my_log.log')
logger.debug('this is a debug')
运行之后会发现目录下 my_log.log 出现了刚刚控制台输出的 DEBUG 信息。上面只是基础用法，更详细的在下面
三. logurr详细使用
比如支持输出到多个文件，分级别分别输出，过大创建新文件，过久自动删除等等。
3.1 add 方法的定义
def add(
self,
sink,
*,
level=_defaults.LOGURU_LEVEL,
format=_defaults.LOGURU_FORMAT,
filter=_defaults.LOGURU_FILTER,
colorize=_defaults.LOGURU_COLORIZE,
serialize=_defaults.LOGURU_SERIALIZE,
backtrace=_defaults.LOGURU_BACKTRACE,
diagnose=_defaults.LOGURU_DIAGNOSE,
enqueue=_defaults.LOGURU_ENQUEUE,
catch=_defaults.LOGURU_CATCH,
**kwargs
):
pass
看看它的源代码，它支持这么多的参数，如 level、format、filter、color等等，另外我们还注意到它有个非常重要的参数 sink，我们看看官方文档：，可以了解到通过 sink 我们可以传入多种不同的数据结构，汇总如下：
sink 可以传入一个 file 对象，例如 sys.stderr 或者 open(‘file.log’, ‘w’) 都可以。
sink 可以直接传入一个 str 字符串或者 pathlib.Path 对象，其实就是代表文件路径的，如果识别到是这种类型，它会自动创建对应路径的日志文件并将日志输出进去。
sink 可以是一个方法，可以自行定义输出实现。
sink 可以是一个 logging 模块的 Handler，比如 FileHandler、StreamHandler 等等。
sink 还可以是一个自定义的类，具体的实现规范可以参见官方文档https://loguru.readthedocs.io/en/stable/api/logger.html#sink。
所以说，刚才我们所演示的输出到文件，仅仅给它传了一个 str 字符串路径，他就给我们创建了一个日志文件，就是这个原理。
3.2 基本参数
下面我们再了解下它的其他参数，例如 format、filter、level等等。
其实它们的概念和格式和 logging 模块都是基本一样的了，例如这里使用 format、filter、level来规定输出的格式：
logger.add('runtime.log', format="{time} {level} {message}", filter="my_module", level="INFO")
3.3 删除 sink
另外添加 sink 之后我们也可以对其进行删除，相当于重新刷新并写入新的内容。
删除的时候根据刚刚 add 方法返回的 id 进行删除即可，看下面的例子：
from loguru import logger
trace = logger.add('my_log.log')
logger.debug('this is a debug message')
logger.remove(trace)
logger.debug('this is another debug message')
看这里，我们首先 add 了一个 sink，然后获取它的返回值，赋值为 trace。随后输出了一条日志，然后将 trace变量传给 remove 方法，再次输出一条日志，看看结果是怎样的。
控制台输出如下：
日志文件 my_log.log 内容如下：
可以发现，在调用 remove 方法之后，确实将历史 log 删除了。但实际上这并不是删除，只不过是将 sink对象移除之后，在这之前的内容不会再输出到日志中。
这样我们就可以实现日志的刷新重新写入操作。
3.4 rotation 配置
用了 loguru 我们还可以非常方便地使用rotation配置，比如我们想一天输出一个日志文件，或者文件太大了自动分隔日志文件，我们可以直接使用 add方法的rotation参数进行配置。
我们看看下面的例子：
logger.add('runtime_{time}.log', rotation="500 MB")
通过这样的配置我们就可以实现每 500MB 存储一个文件，每个 log 文件过大就会新创建一个 log 文件。我们在配置 log 名字时加上了一个 time 占位符，这样在生成时可以自动将时间替换进去，生成一个文件名包含时间的 log 文件。
另外我们也可以使用rotation 参数实现定时创建 log 文件，例如：
logger.add('runtime_{time}.log', rotation='00:00')
这样就可以实现每天 0 点新创建一个 log 文件输出了。
另外我们也可以配置 log 文件的循环时间，比如每隔一周创建一个 log 文件，写法如下：
logger.add('runtime_{time}.log', rotation='1 week')
这样我们就可以实现一周创建一个 log 文件了。
3.5 retention 配置
很多情况下，一些非常久远的 log 对我们来说并没有什么用处了，它白白占据了一些存储空间，不清除掉就会非常浪费。retention 这个参数可以配置日志的最长保留时间。
比如我们想要设置日志文件最长保留 10 天，可以这么来配置：
logger.add('runtime.log', retention='10 days')
这样 log 文件里面就会保留最新 10 天的 log，妈妈再也不用担心 log 沉积的问题啦。
当对retention 传入整数时，该参数表示的是所有文件的索引，而非要保留的文件数，这里是个反直觉的小坑，用的时候注意一下就好了。
3.6 compression 配置
loguru 还可以配置文件的压缩格式，比如使用 zip 文件格式保存，示例如下：
logger.add('runtime.log', compression='zip')
这样可以更加节省存储空间。
3.7 serialize 序列化
如果在实际中你不太喜欢以文件的形式保留日志，那么你也可以通过 serialize参数将其转化成序列化的json格式，最后将导入类似于MongoDB、ElasticSearch 这类数NoSQL 数据库中用作后续的日志分析。
from loguru import logger
import os
logger.add(os.path.expanduser("~/Desktop/testlog.log"), serialize=True)
logger.info("hello, world!")
最后保存的日志都是序列化后的单条记录：
{
"text": "2020-10-07 18:23:36.902 | INFO | __main__:<module>:6 - hello, world\n",
"record": {
"elapsed": {
"repr": "0:00:00.005412",
"seconds": 0.005412
},
"exception": null,
"extra": {},
"file": {
"name": "log_test.py",
"path": "/Users/Bobot/PycharmProjects/docs-python/src/loguru/log_test.py"
},
"function": "<module>",
"level": {
"icon": "\u2139\ufe0f",
"name": "INFO",
"no": 20
},
"line": 6,
"message": "hello, world",
"module": "log_test",
"name": "__main__",
"process": {
"id": 12662,
"name": "MainProcess"
},
"thread": {
"id": 4578131392,
"name": "MainThread"
},
"time": {
"repr": "2020-10-07 18:23:36.902358+08:00",
"timestamp": 1602066216.902358
}
}
}
3.8 字符串格式化
loguru 在输出 log 的时候还提供了非常友好的字符串格式化功能，像这样：
logger.info('If you are using Python {}, prefer {feature} of course!', 3.6, feature='f-strings')
这样在添加参数就非常方便了。
3.8 Traceback 记录
在很多情况下，如果遇到运行错误，而我们在打印输出 log 的时候万一不小心没有配置好 Traceback 的输出，很有可能我们就没法追踪错误所在了。
但用了 loguru 之后，我们用它提供的装饰器就可以直接进行 Traceback 的记录，类似这样的配置即可：
@logger.catch
def my_function(x, y, z):
# An error? It's caught anyway!
return 1 / (x + y + z)
我们做个测试，我们在调用时三个参数都传入 0，直接引发除以 0 的错误，看看会出现什么情况：
my_function(0, 0, 0)
运行完毕之后，可以发现 log 里面就出现了 Traceback 信息，而且给我们输出了当时的变量值，真的是不能再赞了！结果如下：
> File "run.py", line 15, in <module>
my_function(0, 0, 0)
└ <function my_function at 0x1171dd510>
File "/private/var/py/logurutest/demo5.py", line 13, in my_function
return 1 / (x + y + z)
│ │ └ 0
│ └ 0
└ 0
ZeroDivisionError: division by zero
因此，用 loguru 可以非常方便地实现日志追踪，debug 效率可能要高上十倍了？
3.9 与 Logging 完全兼容（Entirely Compatible）
尽管说loguru算是重新「造轮子」，但是它也能和logging库很好地兼容。到现在我们才谈论到add()方法的第一个参数 sink。
这个参数的英文单词动词有「下沉、浸没」等意，对于外国人来说在理解上可能没什么难的，可对我们国人来说，这可之前logging库中的handler概念还不好理解。好在前面我有说过，loguru 和logging库的使用上存在相似之处，因此在后续的使用中其实我们就可以将其理解为handler，只不过它的范围更广一些，可以除了handler之外的字符串、可调用方法、协程对象等。
loguru 官方文档对这一参数的解释是：
object in charge of receiving formatted logging messages and propagating them to an appropriate endpoint.
翻译过来就是「一个用于接收格式化日志信息并将其传输合适端点的对象」，进一步形象理解就像是一个「分流器」。
import logging.handlers
import os
import sys
from loguru import logger
LOG_FILE = os.path.expanduser("~/Desktop/testlog.log")
file_handler = logging.handlers.RotatingFileHandler(LOG_FILE, encoding="utf-8")
logger.add(file_handler)
logger.debug("hello, world")
当然目前只是想在之前基于logging 写好的模块中集成loguru，只要重新编写一个继承自 logging.Handler 类并实现了emit()方法的Handler即可。
import logging.handlers
from loguru import logger
class InterceptHandler(logging.Handler):
def emit(self, record):
# Retrieve context where the logging call occurred, this happens to be in the 6th frame upward
logger_opt = logger.opt(depth=6, exception=record.exc_info)
logger_opt.log(record.levelname, record.getMessage())
logging.basicConfig(handlers=[InterceptHandler()], level=0)
比如flask项目中，直接调用setup_loguru()就可以了
def setup_loguru(app,log_level='WARNING'):
logger.add(
'logs/{time:%Y-%m-%d}.log',
level='DEBUG',
format='{time:YYYY-MM-DD at HH:mm:ss} | {level} | {message}',
backtrace=False,
rotation='00:00',
retention='20 days',
encoding='utf-8'
)
app.logger.addHandler(InterceptHandler())
logging.basicConfig(handlers=[InterceptHandler()], level=log_level)
另外loguru还有很多很多强大的功能，这里就不再一一展开讲解了，更多的内容大家可以看看 loguru 的官方文档详细了解一下：https://loguru.readthedocs.io/en/stable/index.html。
看完之后，是时候把自己的 logging 模块替换成 loguru 啦！
2614
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
