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 相关文章推荐
Python3基础之输入和输出实例分析
Aug 18 Python
讲解Python中fileno()方法的使用
May 24 Python
学习python之编写简单简单连接数据库并执行查询操作
Feb 27 Python
Python实现EXCEL表格的排序功能示例
Jun 25 Python
Python装饰器使用你可能不知道的几种姿势
Oct 25 Python
Python常用模块logging——日志输出功能(示例代码)
Nov 20 Python
python3将变量写入SQL语句的实现方式
Mar 02 Python
python 解决Fatal error in launcher:错误问题
May 21 Python
pytorch快速搭建神经网络_Sequential操作
Jun 17 Python
python获取百度热榜链接的实例方法
Aug 25 Python
Scrapy-Redis之RedisSpider与RedisCrawlSpider详解
Nov 18 Python
Python函数式编程中itertools模块详解
Sep 15 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
php多重接口的实现方法
2015/06/20 PHP
PHP判断一个数组是另一个数组子集的方法详解
2017/07/31 PHP
php处理多图上传压缩代码功能
2018/06/13 PHP
快速解决jquery之get缓存问题的最简单方法介绍
2013/12/19 Javascript
input标签内容改变的触发事件介绍
2014/06/18 Javascript
js自动生成的元素与页面原有元素发生堆叠的解决方法
2014/09/04 Javascript
20个实用的JavaScript技巧分享
2014/11/28 Javascript
javascript正则表达式之search()用法实例
2015/01/19 Javascript
JavaScript实现带播放列表的音乐播放器实例分享
2016/03/07 Javascript
ES2015 Symbol 一种绝不重复的值
2016/12/25 Javascript
js实现微博发布小功能
2017/01/12 Javascript
解决vue.js this.$router.push无效的问题
2018/09/03 Javascript
vue.js实现三级菜单效果
2019/10/19 Javascript
使用Vue实现调用接口加载页面初始数据
2019/10/28 Javascript
Vue 修改网站图标的方法
2020/12/31 Vue.js
javascript实现简单留言板案例
2021/02/09 Javascript
python进阶教程之循环相关函数range、enumerate、zip
2014/08/30 Python
基于wxpython开发的简单gui计算器实例
2015/05/30 Python
Python实现类似jQuery使用中的链式调用的示例
2016/06/16 Python
对pandas的行列名更改与数据选择详解
2018/11/12 Python
Python3之不使用第三方变量,实现交换两个变量的值
2019/06/26 Python
python函数的作用域及关键字详解
2019/08/20 Python
Django中自定义查询对象的具体使用
2019/10/13 Python
美国珠宝精品店:Opulent Jewelers
2019/08/20 全球购物
人力资源专员自我评价怎么写
2013/09/19 职场文书
师范应届生教师求职信
2013/11/05 职场文书
大学生职业生涯规划书模版
2013/12/30 职场文书
销售主管岗位职责范本
2014/02/14 职场文书
网络信息安全承诺书
2014/03/26 职场文书
委托书的写法
2014/09/16 职场文书
小学班主任个人总结
2015/03/03 职场文书
篮球赛新闻稿
2015/07/17 职场文书
大学生奶茶店创业计划书
2019/06/25 职场文书
python 中[0]*2与0*2的区别说明
2021/05/10 Python
Django drf请求模块源码解析
2021/06/08 Python
解决Oracle数据库用户密码过期
2022/05/11 Oracle