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通过装饰器检查函数参数数据类型的方法
Mar 13 Python
Python基于正则表达式实现文件内容替换的方法
Aug 30 Python
利用Hyperic调用Python实现进程守护
Jan 02 Python
Python使用matplotlib绘制多个图形单独显示的方法示例
Mar 14 Python
python中pip的安装与使用教程
Aug 10 Python
Python第三方Window模块文件的几种安装方法
Nov 22 Python
Pyinstaller打包.py生成.exe的方法和报错总结
Apr 02 Python
12个Python程序员面试必备问题与答案(小结)
Jun 24 Python
python生成随机红包的实例写法
Sep 02 Python
如何关掉pycharm中的python console(图解)
Oct 31 Python
哪种Python框架适合你?简单介绍几种主流Python框架
Aug 04 Python
一个入门级python爬虫教程详解
Jan 27 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作为网站开发语言的原因分享
2012/01/03 PHP
PHP获取数组中某元素的位置及array_keys函数应用
2013/01/29 PHP
ThinkPHP使用Ueditor的方法详解
2016/05/20 PHP
PHP PDOStatement::fetchObject讲解
2019/02/01 PHP
ThinkPHP 框架实现的读取excel导入数据库操作示例
2020/04/14 PHP
javascript来定义类的规范小结
2010/11/19 Javascript
用js来定义浏览器中一个左右浮动元素相对于页面主体宽度的位置的函数
2012/01/21 Javascript
鼠标经过tr时,改变tr当前背景颜色
2014/01/13 Javascript
Javascript变量的作用域和作用域链详解
2015/04/02 Javascript
jQuery遍历节点方法汇总(推荐)
2017/05/13 jQuery
JavaScript实现时间表动态效果
2017/07/15 Javascript
JavaScript实现HTML5游戏断线自动重连的方法
2017/09/18 Javascript
js通过Date对象实现倒计时动画效果
2017/10/27 Javascript
vue-cli2.x项目优化之引入本地静态库文件的方法
2018/06/19 Javascript
Angular6封装http请求的步骤详解
2018/08/13 Javascript
基于vue实现圆形菜单栏组件
2019/07/05 Javascript
web.py中调用文件夹内模板的方法
2014/08/26 Python
Python 冒泡,选择,插入排序使用实例
2015/02/05 Python
Python中的多重装饰器
2015/04/11 Python
Python用threading实现多线程详解
2017/02/03 Python
Python 备份程序代码实现
2017/03/06 Python
Python的多维空数组赋值方法
2018/04/13 Python
浅谈python下tiff图像的读取和保存方法
2018/12/04 Python
Python中文编码知识点
2019/02/18 Python
详解python列表生成式和列表生成式器区别
2019/03/27 Python
Pycharm配置lua编译环境过程图解
2020/11/28 Python
蒙蒂塞罗商店:Monticello Shop
2018/11/25 全球购物
GWT的应用有哪两种部署模式
2012/12/21 面试题
探矿工程师自荐信
2014/01/24 职场文书
先进单位申报材料
2014/12/25 职场文书
2015年乡镇扶贫工作总结
2015/04/08 职场文书
2015年科协工作总结
2015/05/19 职场文书
创业计划书之孕婴生活馆
2019/11/11 职场文书
vscode中使用npm安装babel的方法
2021/08/02 Javascript
Lakehouse数据湖并发控制陷阱分析
2022/03/31 Oracle
分享五个Node.js开发的优秀实践 
2022/04/07 NodeJs