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求两个文本文件以行为单位的交集、并集与差集的方法
Jun 17 Python
Python设计足球联赛赛程表程序的思路与简单实现示例
Jun 28 Python
python PyTorch预训练示例
Feb 11 Python
Python使用min、max函数查找二维数据矩阵中最小、最大值的方法
May 15 Python
python 列表降维的实例讲解
Jun 28 Python
python三方库之requests的快速上手
Mar 04 Python
python print出共轭复数的方法详解
Jun 25 Python
python读写配置文件操作示例
Jul 03 Python
python切片的步进、添加、连接简单操作示例
Jul 11 Python
Python如何基于rsa模块实现非对称加密与解密
Jan 03 Python
python实现人像动漫化的示例代码
May 17 Python
python中逻辑与或(and、or)和按位与或异或(&、|、^)区别
Aug 05 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
苏联队长,苏联超人蝙蝠侠,这些登场的“山寨”英雄真的很严肃
2020/04/09 欧美动漫
怎么使 Mysql 数据同步
2006/10/09 PHP
ExtJS与PHP、MySQL实现存储的方法
2010/04/02 PHP
用php的ob_start来生成静态页面的方法分析
2011/03/09 PHP
PHP引用符&的用法详细解析
2013/08/22 PHP
php实现简单的MVC框架实例
2015/09/23 PHP
php封装单文件上传到数据库(路径)
2017/10/15 PHP
laravel + vue实现的数据统计绘图(今天、7天、30天数据)
2018/07/31 PHP
浅析PHP反序列化中过滤函数使用不当导致的对象注入问题
2020/02/15 PHP
执行iframe中的javascript方法
2008/10/07 Javascript
一个简单的js鼠标划过切换效果
2010/06/30 Javascript
用Javascript实现Sleep暂停功能代码
2010/09/03 Javascript
2010年最佳jQuery插件整理
2010/12/06 Javascript
深入理解JavaScript系列(48):对象创建模式(下篇)
2015/03/04 Javascript
微信小程序 Video API实例详解
2016/10/02 Javascript
浅谈javascript alert和confirm的美化
2016/12/15 Javascript
基于JavaScript实现窗口拖动效果
2017/01/18 Javascript
jQuery插件zTree实现更新根节点中第i个节点名称的方法示例
2017/03/08 Javascript
javascript中this用法实例详解
2017/04/06 Javascript
js中DOM事件绑定分析
2018/03/18 Javascript
python 多线程应用介绍
2012/12/19 Python
Python浅复制中对象生存周期实例分析
2018/04/02 Python
python Web开发你要理解的WSGI & uwsgi详解
2018/08/01 Python
flask框架jinja2模板与模板继承实例分析
2019/08/01 Python
详解Canvas 实现炫丽的粒子运动效果(粒子生成文字)
2018/02/01 HTML / CSS
联想新西兰官方网站:Lenovo New Zealand
2018/10/30 全球购物
区三好学生主要事迹
2014/01/30 职场文书
《木笛》教学反思
2014/03/01 职场文书
公开承诺书格式
2014/05/21 职场文书
大学军训决心书
2015/02/05 职场文书
2015年学校财务工作总结
2015/05/19 职场文书
千手观音观后感
2015/06/03 职场文书
高中生物教学反思
2016/02/20 职场文书
解决golang post文件时Content-Type出现的问题
2021/05/02 Golang
Jupyter Notebook内使用argparse报错的解决方案
2021/06/03 Python
教你如何使用Python Tkinter库制作记事本
2021/06/10 Python