python模块-比print更好用的logging

文章参考：logging模块解读

适用目的：

代码通常经过开发、调试、审查、测试或者上线等不同阶段。
在每个阶段中不仅需要查看报错的信息，也需要查阅调试相关的信息，人的大脑不能直接解读代码，则需要利用 print() 函数 打印出想要的信息观察。
这时候 logging模块 更为适合。

因为当不断使用print打印出变化过程，会使得代码容易错乱及冗杂，无法区分是本身需要print的内容还是单纯为了查看变化过程。

logging模块作用：

1.控制信息层级
2.控制显示时机（一般与try...except搭配使用）
3.内置信息模块
4.知晓来源的py文件

简单例子：

import logging
logging.basicConfig(level=logging.INFO) #不开启不打印，只有warnning的才会打印，否则得basicconfig设置

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)))
#打印出的日志信息遵循默认格式： {LEVEL}:{LOGGER}:{MESSAGE}。

INFO:root:3, 4 的斜边是 5.0

个人认为，只需要掌握：
logging.basicConfig配置、logging.{level}调用、logger.getLogger(name) 三个函数的使用方式即可，其余内容遇到时进行搜索即可。

案例

import logging
logging.basicConfig(level=logging.ERROR) #只有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),exc_info=True)
logging.critical("{a}, {b} 的斜边是 {c}".format(**kwargs))

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

首先有2个知识点需要掌握：
1.level和basicConfig的作用
2.logging输出的格式及调用

(1)level和basicConfig的作用

level等级
logging 有 5 个不同层次的日志级别，可以将给定的 logger 配置为这些级别：
1. DEBUG：详细信息，用于诊断问题。Value=10。
2. INFO：确认代码运行正常。Value=20。
3. WARNING：意想不到的事情发生了，或预示着某个问题。但软件仍按预期运行。Value=30。
4. ERROR：出现更严重的问题，软件无法执行某些功能。Value=40。
5. CRITICAL：严重错误，程序本身可能无法继续运行。Value=50。

简单地说：即有5个等级随你分层，在basicConfig设置默认的level等级是WARNING,根据设置的等级来显示同等级别及更高级别的信息。
注意观察实例代码，设置logging.basicConfig(level=logging.ERROR)，所以只有

logging.error("a={a} 和 b={b} 不能为负".format(**kwargs),exc_info=True)
logging.critical("{a}, {b} 的斜边是 {c}".format(**kwargs))

这两条信息打印出来

将日志记入文件
将日志消息发送到文件，需要在 logging.basicConfig() 中设置 file 参数：

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

现在，所有后续日志消息都将直接记录到当前工作目录中的“sample.log“文件。如果要将其记录到另一个目录中的文件，请给出完整的文件路径。

image.png

(2)logging输出的格式及调用

CRITICAL:root:3, 4 的斜边是 5.0

观察上面的代码结果，你会发现打印的日志格式默认遵循：
{LEVEL}:{LOGGER}:{MESSAGE}
LEVEL = 'CRITICAL'
LOGGER = 'root'
MESSAGE = '3, 4 的斜边是 5.0'

如何调用

logging.critical("{a}, {b} 的斜边是 {c}".format(**kwargs))

从结果追溯调用，logging.{level}(message)调用了这条信息。(注意小写)

当多个py文件结合使用

# 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？
使用 logging.getLogger(name) 方法创建一个新的 logger。如果存在同名的 logger，则将使用该 logger。

test = logging.getLogger('test123')

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

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

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

INFO:test123:3, 4 的斜边是 5.0
WARNING:test123:a=3 和 b=4 相等
ERROR:test123:a=3 和 b=4 不能为负

注意观察如何调用及结果显示的logger名，会发现test.{level}进行了调用，logger显示的是test123

总结

总结一下，尝试是否记住3个内容。
1.配置
2.调用
3.切换logger