Python Logging 日志记录入门学习


Posted in Python onJune 02, 2018

Python Logging原来真的远比我想象的要复杂很多很多,学习路线堪比git。但是又绕不过去,alternatives又少,所以必须要予以重视,踏踏实实认认真真的来好好学学才行。

学习Logging的目的:

简单脚本还好,print足够。

但是稍微复杂点,哪怕是三四个文件加起来两三百行代码,调试也开始变复杂起来了。

再加上如果是后台长期运行的那种脚本,运行信息的调查更是复杂起来。

一开始我还在各种查crontab的日志查看,或者是python后台运行查看,或者是python stdout的获取等等,全都找错了方向。

真正的解决方案在于正确的logging。

记录好了的话,我不需要去找python的控制台输出stdout,也不需要找crontab的日志,只需要查看log文件即可。

下面是python的logging学习记录。

最简单的日志输出(无文件记录)

import logging
 
logging.error("出现了错误")
logging.info("打印信息")
logging.warning("警告信息")

首先,忘掉logging.info()! 忘掉logging.basicConfig()!

网上各种关于python logging的文章实在是太不体谅新手了,logging这么复杂的东西竟然想表现得很简单,还用各种简单的东西做假象。

实际上我们真正要用起来的日志,绝对是不会直接用logging.info()logging.basicConfig()这样的,这是此模块的官方推出来迷惑人的——看似让你一键上手,快速看到结果,但是跟实际真的不搭!

所以为了后面解释起来轻松,必须先警告这点:忘记它们俩!

记住,唯一要用到logging.什么的,就只有logging.getLogger()这一次。

了解logging的工作流

不想上流程图一类的东西,那样反而更迷糊。

简单说吧:

logging模块是会自动将你自定制的logger对象全局化的,

也就是说,你在自己的模块里只要定义了一次某个logger,比如叫log,那么只要是在同一个模块中运行的其他文件都能读取到它。

比如说,你在主文件main.py中自定义了一个logger,可能设置了什么输出文件、输出格式什么的,然后你在main.py中会引用一些别的文件或模块,比如sub.py,那么在这个sub.py中你什么都不用设置,只要用一句logger = logging.getLogger('之前在main.py定义的日志名')即可获得之前的一切自定义设置。

当然,被调用的文件(先称为子模块)中,用logging.getLogger('日志名')时,最好在日志名后加一个.子名称这样的,比如main.sub。这样输出的时候就会显示出来某条日志记录是来自于这个文件里了。当然,.前面的父级logger必须名字一致,是会被识别出来的!

然后,子日志还可以再子日志,甚至一个子模块可以再让所有函数各又一个子子日志,比如main.sub.func1这样的。logging都会根据.识别出来上下级关系的。

这样一说,实际上也就是class类继承的那种机制了。你按照父级名称继承,然后还可以改写自己的新设置等。

了解了这些概念以后,才能来谈代码。实际上也就好理解多了。

设置logger的方法

看来看去,这篇文章说得比较全面也最清楚,以下很多都参考到它的内容:Python 101: An Intro to logging

一般想要自定义一个logger,比如让它输出信息时按照什么格式显示,输出到哪个文件,要不要输出到屏幕一类,有三种方法可以达到设置:

  1. 直接在python代码里设置
  2. 用外部的config.ini文件配置
  3. 用python的dict字典配置

三种达到的目的都是一样的,字典用的人很少也不方便,配置文件比较好用只是.ini的语法不是很方便读,且不容易做到变量的动态设置,所以一般直接在python代码里写就好。

常用设置语句

以下是程序主入口文件的通用写法,注意,一定要在主入口定义好logger,这样其他所有的子模块才能够继承到。

#  main.py
import logging
import otherMod2  # 等下会调用到的子模块

def main():
  """
  这个文件是程序的主入口
  """

  define_logger()

  log = logging.getLogger('exampleApp')

  # 输出信息测试
  logger.info("Program started")
  result = otherMod2.add(7, 8)   # 这个是来自别的模块的方法
  logger.info("Done!")

def define_logger():
  logger = logging.getLogger("exampleApp")
  logger.setLevel(logging.INFO)

  # 设置输出格式
  formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
 
  # 设置日志文件处理器
  fh = logging.FileHandler("new_snake.log")
  fh.setFormatter(formatter)  # 为这个处理器添加格式

  # 设置屏幕stdout输出处理器
  sh = logging.StreamHandler(stream=None)
  sh.setFormatter(formatter)
 
  # 把处理器加到logger上
  logger.addHandler(fh)
  logger.addHandler(sh)
 
if __name__ == "__main__":
  main()

下面是子模块中的调用方法(很简单):

# otherMod2.py
import logging
 
module_logger = logging.getLogger("exampleApp.otherMod2")

def add(x, y):
  # 这里一句`getLogger`就继承到父级的logger了
  logger = logging.getLogger("exampleApp.otherMod2.add")

  # 输出测试
  logger.info("added %s and %s to get %s" % (x, y, x+y))
  return x+y

注意,主文件中,在什么地方定义logger都可以,可以在main()里也可以在任何单独的函数或类里,无所谓。只要在调用子模块之前定义好了就可以了。一旦定义过,日志名就会被记下来,然后子模块就可以轻松继承到。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
Python中使用asyncio 封装文件读写
Sep 11 Python
Python实现求数列和的方法示例
Jan 12 Python
python实现跨excel的工作表sheet之间的复制方法
May 03 Python
python 实现倒排索引的方法
Dec 25 Python
Python3内置模块之json编解码方法小结【推荐】
Dec 09 Python
python 应用之Pycharm 新建模板默认添加编码格式-作者-时间等信息【推荐】
Jun 17 Python
django foreignkey(外键)的实现
Jul 29 Python
Python中低维数组填充高维数组的实现
Dec 02 Python
Python urlopen()和urlretrieve()用法解析
Jan 07 Python
Python MySQL 日期时间格式化作为参数的操作
Mar 02 Python
windows上彻底删除jupyter notebook的实现
Apr 13 Python
解决pyinstaller打包运行程序时出现缺少plotly库问题
Jun 02 Python
python实现寻找最长回文子序列的方法
Jun 02 #Python
python实现对求解最长回文子串的动态规划算法
Jun 02 #Python
Python 网络爬虫--关于简单的模拟登录实例讲解
Jun 01 #Python
用Python一键搭建Http服务器的方法
Jun 01 #Python
python 编写简单网页服务器的实例
Jun 01 #Python
Django中间件实现拦截器的方法
Jun 01 #Python
Python使用add_subplot与subplot画子图操作示例
Jun 01 #Python
You might like
配置Apache2.2+PHP5+CakePHP1.2+MySQL5运行环境
2009/04/25 PHP
PHP实现使用优酷土豆视频地址获取swf播放器分享地址
2014/06/05 PHP
PHP字符串word末字符实现大小写互换的方法
2014/11/10 PHP
php+jQuery.uploadify实现文件上传教程
2014/12/26 PHP
浅析php中array_map和array_walk的使用对比
2016/11/20 PHP
PHP+Ajax实现的博客文章添加类别功能示例
2018/03/29 PHP
Yii 访问 Gii(脚手架)时出现 403 错误
2018/06/06 PHP
PHP实现简易用户登录系统
2020/07/10 PHP
javascript入门·对象属性方法大总结
2007/10/01 Javascript
javascript Array.remove() 数组删除
2009/08/06 Javascript
关于jquery的多个选择器的使用示例
2013/10/18 Javascript
JavaScript判断一个字符串是否包含指定子字符串的方法
2015/03/18 Javascript
JavaScript实现点击自动选择TextArea文本的方法
2015/07/02 Javascript
js实现简单秒表走动的时钟特效
2020/03/25 Javascript
Jquery-1.9.1源码分析系列(十一)之DOM操作
2015/11/25 Javascript
JavaScript关于提高网站性能的几点建议(一)
2016/07/24 Javascript
easyui-datagrid特殊字符不能显示的处理方法
2017/04/12 Javascript
angular-ngSanitize模块-$sanitize服务详解
2017/06/13 Javascript
vue 组件中添加样式不生效的解决方法
2018/07/06 Javascript
微信小程序 导入图标实现过程详解
2019/10/11 Javascript
使用Vue实现简单计算器
2020/02/25 Javascript
学习python的几条建议分享
2013/02/10 Python
go和python调用其它程序并得到程序输出
2014/02/10 Python
使用Python的Scrapy框架编写web爬虫的简单示例
2015/04/17 Python
在Python的Django框架中编写编译函数
2015/07/20 Python
浅谈numpy数组的几种排序方式
2017/12/15 Python
python的re正则表达式实例代码
2018/01/24 Python
Python 最大概率法进行汉语切分的方法
2018/12/14 Python
python mqtt 客户端的实现代码实例
2019/09/25 Python
python 循环数据赋值实例
2019/12/02 Python
Django Form and ModelForm的区别与使用
2019/12/06 Python
基于matplotlib xticks用法详解
2020/04/16 Python
全球速卖通西班牙站:AliExpress西班牙
2017/10/30 全球购物
党员党性分析材料
2014/02/17 职场文书
关于教师节的演讲稿
2014/09/04 职场文书
卖车协议书范本4篇
2014/10/01 职场文书