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守护进程用法实例分析
Jun 04 Python
Python更新数据库脚本两种方法及对比介绍
Jul 27 Python
python使用pyqt写带界面工具的示例代码
Oct 23 Python
python清理子进程机制剖析
Nov 23 Python
redis之django-redis的简单缓存使用
Jun 07 Python
Python实现绘制双柱状图并显示数值功能示例
Jun 23 Python
浅谈pycharm下找不到sqlalchemy的问题
Dec 03 Python
Python OOP类中的几种函数或方法总结
Feb 22 Python
简单了解django索引的相关知识
Jul 17 Python
Python一键安装全部依赖包的方法
Aug 12 Python
基于python 将列表作为参数传入函数时的测试与理解
Jun 05 Python
Python操作MySQL数据库的示例代码
Jul 13 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
php数组函数序列之array_slice() - 在数组中根据条件取出一段值,并返回
2011/11/07 PHP
基于php无限分类的深入理解
2013/06/02 PHP
PHP设置一边执行一边输出结果的代码
2013/09/30 PHP
php判断是否为ajax请求的方法
2016/11/29 PHP
PHP实现生成模糊图片的方法示例
2017/12/21 PHP
PHP filesize函数用法浅析
2019/02/15 PHP
PHP快速导出百万级数据到CSV或者EXCEL文件
2020/11/27 PHP
jQuery开发者都需要知道的5个小技巧
2010/01/08 Javascript
jQuery each()小议
2010/03/18 Javascript
JS date对象的减法处理实现代码
2010/12/28 Javascript
JavaScript 里的类数组对象
2015/04/08 Javascript
jquery插件jquery.dragscale.js实现拖拽改变元素大小的方法(附demo源码下载)
2016/02/25 Javascript
jquery trigger函数执行两次的解决方法
2016/02/29 Javascript
浅谈Node.js:fs文件系统模块
2016/12/08 Javascript
Angular.JS去掉访问路径URL中的#号详解
2017/03/30 Javascript
浅谈angular4.0中路由传递参数、获取参数最nice的写法
2018/03/12 Javascript
VUE实现Studio管理后台之鼠标拖放改变窗口大小
2020/03/04 Javascript
vue+element-ui JYAdmin后台管理系统模板解析
2020/07/28 Javascript
[15:58]DOTA2国际邀请赛采访专栏:Tongfu.Sansheng&KingJ,DK.rOtk
2013/08/08 DOTA
Python 中Pickle库的使用详解
2018/02/24 Python
浅谈django orm 优化
2018/08/18 Python
一看就懂得Python的math模块
2018/10/21 Python
详解anaconda离线安装pytorchGPU版
2020/09/08 Python
css3新单位vw、vh的使用教程
2018/03/23 HTML / CSS
世界著名的顶级牛排:Omaha Steak(奥马哈牛排)
2016/09/20 全球购物
CHARLES & KEITH台湾官网:新加坡时尚品牌
2019/07/30 全球购物
WebSphere 应用服务器都支持哪些认证
2013/12/26 面试题
一些.net面试题
2014/10/06 面试题
什么是URL
2015/12/13 面试题
大学三年的自我评价
2013/12/25 职场文书
大学生求职信范文应怎么写
2014/01/01 职场文书
超市5.1促销活动
2014/01/15 职场文书
运动会通讯稿500字
2014/02/20 职场文书
2015年度团总支工作总结
2015/04/23 职场文书
学习党章心得体会2016
2016/01/15 职场文书
关于Python使用turtle库画任意图的问题
2022/04/01 Python