关于python:弃繁就简一行代码搞定-Python-日志

写了这么多年的 Python，我始终都是应用 Python 自带的 logging 模块来记录日志，每次须要写一些配置将日志输入到不同的地位，设置不同日志输入格局，或者将日志进行分文件和压缩等。这个日志模块没什么问题，直到我无心中发现了一个神器，我才察觉原来记日志能够这么简略的！这个神器就是 loguru。

装置
这个库的装置形式很简略，间接应用 pip 就能够，我应用 Python 3 版本，装置命令如下：

pip3 install loguru

小试牛刀
装置结束之后，咱们就能够应用了，最简略的应用形式：

from loguru import logger

logger.debug('this is a debug message')

无需任何配置，即取即用。上例是打印一条 debug 级别的日志，输入后果如下：

2021-03-16 22:17:23.640 | DEBUG    | __main__:<module>:8 - this is a debug message

这条输入日志信息蕴含了日期、工夫、日志级别、日志代码行数以及日志内容信息。能够说最根本的内容都囊括了，当然你还能够打印 warning、info、error、critical、success 等级别。输入的日志在 console 中还带有高亮色彩，并且每个级别的日志色彩不一样，几乎不要太酷！

日志文件
写文件
在 loguru 中，输入日志文件只须要一个 add() 函数即可：

logger.add('hello.log')

logger.debug('i am in log file')

这时候，在 console 中会失常打印日志信息，在同级目录下会生成一个日志文件 hello.log，咱们关上日志文件，能够看到内容如下：

2021-03-16 21:20:31.460 | DEBUG    | __main__:<module>:12 - i am in log file

当然，咱们还能够加一些参数，来指定文件中日志输入的格局、级别：

log = logger.add('world.log', format="{time} | {level} | {message}", level="INFO")

logger.debug('i am debug message')
logger.info('i am info message')

对应的文件输入信息如下：

2021-03-16T22:47:53.226998+0800 | INFO | i am info message

咱们设置了文件只记录 info 级别的信息，所以 debug 级别的日志信息并没有写入日志文件。

咱们也能够给日志文件名称加信息：

logger.add('hello_{time}.log')

下面的代码运行后，会生成一个带工夫的日志文件。

进行写入文件
当咱们不再须要将日志写入文件时，咱们随时能够进行：

id = logger.add('world.log', format="{time} | {level} | {message}", level="INFO")
logger.info('this is a info message')
logger.remove(id)
logger.info('this is another info message')

add() 办法会返回一个日志文件的 id，当咱们须要进行写入信息时，咱们应用 remove() 办法，传入 id，即可。下面代码运行后，日志文件记录的信息如下：

2021-03-16T22:47:53.227389+0800 | INFO | this is a info message

在调用 remove() 办法后，其前面的日志信息并没有写入日志文件中。

滚动记录日志文件
咱们能够配置 rotation 参数，来指定日志文件的生成形式，跟通常的日志记录一样，咱们能够设置依照文件大小、工夫、日期等来指定生成策略。

# 超过 200M 就新生成一个文件
logger.add("size.log", rotation="200 MB")
# 每天中午 12 点生成一个新文件
logger.add("time.log", rotation="12:00")
# 一周生成一个新文件
logger.add("size.log", rotation="1 week")

指定日志文件的有效期
咱们还能够通过 retention 参数来指定日志文件的保留时长：

logger.add("file.log", retention="30 days") 

通过下面的配置，能够指定日志文件最多保留 30 天，30 天之前的日志文件就会被清理掉。

配置压缩文件
为了节俭空间，咱们可能存在压缩日志文件的需要，这个 loguru 也能够实现：

logger.add("file.log", compression="zip") 

通过下面的配置，咱们指定了日志文件的压缩格局为 zip。

异样捕捉
loguru 不仅能够记录日志，还能够捕捉异样信息，这个 能够帮忙咱们更好地追溯谬误起因。

在 loguru 模块中，咱们通常有两种异样捕捉形式：通过 catch 装璜器捕捉和通过 exception 办法捕捉。

catch 装璜器捕捉异样
咱们来看一个例子：

@logger.catch
def a_function(x):
    return 1 / x

a_function(0)

输入信息如下：

021-03-16 23:10:28.124 | ERROR    | __main__:<module>:32 - An error has been caught in function '<module>', process 'MainProcess' (25939), thread 'MainThread' (140735895298944):
Traceback (most recent call last):
  File "/Users/cxhuan/Library/Application Support/JetBrains/IntelliJIdea2020.3/plugins/python/helpers/pydev/pydevconsole.py", line 483, in <module>
    pydevconsole.start_client(host, port)
    │            │            │     └ 62146
    │            │            └ '127.0.0.1'
    │            └ <function start_client at 0x10fd596a8>
    └ <module 'pydevconsole' from '/Users/cxhuan/Library/Application Support/JetBrains/IntelliJIdea2020.3/plugins/python/helpers/py...
  
    ......
  
> File "/Users/cxhuan/Documents/python_workspace/mypy/loguru/logurustudy.py", line 32, in <module>
    a_function(0)
    └ <function a_function at 0x11021e620>
  File "/Users/cxhuan/Documents/python_workspace/mypy/loguru/logurustudy.py", line 30, in a_function
    return 1 / x
               └ 0
ZeroDivisionError: division by zero

下面的代码中，我特意造了一个 1 除以 0 的异样，咱们能够看到日志输入信息十分具体，将每一步调用的错误信息都具体的列出来，并且还把参数的值也打印进去了，还有十分直观的指向性，几乎是异样剖析神器！

exception 办法捕捉异样
咱们间接看例子：

def b_function1(x):
    try:
        return 1 / x
    except ZeroDivisionError:
        logger.exception("exception!!!")

b_function1(0)

运行下面代码，输入信息如下：

2021-03-16 23:16:07.602 | ERROR    | __main__:b_function1:40 - exception!!!
Traceback (most recent call last):
  File "/Users/cxhuan/Library/Application Support/JetBrains/IntelliJIdea2020.3/plugins/python/helpers/pydev/pydevconsole.py", line 483, in <module>
    pydevconsole.start_client(host, port)
    │            │            │     └ 62254
    │            │            └ '127.0.0.1'
    │            └ <function start_client at 0x118d216a8>
    └ <module 'pydevconsole' from '/Users/cxhuan/Library/Application Support/JetBrains/IntelliJIdea2020.3/plugins/python/helpers/py...
  File "/Users/cxhuan/Library/Application Support/JetBrains/IntelliJIdea2020.3/plugins/python/helpers/pydev/pydevconsole.py", line 411, in start_client
    process_exec_queue(interpreter)
    │                  └ <_pydev_bundle.pydev_ipython_console.InterpreterInterface object at 0x118d36240>
    └ <function process_exec_queue at 
    0x118d21400>
    
    ......
    
  File "/Users/cxhuan/Documents/python_workspace/mypy/loguru/logurustudy.py", line 42, in <module>
    b_function1(0)
    └ <function b_function1 at 0x11913b598>
> File "/Users/cxhuan/Documents/python_workspace/mypy/loguru/logurustudy.py", line 38, in b_function1
    return 1 / x
               └ 0
ZeroDivisionError: division by zero

同样地，也是很具体和直观地打印了谬误详情。

总结
有需要就有实现，然而能把需要实现得这么优雅、简洁的，我只服这个 loguru 的作者。

以上就是本次分享的所有内容，想要理解更多 python 常识欢送返回公众号：Python 编程学习圈，每日干货分享