python——日志模块（logging）

日志模块主要用于输出运行日志，可以设置输出日志的等级、日志保存路径、日志文件回滚等

一、优势

可以通过设置不同的日志等级，在release版本中只输出重要信息，而不必显示大量的调试信息；
print将所有信息都输出到标准输出中，严重影响开发者从标准输出中查看其它数据；logging则可以由开发者决定将信息输出到什么地方，以及怎么输出。

二、等级（level）

开发应用程序或部署开发环境时，可以使用DEBUG或INFO级别的日志获取尽可能详细的日志信息来进行开发或部署调试
应用上线或部署生产环境时，应该使用WARNING或ERROR或CRITICAL级别的日志来降低机器的I/O压力和提高获取错误日志信息的效率。日志级别的指定通常都是在应用程序的配置文件中进行指定的。
分级

日志等级：DEBUG < INFO < WARNING < ERROR

• DEBUG 最详细的日志信息，典型应用场景是 问题诊断
• INFO 信息详细程度仅次于DEBUG，通常只记录关键节点信息，用于确认一切都是按照我们预期的那样进行工作
• WARNING 当某些不期望的事情发生时记录的信息（如，磁盘可用空间较低），但是此时应用程序还是正常运行的
• ERROR 由于一个更严重的问题导致某些功能不能正常运行时记录的信息
• CRITICAL 当发生严重错误，导致应用程序不能继续运行时记录的信息

三、使用方式

1.使用logging提供的模块级别的函数

创建一条日志记录

• 创建一条严重级别为DEBUG的日志记录 logging.debug(msg, *args, **kwargs)
• 创建一条严重级别为INFO的日志记录 logging.info(msg, *args, **kwargs)
• 创建一条严重级别为WARNING 的日志记录 logging.warning(msg, *args, **kwargs)
• 创建一条严重级别为ERROR的日志记录 logging.error(msg, *args, **kwargs)
• 创建一条严重级别为CRITICAL的日志记录 logging.critical(msg, *args, **kwargs)
• 创建一条严重级别为level的日志记录 logging.log(level, *args, **kwargs)

例：
import logging

logging.debug("debug_msg")

logging.info("info_msg")

logging.warning("warning_msg")

logging.error("error_msg")

logging.critical("critical_msg") 

默认情况下logging模块将日志打印到只显示了大于等于WARNING级别的日志，这说明默认的日志级别设置为WARNING（日志级别等级CRITICAL > ERROR > WARNING > INFO > DEBUG）

默认的日志格式为日志级别：Logger名称：用户输出消息

2.对root logger进行一次性配置

logging.basicConfig(**kwargs) 

logging.basicConfig(**kwargs)函数 用于指定“要记录的日志级别”、“日志格式”、“日志输出位置”、“日志文件的打开模式”等信息，其他几个都是用于记录各个级别日志的函数。
用默认日志格式（Formatter）为日志系统建立一个默认的流处理器（StreamHandler），设置基础配置（如日志级别等）并加到root logger（根Logger）中）

logging.basicConfig()函数参数说明

• filename 指定日志输出目标文件的文件名（可以写文件名也可以写文件的完整的绝对路径，写文件名日志放执行文件目录下，写完整路径按照完整路径生成日志文件），指定该设置项后日志信心就不会被输出到控制台了
• filemode 指定日志文件的打开模式，默认为’a’。需要注意的是，该选项要在filename指定时才有效
• format 指定日志格式字符串，即指定日志输出时所包含的字段信息以及它们的顺序。logging模块定义的格式字段下面会列出。
• datefmt 指定日期/时间格式。需要注意的是，该选项要在format中包含时间字段%(asctime)s时才有效
• level 指定日志器的日志级别
• stream 指定日志输出目标stream，如sys.stdout、sys.stderr以及网络stream。需要说明的是，stream和filename不能同时提供，否则会引发 ValueError异常
• style Python 3.2中新添加的配置项。指定format格式字符串的风格，可取值为’%‘、’{‘和’$‘，默认为’%’
• handlers Python3.3中新添加的配置项。该选项如果被指定，它应该是一个创建了多个Handler的可迭代对象，这些handler将会被添加到root logger。需要说明的是：filename、stream和handlers这三个配置项只能有一个存在，不能同时出现2个或3个，否则会引发ValueError异常。

例
import logging
logging.basicConfig(level=logging.DEBUG,
                    format="%(asctime)s %(name)s %(levelname)s %(message)s",
                    datefmt = '%Y-%m-%d  %H:%M:%S %a'   
                    ) #注意月份和天数不要搞乱了，这里的格式化符与time模块相同
logging.debug("msg1")
logging.info("msg2")
logging.warning("msg3")
logging.error("msg4")
logging.critical("msg5") 

结果：
2023-03-01  23:37:49 Wed root DEBUG msg1
2023-03-01  23:37:49 Wed root INFO msg2
2023-03-01  23:37:49 Wed root WARNING msg3
2023-03-01  23:37:49 Wed root ERROR msg4
2023-03-01  23:37:49 Wed root CRITICAL msg5 

四、日志流处理流程（使用Logging日志系统的四大组件）

日志器（logger）是入口，真正干活儿的是处理器（handler），处理器（handler）还可以通过过滤器（filter）和格式器（formatter）对要输出的日志内容做过滤和格式化等处理操作。

1.日志器-Logger

提供了应用程序可一直使用的接口
功能
1）向应用程序代码暴露几个方法，使应用程序可以在运行时记录日志消息；
2）基于日志严重等级（默认的过滤设施）或filter对象来决定要对哪些日志进行后续处理；
3）将日志消息传送给所有感兴趣的日志handlers。
Logger对象最常用的方法分为两类：配置方法 和 消息发送方法

配置方法
Logger.setLevel() 设置日志器将会处理的日志消息的最低严重级别
Logger.addHandler() 和 Logger.removeHandler() 为该logger对象添加 和 移除一个handler对象
Logger.addFilter() 和 Logger.removeFilter() 为该logger对象添加 和 移除一个filter对象

创建日志记录

• 创建一个与它们的方法名对应等级的日志记录
  Logger.debug(), Logger.info(), Logger.warning(), Logger.error(), Logger.critical()

• 创建一个类似于Logger.error()的日志消息
  Logger.exception()

• 需要获取一个明确的日志level参数来创建一个日志记录
  Logger.log()

2.处理器 -Handler

将logger创建的日志记录分发到handler指定的位置（文件、网络、邮件等）。

子类
- logging.StreamHandler 将日志消息发送到输出到Stream，如std.out, std.err或任何file-like对象。
- logging.FileHandler 将日志消息发送到磁盘文件，默认情况下文件大小会无限增长
- logging.handlers.RotatingFileHandler 将日志消息发送到磁盘文件，并支持日志文件按大小切割
- logging.hanlders.TimedRotatingFileHandler 将日志消息发送到磁盘文件，并支持日志文件按时间切割
- logging.handlers.HTTPHandler 将日志消息以GET或POST的方式发送给一个HTTP服务器
- logging.handlers.SMTPHandler 将日志消息发送给一个指定的email地址
- logging.NullHandler 该Handler实例会忽略error messages，通常被想使用logging的library开发者使用来避免’No handlers could be found for logger XXX’信息的出现。

说明
Handler.setLevel(lel):指定被处理的信息级别，低于lel级别的信息将被忽略
Handler.setFormatter()：给这个handler选择一个格式
Handler.addFilter(filt)、Handler.removeFilter(filt)：新增或删除一个filter对象

3.过滤器 -Filter

提供了更细粒度的控制工具来决定输出哪条日志记录，丢弃哪条日志记录
Filter是一个过滤器基类，它只允许某个logger层级下的日志事件通过过滤
定义
class logging.Filter(name=‘’)
filter(record)

4.格式器 Formatter

配置日志信息的最终顺序、结构和内容。
Formatter类的构造方法

logging.Formatter.__init__(fmt=None, datefmt=None, style='%')

	参数
		fmt：指定消息格式化字符串，如果不指定该参数则默认使用message的原始值
		datefmt：指定日期格式字符串，如果不指定该参数则默认使用"%Y-%m-%d %H:%M:%S"
		style：Python 3.2新增的参数，可取值为 '%', '{'和 '$'，如果不指定该参数则默认使用'%'

5.日志流处理简要流

1、创建一个logger
2、设置下logger的日志的等级
3、创建合适的Handler(FileHandler要有路径)
4、设置下每个Handler的日志等级
5、创建下日志的格式
6、向Handler中添加上面创建的格式
7、将上面创建的Handler添加到logger中
8、打印输出logger.debug\logger.info\logger.warning\logger.error\logger.critical

6.实例

import logging

# 创建日志器对象
logger = logging.getLogger(__name__)

# 设置logger可输出日志级别范围
logger.setLevel(logging.DEBUG)

# 添加控制台handler，用于输出日志到控制台
console_handler = logging.StreamHandler()

# 添加日志文件handler，用于输出日志到文件中
file_handler = logging.FileHandler(filename='log.log', encoding='UTF-8')

# 将handler添加到日志器中
logger.addHandler(console_handler)
logger.addHandler(file_handler)

# 设置格式并赋予handler
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
console_handler.setFormatter(formatter)
file_handler.setFormatter(formatter)

# 输出不同级别日志
logger.debug("============【开始测试】====================")
logger.info("============【开始测试】====================")
logger.warning("============【开始测试】====================")
logger.critical("============【开始测试】====================")
logger.error("============【开始测试】====================")



结果为：

2023-03-18 02:32:46,316 - __main__ - DEBUG - ============【开始测试】====================
2023-03-18 02:32:46,316 - __main__ - INFO - ============【开始测试】====================
2023-03-18 02:32:46,316 - __main__ - WARNING - ============【开始测试】====================
2023-03-18 02:32:46,316 - __main__ - CRITICAL - ============【开始测试】====================
2023-03-18 02:32:46,316 - __main__ - ERROR - ============【开始测试】====================