Python开发之日志记录模块：logging
程序员文章站
2022-05-29 12:01:37
为代码添加日志是一个很好的习惯，可以极大方便代码调试和后期维护。本文详细总结了Python内置的日志记录模块logging的用法，并罗列了几个经典logging使用场景（技巧）。 ......
1 引言
最近在开发一个自动化测试系统，为方便调试和后期维护，在代码中添加了日志，用的是python内置的logging模块，看了许多博主的博文，颇有所得。不得不说，有许多博主大牛总结得确实很好。似乎我再写关于logging的博文有些多余，但不写总结又总觉得没掌握。那就写写吧，也方便日后回顾。
开始总结之前，先感谢几位博主，他们的博客写得很是详尽：
云游道士的博文：
说说为什么需要添加日志？
就像上面说的，为了调试和后期维护方便。也许在开发中没有太大体会，但是如果将软件部署到了生产环境中，一旦出现bug，没有日志，就很难对当时的情况进行追踪，有了日志，就可以根据日志尽可能的对当时的数据环境进行还原，方便debug。甚至，只要日志设计得足够合理，还可以用于后续业务数据分析等。
2 日志等级
为什么需要对日志进行划分等级呢？
当我们出于开发时debug的目的使用日志时，我们自然是想尽可能详尽得记录日志，但是如果部署到生产环境中，这样做就可能因为大量的io占用服务器资源，所以在生产环境中就只需要记录异常信息、错误情况等就好了。
所以，给日志设置等级，可以方便得、因地制宜控制日志输出。
这里只介绍python的logging模块的日志等级（当然，其他日志系统的日志等级划分事实上也基本相同）。logging的日志等级包括5个：
日志等级从上到下依次提高，当在程序中设定某个日志等级之后，比设定的日志等级低的日志记录将会被忽略，即logging就只会输出大于和等于设定的等级的日志。我们将在下文中通过代码示例证明这一点。
3 记录日志
logging模块提供两种方法记录日志：
（1）通过logging模块提供的模块级函数记录日志；
（2）通过logging模块提供的4大组件记录日志。
3.1 记录日志之logging模块级函数
在logging模块中，分别给出一个模块级别函数与上面说到的日志级别相对应，用于输出对应级别日志记录：
也有一个函数汇总了上面5个函数的功能：
现在可以来尝试使用一下上面的函数了：
import logging
logging.debug('debug')
logging.info('info')
logging.warn('warn')
logging.error('error')
logging.critical('critical')
logging.warn('today is %s',datetime.date.today())
运行结果如下：
warning:root:warn
error:root:error
critical:root:critical
warning:root:today is 2019-03-28
上面的函数都有*args, **kwargs这两个参数，所以这些函数可以接受任意位置参数和关键字参数，这些参数填充到第一个参数msg，最后一条日志输出中添加了当前日期就是利用了这个功能。
那为什么会只输出后面3条日志记录呢？上面说到过，logging就只会输出大于和等于设定的等级的日志记录，而logging的默认日志等级是warning，所以日志等级为debug和info的两条记录都没有被输出。
如果想要输入日志等级为debug和info的日志记录，就要对logging进行配置。logging也提供了一个模块级别的专用于配置logging的函数：
尝试使用一下这个配置函数：
import logging
logging.basicconfig(level=logging.debug) # 设置日志等级
logging.debug('debug')
logging.info('info')
logging.warn('warn')
logging.error('error')
logging.critical('critical')
运行结果如下：
debug:root:debug
info:root:info
warning:root:warn
error:root:error
critical:root:critical
看，日志等级为debug和info的两条记录也都得到了输出。
上面表格对logging.basicconfig函数的说明中指出，logging.basicconfig函数时一次性配置，什么意思呢？意思就是说，logging.basicconfig函数只在第一次运行（第一次对logging进行配置）时起作用，后面在此设置其他参数是不会生效的。通过代码证明一下：
import logging
logging.basicconfig(level=logging.debug) # 设置日志等级
logging.basicconfig(level=logging.info) # 重新设置日志等级
logging.debug('debug')
logging.info('info')
logging.warn('warn')
logging.error('error')
logging.critical('critical')
运行结果：
debug:root:debug
info:root:info
warning:root:warn
error:root:error
critical:root:critical
看到没，debug级别日志记录还是输出了，证明重新运行logging.basicconfig函数设置日志级别没有生效。
另外需要注意的是，一定要在使用logging记录日志之前使用logging.basicconfig进行配置，否则，不会有任何输出。
我们再观察一下上面的程序输出，可以发现，每一条输出的结果里，不仅仅只有我们输出的字符串参数，还有其它的一些信息，例如日志等级，日志器名称（默认是root），分隔符（这里是冒号）等，这些都是logging默认给我配置好的，当然，我们也可以通过logging.basicconfig函数的各参数自定义logging的输出。
上表中的参数format可以通过logging模块中定义好模式来设定值：
所以，结合上表中的内容，我们可以实现让每一条日志记录输出事件发生时间、事件发生位置、日志级别、事件内容等信息。
现在，我们来给刚才的日志添加一些输出，例如每条日志输出日志时间、日志级别、所在模块名、函数名、行号等信息，并指定时间输出格式，最后把日志输出到当前目录下的.log文件中。代码如下：
import logging
fmt = '%(asctime)s , %(levelname)s , %(filename)s %(funcname)s line %(lineno)s , %(message)s'
datefmt = '%y-%m-%d %h:%m:%s %a'
logging.basicconfig(level=logging.debug,
format=fmt,
datefmt=datefmt,
filename=".log")
logging.debug('debug')
logging.info('info')
logging.warn('warn')
logging.error('error')
logging.critical('critical')
运行上述代码后，控制台不会再有输出了，但当前目录下的.log文件会写入一下内容：
2019-03-28 16:34:08 thu , debug , log_test.py <module> line 8 , debug
2019-03-28 16:34:08 thu , info , log_test.py <module> line 9 , info
2019-03-28 16:34:08 thu , warning , log_test.py <module> line 10 , warn
2019-03-28 16:34:08 thu , error , log_test.py <module> line 11 , error
2019-03-28 16:34:08 thu , critical , log_test.py <module> line 12 , critical
3.2 记录日志之logging四大组件
logging四大组件是logging日志记录的高级用法。四大组件包括logger、handelr、filter、formater，且都是以类的形式来使用。logging四大组件协同工作流如下如所示：
各组件功能如下：
上一篇： .net之设计模式
发表评论