python logging 模块详解

 

Python 中的 logging 模块可让你跟踪代码运行时的事件，当程序崩溃时能够查看日志而且发现是什么引起了错误。Log 信息有内置的层级——调试（debugging）、信息（informational）、警告（warnings）、错误（error）和严重错误（critical）。你也能够在 logging 中包含 traceback 信息。无论是小项目仍是大项目，都推荐在 Python 程序中使用 logging。本文将简单清晰地介绍如何使用 logging 模块。

为何使用 logging？

当你运行一个 Python 脚本时，你可能想要知道脚本的哪一个部分在执行，而且检视变量的当前值。

一般，能够只使用 print() 打印出你想要的信息。在小程序中，可能靠这个就足够了。

但问题是，当你处理有不少个模块的大项目时，就须要一个更加灵活的方法。

为何？

由于代码须要经历开发、调试、审查、测试或者上线等不一样阶段。在开发时你想要打印的信息类型可能和上线后你想看到的信息类型彻底不一样。

也就是说，在“测试”时，你可能只想看警告和错误信息，然而在“调试”时，你可能还想看到跟调试相关的信息。

若是你还想打印出使用的模块以及代码运行的时间，那么你的代码很容易变得混乱。

使用 logging 模块，这些问题就能很容易地解决。

logging 模块能够：

1. 控制信息层级，仅记录须要的信息。

2. 控制显示或者保存日志的时机。

3. 使用内置信息模板控制日志格式。

4. 知晓信息来自于哪一个模块。

基本 logging 例子

logging 模块是 Python 的标准库，要使用 logging，只须要使用 logging.basicConfig() 进行基本设置。事实上，这也是可选的。

而后就能够调用 logging.{level}(message) 在控制台中显示信息。

import logging
logging.basicConfig(level=logging.INFO)

def hypotenuse(a, b):
    """计算三角形斜边"""
    return (a**2 + b**2)**0.5

logging.info("{a}, {b} 的斜边是 {c}".format(a=3, b=4, c=hypotenuse(a=3, b=4)))
#> INFO:root:3, 4 的斜边是 5.0

打印出的日志信息遵循默认格式： {LEVEL}:{LOGGER}:{MESSAGE}。

上面的例子中， LEVEL 就是 INFO，由于调用的是 logging.info()。

LOGGER 为 root，由于这是默认 logger。

logger（日志记录器）相似于一个实体，你能够建立并配置它来记录不一样类型和格式的消息。

你能够配置一个输出到控制台的 logger 和另外一个将日志发送到文件的 logger，它们具备不一样的日志记录级别，而且特定于给定模块。

最后，输出的信息就是我传递给 logging.info() 的字符串。

那么若是不设置 logging.basicConfig(level=logging.INFO) 会怎么样？

答案是 日志信息不会被打印出来。

为何？要知道这个须要先了解 logging 的级别。

logging 的 5 个级别

logging 有 5 个不一样层次的日志级别，能够将给定的 logger 配置为这些级别：

1. DEBUG：详细信息，用于诊断问题。Value=10。

2. INFO：确认代码运行正常。Value=20。

3. WARNING：意想不到的事情发生了，或预示着某个问题。但软件仍按预期运行。Value=30。

4. ERROR：出现更严重的问题，软件没法执行某些功能。Value=40。

5. CRITICAL：严重错误，程序自己可能没法继续运行。Value=50。

如今，让咱们回答以前提出的问题。默认 logger 是 root，其默认的 basicConfig 级别是 WARNING。也就是说，只有来自 logging.warning或者更高级别的信息才会被记录下来。

所以，logging.info() 中的信息不会被打印出来。这也是为何 basicConfig 被设为 INFO。

若是级别使用 logging.ERROR 代替，只有来自 logging.error 和 logging.critical 的信息会被记录。

import logging
logging.basicConfig(level=logging.ERROR)

def hypotenuse(a, b):
    """计算三角形斜边"""
    return (a**2 + b**2)**0.5

kwargs = {'a':3, 'b':4, 'c':hypotenuse(3, 4)}

logging.debug("a = {a}, b = {b}".format(**kwargs))
logging.info("{a}, {b} 的斜边是 {c}".format(**kwargs))
logging.warning("a={a} 和 b={b} 相等".format(**kwargs))
logging.error("a={a} 和 b={b} 不能为负".format(**kwargs))
logging.critical("{a}, {b} 的斜边是 {c}".format(**kwargs))

#> ERROR:root:a=3 和 b=4 不能为负
#> CRITICAL:root:3, 4 的斜边是 5.0

将日志记入文件

要从 root logger 将日志消息发送到文件，须要在 logging.basicConfig() 中设置 file 参数：

import logging
logging.basicConfig(level=logging.INFO, filename='sample.log')

如今，全部后续日志消息都将直接记录到当前工做目录中的“sample.log“文件。若是要将其记录到另外一个目录中的文件，请给出完整的文件路径。

如何更改 logging 格式

logging 模块提供了向日志消息添加各类详细信息的速记表。

fig

让咱们更改日志信息格式以显示 TIME、LEVEL 和 MESSAGE。

import logging
logging.basicConfig(level=logging.INFO, format='%(asctime)s :: %(levelname)s :: %(message)s')

logging.info("当当当!")
#> 2019-03-10 19:41:09,057 :: INFO :: 当当当!

不要对全部模块使用 root logger

让咱们看下面的代码：

# 1. myprojectmodule.py
import logging
logging.basicConfig(filename='module.log')

#-----------------------------

# 2. main.py (从 myprojectmodule.py 导入代码)
import logging
import myprojectmodule  # 运行 myprojectmodule.py 中的代码，将生成 `module.log` 文件

logging.basicConfig(filename='main.log')  # 无效！

若是项目中有一个或多个模块。这些模块使用基本根模块。而后，当导入模块 myprojectmodule.py 时，将运行该模块的全部代码并配置 logger。

一旦配置好，main 文件中的 root logger 将不能再更改 root logger 设置。由于，一旦设置好 logging.basicConfig()，就不能再更改它。

若是想在不一样文件中使用不一样 logger，就须要建立一个新的 logger。

如何建立一个新的 logger？

可使用 logger.getLogger(name) 方法建立一个新的 logger。若是存在同名的 logger，则将使用该 logger。

能够给 logger 取任何名字，可是一般使用 __name__ 变量：