Python中logging实例讲解


Posted in Python onJanuary 17, 2019

logging 的基本用法网上很多,这里就不介绍了。在引入正文之前,先来看一个需求:

假设需要将某功能封装成类库供他人使用,如何处理类库中的日志?

数年前在一个 C# 开发的项目中,我用了这样的方法:定义一个 logging 基类,所有需要用到日志的类都继承这个基类,这个基类中定义一个 LogHandler 事件,该事件用于实现具体的记录日志动作,同时可以通过将类 A 的 LogHandler 委托挂到类 B 的 LogHandler 上,实现将两个类的日志信息添加到一起。

自从看了 python 中 logging 的实现方式,我发现我的做法真是弱爆了。

我在之前的博客 Python:logging.NullHandler 的使用 中介绍了 peewee 框架中的日志输出,简单来说就是 peewee 中定义了一个名为peewee 的 Logger 并添加了一个 NullHandler,调用者只需要为其添加具体的 Handler 就可以输出日志了,非常方便。

Python中logging实例讲解

假设我们在主程序中也有一个 Logger,调用 peewee 后,我想将两个日志输出到同一个日志文件中去。显然将两个日志的 FileHandler 指向同一个日志文件是不可取的,存在并发抢占文件的风险。当然我们也可以将主程序中的 Logger 名字定为 peewee,但这不仅太 low 了,而且如果再调用一个库,其中也封装好了一个 Logger,就不好处理了。

树桩结构的 Logger

Logger 对象被设计为一个树形结构,它有一个 parent 属性。logging 中定义了一个名为 root 的 Logger 作为所有 Logger 的根节点,root 的 parent 属性为 None。root 是全局的。

当调用

logging.getLogger(name=None)

得到一个 Logger 对象的时候,如果 name 为 None,则返回根节点 root。如果 name 中含有 .,比如 name = 'a.b',这时如果已经存在了名为 a 的 Logger,则 a.b 为 a 的子节点,如果不存在名为 a 的 Logger,则 a.b 为 root 的子节点。

child logger 在完成对日志消息的处理后,默认会将日志消息传递给与它的 parent logger。因此,我们不必为一个应用程序中使用的所有 Logger 定义和配置 handlers,只需要为一个顶层的 Logger 配置 handlers,然后按照需要创建 child loggers 就可足够了。我们可以通过设置 Logger 的 propagate 属性设置为 False 来关闭这种传递机制。

什么意思呢,我们来看代码:

import logging
logA = logging.getLogger('a')
logA.setLevel(logging.DEBUG)
logA.addHandler(logging.StreamHandler())
logB = logging.getLogger('a.b')
logB.addHandler(logging.StreamHandler())

输出结果:

Logger A
Logger B
Logger B

之所以 Logger B 被输出了 2 次,是因为 logB 是 logA 的子节点,并且 logB 中也定义了 Handler,所以 logB 的 Handler 输出了一次,logA 的 Handler 也输出了一次,就 2 次了。如果想只输出一次,可以删掉 logB 中的 Handler。当然,这也是有用处的,尤其是当你手头没有日志管理工具的时候。例如,主程序中需要输出所有的日志,以便了解程序整体的运行顺序,而某模块的日志,你想单独输出一份,以便清晰了解模块中的报错或者是执行顺序。

之前 peewee 的例子也就很容易解决了,只需要将 peewee 日志的 parent 属性设置为主程序的日志就可以了。

结语

其实这是一个比较容易说明的问题,完全没必要写这么多。我并不想跟大家分享 python 中的 logging 是怎么用的,而是想和大家分享 logging 如此实现的一种思想,因为我遇到过这个问题,也设计了解决方案,然后被完爆了。

Python 相关文章推荐
python中安装Scrapy模块依赖包汇总
Jul 02 Python
Python读取txt内容写入xls格式excel中的方法
Oct 11 Python
利用python在excel里面直接使用sql函数的方法
Feb 08 Python
jenkins配置python脚本定时任务过程图解
Oct 29 Python
Python数据可视化:泊松分布详解
Dec 07 Python
Python操作redis和mongoDB的方法
Dec 19 Python
python 微信好友特征数据分析及可视化
Jan 07 Python
python爬虫开发之使用Python爬虫库requests多线程抓取猫眼电影TOP100实例
Mar 10 Python
ubuntu 安装pyqt5和卸载pyQt5的方法
Mar 24 Python
Python telnet登陆功能实现代码
Apr 16 Python
Python字符串split及rsplit方法原理详解
Jun 29 Python
Python 使用office365邮箱的示例
Oct 29 Python
python矩阵/字典实现最短路径算法
Jan 17 #Python
python实现Dijkstra静态寻路算法
Jan 17 #Python
解决在Python编辑器pycharm中程序run正常debug错误的问题
Jan 17 #Python
python实现dijkstra最短路由算法
Jan 17 #Python
Pycharm 设置默认头的图文教程
Jan 17 #Python
python实现狄克斯特拉算法
Jan 17 #Python
在PyCharm下使用 ipython 交互式编程的方法
Jan 17 #Python
You might like
图片存储与浏览一例(Linux+Apache+PHP+MySQL)
2006/10/09 PHP
php 将excel导入mysql
2009/11/09 PHP
Apache 配置详解(最好的APACHE配置教程)
2010/07/04 PHP
php返回当前日期或者指定日期是周几
2015/05/21 PHP
Ubuntu下安装PHP的mongodb扩展操作命令
2015/07/04 PHP
JavaScript 动态改变图片大小
2009/06/11 Javascript
别了 JavaScript中的isXX系列
2012/08/01 Javascript
jQuery实现动画效果的实例代码
2013/05/07 Javascript
JavaScript实现QueryString获取GET参数的方法
2013/07/02 Javascript
js实现文本框只允许输入数字并限制数字大小的方法
2015/08/19 Javascript
基于jQuery实现自动轮播旋转木马特效
2015/11/02 Javascript
浅谈vue中慎用style的scoped属性
2017/11/28 Javascript
nodejs结合Socket.IO实现的即时通讯功能详解
2018/01/12 NodeJs
vue+springmvc导出excel数据的实现代码
2018/06/27 Javascript
js运算符的一些特殊用法
2018/07/29 Javascript
微信小程序 JS动态修改样式的实现方法
2018/12/16 Javascript
微信小程序实现简单跑马灯效果
2020/05/26 Javascript
详解React服务端渲染从入门到精通
2019/03/28 Javascript
微信小程序实现录音功能
2019/11/22 Javascript
15分钟上手vue3.0(小结)
2020/05/20 Javascript
Element图表初始大小及窗口自适应实现
2020/07/10 Javascript
JS轮播图的实现方法
2020/08/24 Javascript
js实现简单图片拖拽效果
2021/02/22 Javascript
[55:39]DOTA2-DPC中国联赛 正赛 VG vs LBZS BO3 第二场 1月19日
2021/03/11 DOTA
详解Python中的Descriptor描述符类
2016/06/14 Python
总结网络IO模型与select模型的Python实例讲解
2016/06/27 Python
python 中的int()函数怎么用
2017/10/17 Python
pandas中去除指定字符的实例
2018/05/18 Python
Python使用pymongo模块操作MongoDB的方法示例
2018/07/20 Python
tensorflow 重置/清除计算图的实现
2020/01/19 Python
Python实现加密的RAR文件解压的方法(密码已知)
2020/09/11 Python
谈谈对css属性box-sizing的了解
2017/01/04 HTML / CSS
历史学专业大学生找工作的自我评价
2013/10/16 职场文书
中学生运动会入场词
2014/02/12 职场文书
医德医风自我评价
2014/09/19 职场文书
乡镇领导班子批评与自我批评材料
2014/09/23 职场文书