logging模块

【 一 】前言

? logging 模块是 Python 中用于记录日志信息的标准库模块。通过使用 logging 模块，你可以在应用程序中设置日志记录以追踪代码执行、错误报告等信息。

• debug : 打印全部的日志( notset 等同于 debug )
• info : 打印 info, warning, error, critical 级别的日志
• warning : 打印 warning, error, critical 级别的日志
• error : 打印 error, critical 级别的日志
• critical : 打印 critical 级别

【 二?】日志级别介绍

【 1 】Logging 模块提供了两种日志记录方式：

• 一种方式是使用Logging 提供的模块级别的函数
• 另一种方式是使用Logging 日志系统的四大组件记录

import logging
logging.debug('这是一个调试信息')
logging.info('这是一条信息')
logging.warning('这是一个警告')
logging.error('这是一个错误')
logging.critical('这是一个严重错误')

# WARNING:root:这是一个警告
# ERROR:root:这是一个错误
# CRITICAL:root:这是一个严重错误

这为什么只能输出3个级别信息的日志。因为debug和info的级别太低了。如果想要输出如下：

import logging

# 配置日志，将级别设置为DEBUG
logging.basicConfig(level=logging.DEBUG,
                    format='%(asctime)s - %(levelname)s - %(message)s')

logging.debug('这是一个调试信息')
logging.info('这是一条信息')
logging.warning('这是一个警告')
logging.error('这是一个错误')
logging.critical('这是一个严重错误')
# 2023-12-20 18:45:57,138 - DEBUG - 这是一个调试信息
# 2023-12-20 18:45:57,138 - INFO - 这是一条信息
# 2023-12-20 18:45:57,138 - WARNING - 这是一个警告
# 2023-12-20 18:45:57,138 - ERROR - 这是一个错误
# 2023-12-20 18:45:57,138 - CRITICAL - 这是一个严重错误

【2】Logging 定义的模块级别函数

【 3 】设置日志显示级别

通过logging。basicConfig() 可以设置root的日志级别，和日志输出格式。

【logging.basicConfig() 关键字参数】

【format 格式】

?

注意:Logging.basicConfig() 需要在开头就设置，在中间设置并无作用

【示例】

import logging
#打印日志级别
def test():
    # 配置日志级别为 DEBUG
    logging.basicConfig(level=logging.DEBUG)
    # 记录 DEBUG 级别的日志
    logging.debug('Python debug')
    # 记录 INFO 级别的日志
    logging.info('Python info')
    # 记录 WARNING 级别的日志
    logging.warning('Python warning')
    # 记录 ERROR 级别的日志
    logging.error('Python error')
    # 记录 CRITICAL 级别的日志
    logging.critical('Python critical')
    # 使用 log() 方法记录特定级别的日志，这里记录级别为 3（与 WARNING 级别相同）
    logging.log(3,'test')
test()
# DEBUG:root:Python debug
# INFO:root:Python info
# WARNING:root:Python warning
# ERROR:root:Python error
# CRITICAL:root:Python critical

【显示消息日期】

import logging
# 显示消息日期
logging.basicConfig(format='%(asctime)s %(message)s')
logging.warning('is when this envent was logged')

logging.basicConfig(format='%(asctime)s %(message)s', datefmt='%m/%d/%Y %I:%M:%S %p')
logging.warning('is when this event was logged')
# 2023-12-21 08:59:40,017 is when this envent was logged
# 2023-12-21 08:59:40,017 is when this event was logged

【更改显示消息格式】

import logging
# 更改显示消息的格式
(logging.basicConfig(format='%(levelname)s: %(message)s',level=logging.DEBUG))
logging.debug('这格式调试为：Debug ')
logging.info('这格式调试为：Ingo')
logging.warning('这格式调试为：Warning')

# DEBUG: 这格式调试为：Debug 
# INFO: 这格式调试为：Ingo
# WARNING: 这格式调试为：Warning

显示结果只显示级别和具体信息，之前显示的 “根” 已经消失，重新定义的格式修改了默认输出方式。

【4】Logging 模块四大组件

????????logging模块是用于记录日志信息的标准库。它提供了一个灵活且可配置的方式来生成日志，以便在应用程序中进行调试、追踪和错误报告。

【1】日志器

??????????注意：要创建一个日志器（logger），可以使用logging模块的getLogger()函数，并指定一个唯一的名称作为参数

import logging
logger = logging.getLogger('日志器：')

????????一旦创建了日志器，我们就可以使用它来记录不同级别的日志消息。常见的日志级别包括DEBUG、INFO、WARNING、ERROR和CRITICAL。可以使用日志器的方法来记录相应级别的日志消息。

import logging
logger = logging.getLogger('日志器：')


logger.debug('这个是一个调试信息')
logger.info('这个是一条信息')
logger.warning('这个是一个警告信息')
logger.error('这个是一个错误信息')
logger.critical('这个是一个危急信息')
# 这个是一个警告信息
# 这个是一个错误信息
# 这个是一个危急信息

这里跟上面同理因为info跟debug的级别太低识别不出来

【2】处理器

????????Handler（处理器）： 用于将日志消息分发到不同的目标，例如文件、控制台等。一个日志器可以有多个处理器。

import logging
logger = logging.getLogger('日志器：')
#文件处理器
file_handler = logging.FileHandler('example.log')
# 控制台
console_handler = logging.StreamHandler()

【3】Formatter（格式化器）

????????用于控制日志消息的输出格式。每个处理器可以关联一个格式化器。

import logging
logger = logging.getLogger('日志器：')
# #文件处理器
file_handler = logging.FileHandler('example.log')
# # 控制台
# console_handler = logging.StreamHandler()

formatter = logging.Formatter('%(asctime)s - %(levelname)s- %(message)s')
file_handler.setFormatter(formatter)

【3】Level（级别）

表示日志消息的严重程度，例如 DEBUG、INFO、WARNING、ERROR、CRITICAL。

logger.setLevel(logging.DEBUG)

#INFO,WARNING,ERROR,CRITICAL

【4】Logging Functions（日志函数）

包括 debug(), info(), warning(), error(), critical() 等函数，用于记录不同级别的日志消息。

import logging
logger.debug('这个是一个调试信息')
logger.info('这个是一条信息')
logger.warning('这个是一个警告信息')
logger.error('这个是一个错误信息')
logger.critical('这个是一个危急信息')

结合一下：

import logging
#创建日志器
logger = logging.getLogger('日志器')
logger.setLevel(logging.DEBUG)

#创建文件处理器和控制处理器
file_handler = logging.FileHandler('example.log',encoding='utf-8')
console_handler = logging.StreamHandler()

#创建格式化器
formatter = logging.Formatter('%(asctime)s - %(levelname)s- %(message)s')

# 将格式化器关联到处理器
file_handler.setFormatter(formatter)
console_handler.setFormatter(formatter)

#将处理器添加到日志器
logger.addHandler(file_handler)
logger.addHandler(console_handler)

#记录日志消息
logger.debug('这个是一个调试信息')
logger.info('这个是一条信息')
logger.warning('这个是一个警告信息')
logger.error('这个是一个错误信息')
logger.critical('这个是一个危急信息')

# 2023-12-21 09:52:40,152 - DEBUG- 这个是一个调试信息
# 2023-12-21 09:52:40,153 - INFO- 这个是一条信息
# 2023-12-21 09:52:40,153 - WARNING- 这个是一个警告信息
# 2023-12-21 09:52:40,153 - ERROR- 这个是一个错误信息
# 2023-12-21 09:52:40,153 - CRITICAL- 这个是一个危急信息

【5】Logging 日志工作流程

【 1 】Logging 模块使用过程

1. 第一次导入 logging 模块或使用 reload 函数重新导入 logging 模块，logging 模块中的代码将被执行，这个过程中将产生 logging 日志系统的默认配置。
2. 自定义配置(可选),logging标准模块支持三种配置方式: dictConfig，fileConfig，listen。其中，dictConfig 是通过一个字典进行配置 Logger，Handler，Filter，Formatter；fileConfig 则是通过一个文件进行配置；而 listen 则监听一个网络端口，通过接收网络数据来进行配置。当然，除了以上集体化配置外，也可以直接调用 Logger，Handler 等对象中的方法在代码中来显式配置。
3. 使用 logging 模块的全局作用域中的 getLogger 函数来得到一个 Logger 对象实例(其参数即是一个字符串，表示 Logger 对象实例的名字，即通过该名字来得到相应的 Logger 对象实例)。
4. 使用 Logger 对象中的 debug，info，error，warn，critical 等方法记录日志信息。

【 2 】Logging 模块处理流程

1. 判断日志的等级是否大于 Logger 对象的等级，如果大于，则往下执行，否则，流程结束。
2. 产生日志：第一步，判断是否有异常，如果有，则添加异常信息。 第二步，处理日志记录方法(如 debug，info 等)中的占位符，即一般的字符串格式化处理。
3. 使用注册到 Logger 对象中的 Filters 进行过滤。如果有多个过滤器，则依次过滤；只要有一个过滤器返回假，则过滤结束，且该日志信息将丢弃，不再处理，而处理流程也至此结束。否则，处理流程往下执行。
4. 在当前 Logger 对象中查找 Handlers，如果找不到任何 Handler，则往上到该 Logger 对象的父 Logger 中查找；如果找到一个或多个 Handler，则依次用 Handler 来处理日志信息。但在每个 Handler 处理日志信息过程中，会首先判断日志信息的等级是否大于该 Handler 的等级，如果大于，则往下执行(由 Logger 对象进入 Handler 对象中)，否则，处理流程结束。
5. 执行 Handler 对象中的 filter 方法，该方法会依次执行注册到该 Handler 对象中的 Filter。如果有一个 Filter 判断该日志信息为假，则此后的所有 Filter 都不再执行，而直接将该日志信息丢弃，处理流程结束。
6. 使用 Formatter 类格式化最终的输出结果。 注：Formatter 同上述第 2 步的字符串格式化不同，它会添加额外的信息，比如日志产生的时间，产生日志的源代码所在的源文件的路径等等。

• 真正地输出日志信息(到网络，文件，终端，邮件等)。至于输出到哪个目的地，由 Handler 的种类来决定。