logging模块用法简介(Python)_python logging
目录
一. 基本使用
1. 五种日志等级
2. 设置报告等级
3. 自定义格式
4. C语言风格的格式化方法
5. 将日志输出到文件
6. 屏蔽一些刷屏信息
二. 高级用法
1. 日志记录器
2. 日志处理器
3. 日志格式器
4. 拼接组件
三. 总结
logging是Python中拿来进行日志记录的标准库，可以方便地跟踪程序的运行状态，再也不需要手动添加一大堆的print了！
这篇文章目的是简单地介绍一下它的基本用法，其实这个模块内容还挺多的，包括记录器、处理器、过滤器、格式器等多种工具。不过对于平常的应用，记录器就够了。
一. 基本使用
1. 五种日志等级
首先导入logging，然后可以直接使用下面的函数来记录：
- logging.debug()，调试细节信息，严重程度最低。
- logging.info()，普通的消息。
- logging.warning()，警告，但是程序仍可以执行；默认报告此级别及以上的日志。
- logging.error()，错误，可能导致程序部分功能失败。
- logging.critical()，严重错误，可能导致程序直接失败。
下面是例子：
import logginglogging.debug(\'调试\')logging.info(\'信息\')# 默认忽略以上两个等级的信息logging.warning(\'警告\')logging.error(\'错误\')logging.critical(\'重大错误\') 
默认情况下，日志是下面的格式：
- {日志等级}:{日志记录器名称}:{消息}
2. 设置报告等级
想要自己定义日志的行为，可以使用logging.basicConfig()来设置。比如，通过指定level可以更改进行报告的最低日志等级：
import logginglogging.basicConfig( level=logging.DEBUG)logging.debug(\'调试\')logging.info(\'信息\')# 现在上面两条信息也会报告logging.warning(\'警告\')logging.error(\'错误\')logging.critical(\'重大错误\') 
3. 自定义格式
默认的日志格式不太好看，我们可以自定义日志的输出格式。只要在basicConfig里设置format就可以了。下面是一些常用的可选项：
- %(asctime)s，表示人类易读的日志生成时间。 默认形式为 \'2003-07-08 16:49:45,896\' （逗号之后的数字为时间的毫秒部分）。
- %(filename)s，执行报告的文件路径中的文件名部分。
- %(module)s，执行日志记录的模块名称。
- %(levelname)s，日志的等级。
- %(name)s，日志记录器的名称，如果直接用logging就是“root”。
- %(message)s，日志的具体信息。
如要了解全部选项，可以去官方文档查看：
logging
https://docs.python.org/zh-cn/3.13/library/logging.html#logrecord-attributes
比如，下面以自定义格式进行日志记录：
import logginglogging.basicConfig( level=logging.DEBUG, format=\'报告时间:%(asctime)s 报告等级:%(levelname)s; %(message)s\')logging.debug(\'调试\')logging.info(\'信息\')logging.warning(\'警告\')logging.error(\'错误\')logging.critical(\'重大错误\')
那个asctime还可以自己定义行为，只要指定datefmt即可。 它的格式化微语言和datetime一样，下面是AI整理的表格：
比如，下面的方法让asctime只输出日期和时分秒：
import logginglogging.basicConfig( level=logging.DEBUG, format=\'报告时间:%(asctime)s 报告等级:%(levelname)s; %(message)s\', datefmt=\'%d日 %H时 %M分 %S秒\')logging.debug(\'调试\')logging.info(\'信息\')logging.warning(\'警告\')logging.error(\'错误\')logging.critical(\'重大错误\')
4. C语言风格的格式化方法
如果我想在日志信息中使用一些变量该怎么办呢？处了用Python的方法，也可以用%s这种C风格的格式化方法，logging是一个元老级的模块，采用这种远古方式是为了向下兼容。
下面是Python的方法：
import logginglogging.basicConfig( level=logging.DEBUG, format=\'报告时间:%(asctime)s 报告等级:%(levelname)s; %(message)s\', datefmt=\'%d日 %H时 %M分 %S秒\')param = \'你好，我是变量！\'logging.debug(f\'变量：{param}\') 
下面是C风格的方法：
import logginglogging.basicConfig( level=logging.DEBUG, format=\'报告时间:%(asctime)s 报告等级:%(levelname)s; %(message)s\', datefmt=\'%d日 %H时 %M分 %S秒\')param1 = \'param1\'param2 = \'param2\'param3 = \'param3\'logging.debug(\'我有三个变量,它们是:\\n%s\\n%s\\n和%s\', param1, param2, param3)
5. 将日志输出到文件
想要让日志输出到文件是很容易的， 只要指定filename即可。还可以指定encoding，如果不指定它，则使用open()函数的默认编码解码器。日志文件推荐使用.log而不是.txt后缀：
import logginglogging.basicConfig( level=logging.DEBUG, format=\'报告时间:%(asctime)s 报告等级:%(levelname)s; %(message)s\', datefmt=\'%d日%H时%M分%S秒\', filename=\'report.log\')logging.info(\'Hello\')logging.info(\'World!\')logging.info(\'I is 🐍\')
日志的写入方式默认是“a”，也就是向后追加。有时我们可能想让日志覆盖原来的内容，这时可以指定filemode更改写入方式，例如：
import logginglogging.basicConfig( level=logging.DEBUG, format=\'报告时间:%(asctime)s 报告等级:%(levelname)s; %(message)s\', datefmt=\'%d日%H时%M分%S秒\', filename=\'report.log\', filemode=\'w\')logging.info(\'Hello\')logging.info(\'World!\')logging.info(\'I is 🐍\')6. 屏蔽一些刷屏信息
有些模块在内部使用了logging，如果我们也导入使用logging就会触发它们的报告。比如，httpx会在请求成功时发送一条info日志，当我们配置logging后这些信息就可能出现：
import loggingimport httpxlogging.basicConfig( level=logging.INFO, format=\'%(asctime)s-%(levelname)s; %(message)s\', datefmt=\'%d日%H时%M分%S秒\')BASE_URL = \'https://www.httpbin.org/get\'def scrape(url): try: response = httpx.get(url) except httpx.RequestError: raise else: return response.text from concurrent.futures import ThreadPoolExecutorwith ThreadPoolExecutor() as e: e.map(scrape, [BASE_URL for _ in range(10)])
可以看到，因为我指定level=logging.INFO，httpx的这些info日志就输出了。看着好烦人啊，如果我不想让它输出怎么办？
首先要找到“罪魁祸首”是谁，用getLogger获取这个日志记录器，再用setLevel方法更改它输出的最低日志等级即可。比如，下面在basicConfig下加了一条语句，阻止httpx刷屏。
import loggingimport httpxlogging.basicConfig( level=logging.INFO, format=\'%(asctime)s-%(levelname)s; %(message)s\', datefmt=\'%d日%H时%M分%S秒\')logging.getLogger(\'httpx\').setLevel(logging.WARNING)BASE_URL = \'https://www.httpbin.org/get\'def scrape(url): logging.info(\'开始访问%s\', url) try: response = httpx.get(url) except httpx.RequestError: logging.critical(\'出错了!%s\', url) raise else: logging.info(\'请求成功%s\', url) return response.text from concurrent.futures import ThreadPoolExecutorwith ThreadPoolExecutor() as e: e.map(scrape, [BASE_URL for _ in range(10)])现在就只输出了我自己指定的信息：
二. 高级用法
掌握了上面的内容，就掌握了这个模块的精髓和核心，大部分情况下完全够用了。
高级用法我就稍微说说吧，如果需要更详细的指导请移步官方文档翻阅资料。
之前说过， logging库有记录器、处理器、过滤器、格式器等组件。具体来说，每个记录器logger可以有多个处理器handler，而每个处理器又可以有自己的格式器formatter。过滤器给logger或handler提供了更详细的输出细节，不过这里不谈论它。
为了帮读者专注于理解API的用法，而不是被混乱的命名弄乱，下面我将使用中文作为变量名。
1. 日志记录器
可以使用logging.Logger来指定记录器，推荐传入__name__参数作为它的名字。
import logging记录器 = logging.Logger(__name__)使用setLevel()方法可以控制它的日志等级，决定要将什么等级的日志传给处理器。
单独的记录器什么也做不到，需要和其它组件配合。
2. 日志处理器
处理器可以用来控制日志的输出方向。比如输出到终端和文件，分别对应下面两个常用的处理器类：
- StreamHandler()
- FileHandler()
处理器也有setLevel()方法，用于筛选在从logger那里接收到的日志，决定发送哪些。
下面指定一个流处理器和一个文件处理器：
import logging记录器 = logging.Logger(__name__)流处理器 = logging.StreamHandler()文件处理器 = logging.FileHandler(\'report.log\', mode=\'w\', encoding=\'utf-8\')3. 日志格式器
这个其实就是basicConfig的format参数的封装，作用是一样的。可以指定fmt和datefmt参数，例如：
import logging记录器 = logging.Logger(__name__)流处理器 = logging.StreamHandler()文件处理器 = logging.FileHandler(\'report.log\', mode=\'w\', encoding=\'utf-8\')流格式器 = logging.Formatter( fmt=\'%(asctime)s-%(levelname)s; %(message)s\', datefmt=\'时间:%H:%M:%S\')文件格式器 = logging.Formatter( fmt=\'%(asctime)s=%(levelname)s=%(name)s; %(message)s\', datefmt=\'记录时间:%I:%M:%S,%p\')4. 拼接组件
下面拼接一下这些组件，就能让logger获取相应的功能。
首先，为处理器绑定格式器：
流处理器.setFormatter(流格式器)文件处理器.setFormatter(文件格式器)然后，为记录器绑定处理器：
记录器.setLevel(logging.INFO)记录器.addHandler(流处理器)记录器.addHandler(文件处理器)现在记录器就可以使用了。它会同时完成向终端和向文件输出的两个任务：
记录器.info(\'这是个信息\')记录器.warning(\'警告!没事没事\')记录器.error(\'错误!虽然我也不知道哪里错了\')记录器.critical(\'天塌了!我当被子盖\')记录器.info(\'纵有疾风起，人生不言弃\')
完整代码：
import logging记录器 = logging.Logger(__name__)流处理器 = logging.StreamHandler()文件处理器 = logging.FileHandler(\'report.log\', mode=\'w\', encoding=\'utf-8\')流格式器 = logging.Formatter( fmt=\'%(asctime)s-%(levelname)s; %(message)s\', datefmt=\'时间:%H:%M:%S\')文件格式器 = logging.Formatter( fmt=\'%(asctime)s=%(levelname)s=%(name)s; %(message)s\', datefmt=\'记录时间:%I:%M:%S,%p\')流处理器.setFormatter(流格式器)文件处理器.setFormatter(文件格式器)记录器.setLevel(logging.INFO)记录器.addHandler(流处理器)记录器.addHandler(文件处理器)记录器.info(\'这是个信息\')记录器.warning(\'警告!没事没事\')记录器.error(\'错误!虽然我也不知道哪里错了\')记录器.critical(\'天塌了!我当被子盖\')记录器.info(\'纵有疾风起，人生不言弃\')关于logging的高级用法，我们点到为止。有需求的同志可以去官方文档继续深造。
三. 总结
我们了解了一下logging模块的用法，对于高级用法点到为止了。这个模块相当强大，适用于想要跟踪程序行为的情况，可以使得捕获和修复错误更容易。它的上限远不止于此，欢迎同志们继续学习(*￣▽￣)~*
