python 调试冷知识(小结)


Posted in Python onNovember 11, 2019

对于 python 代码的调试我们通常都是使用 IDE 自带的调试功能。但是 IDE 提供的调试功能存在局限性,例如在测试服务器上调试代码,但是又不可能在测试服务器上安装 IDE 进行调试。这时我们就可以利用下面所讲解的三个工具进行调试。

零、准备调试代码

在讲解三个调试工具前,我们先编写待调试的代码。代码很简单,就是计算两个数的商。我们在编写代码的时候故意留下了除数为 0 的 bug。

def division(start, end):
  for i in range(start, end, -1):
    num1 = i
    num2 = i - 1
    result = num1 / num2
    print(result)


if __name__ == '__main__':
  division(10, 0)

一、PySnooper

PySnooper 是 Python 的第三方工具库,它可以精确的显示代码的执行时间、执行顺序和代码中的局部变量值的变化等。 PySnooper 使用方法很简单,只需要将它作为装饰器来使用即可。下面我们来看一下具体使用步骤:

安装 PySnooper

1. 在控制台输入如下命令:

pip install pysnooper

等待两秒钟后 PySnooper 安装完成。

2. 加入 PySnooper

首先需要引入 PySnooper

import pysnooper

接着在需要测试的函数上加上 pysnooper 装饰器

@pysnooper.snoop()
def division(start, end):
  for i in range(start, end, -1):
    num1 = i
    num2 = i - 1
    result = num1 / num2
    print(result)


if __name__ == '__main__':
  division(10, 0)

调试代码
在控制台输入命令:

python text.py

运行代码后,控制台输出如下内容

python 调试冷知识(小结)

python 调试冷知识(小结)

上图只截取了 PySnooper 输出日志的开头内容和最后结尾的内容。从截图中我们可以看到 PySnooper 输出了每行代码的运行顺序、运行时间和代码运行中变量值的变化,以及报错信息。在实际项目中 PySnooper 输出的日志内容会很多,在控制台查看会很不方便,这时我们可以将日志输出到本地文件中,我们只需在 PySnooper 装饰器中加入日志保存路径即可:

@pysnooper.snoop('/app/project_log.log')

一些公司对日志输出会有要求,比如每行日志要以某某字符串开头,这时只需在装饰器中加入需要字符穿即可:

@pysnooper.snoop(prefix='MyCompanyName: ')

上述所讲的都是 PySnooper 装饰器的常用参数,例如监控自定义表达式、监控底层函数、多线程等 PySnooper 同样支持,具体参数可以在官方项目文档中查看。
前面我们所讲的都是在函数上利用装饰器来监控整个函数,但是在实际项目中往往一个函数内容会很多,如果监控整个函数会导致输出的日志过多,这时我们就可以利用 PySnooper 的局部监控功能来监控函数中需要监控的代码片段。现在我们来修改一下代码,只监控输出的值:

import pysnooper

def division(start, end):
  for i in range(start, end, -1):
    with pysnooper.snoop():
      num1 = i
      num2 = i - 1
      result = num1 / num2
    print(result)


if __name__ == '__main__':
  division(10, 0)

上述代码运行后我们就会发现输出的内容少了很多。

二、Better-exceptions

Better-exceptions 同样是 Python 的第三方工具库,它出现的原因是其实很简单就是“美化异常信息”(是不是感觉作者很任性)。 Better-exceptions 主要使用了 Python 的 sys 模块的 excepthook 方法,这个方法在当系统抛出异常时,解释器就会调用它,同时传递三个参数:异常类、异常实例和 traceback 对象,这就说明我们可以重写这个方法来捕获系统异常。但是,因为我们可以重写 excepthook 方法来捕获系统异常,因此 Better-exceptions 对与 Web 框架来说是不起任何作用的,因为 Web 框架都已经处理了系统抛出的异常,不会再以 hook 的方式触发 Better-exceptions 。下面我们就来看一下该怎么用。

安装 Better-exceptions

首先在控制台输入如下命令:

pip install better-exceptions

等待两秒钟后 Better-exceptions 安装完成。

接着我们在控制台输入如下代码,来设置环境变量:

setx BETTER_EXCEPTIONS 1

调试代码
在控制台输入命令:

python text.py

代码运行后,控制台输出如下图:

python 调试冷知识(小结)

从上面的图我们可以看到,Better-exceptions 对异常代码进行了着色,并对产生异常的变量值进行了输出。通过这两项内容我们就可以很快捷的看到具体报错位置和报错原因。

这里有需要注意的地方就是,在 Windows 系统下输出的日志会存在乱码问题,这是因为 Better-exceptions 的编码格式造成的。要解决这个问题我们只需要修改 better-exceptions 目录下的 encoding.py 文件,讲文件中的 ENCODING = locale.getpreferredencoding()修改为 ENCODING = 'utf-8'即可。

三、PDB

PDB 是 Python 内置的模块,我们可以利用 PDB 设置断点和跟踪调试。 PDB 的使用不需要再安装第三方插件,只需要在命令行输入如下命令:

python -m pdb Test.py

命令执行后将会进入 PDB 调试模式。如果需要在代码中加入断点,只需要在需要加入断点的位置加入 pdb.set_trace()即可。当进入到 PDB 模式后,输入 c 就可以从当前断点直接跳转到下一个断点,如果后续没有断点,则会将剩余代码执行完。当然,如果需要单步执行代码,在控制台输入 s 指令,但是有时主函数会调用大量的其他函数,这时在命令行输入 n 就可以只在主函数中执行单步调试。除了上述指令外,PDB 还有其他指令,如下表:

指令 说明
l 显示所有代码
n 执行下一条代码
c 执行当前断点后面的代码,知道代码执行完毕
b x 在代码的第X行设置断点
clear 清除全部断点
s 单步执行
s function_name 进入 function_name 函数内部执行
q 退出PDB
a 打印所有参数值
p 打印指定变量值
r 忽略剩余断点,将剩余代码执行完毕

四、总结

我们讲解了 PySnooper 、Better-exceptions 和 PDB 的用法,这三种方法一般都使用在服务器上,这里我推荐使用Better-exceptions,因为它对代码的侵入性很小,几乎不需要改变代码。

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

Python 相关文章推荐
基于python的多进程共享变量正确打开方式
Apr 28 Python
详解python3中tkinter知识点
Jun 21 Python
Python实现string字符串连接的方法总结【8种方式】
Jul 06 Python
python3实现表白神器
Apr 09 Python
详解Python 多线程 Timer定时器/延迟执行、Event事件
Jun 27 Python
使用虚拟环境打包python为exe 文件的方法
Aug 29 Python
基于python修改srt字幕的时间轴
Feb 03 Python
pycharm设置python文件模板信息过程图解
Mar 10 Python
Python通过Pillow实现图片对比
Apr 29 Python
Python实现查找数据库最接近的数据
Jun 08 Python
Python 日期与时间转换的方法
Aug 01 Python
python中使用 unittest.TestCase单元测试的用例详解
Aug 30 Python
通过 Django Pagination 实现简单分页功能
Nov 11 #Python
python机器学习实现决策树
Nov 11 #Python
Python SQLAlchemy入门教程(基本用法)
Nov 11 #Python
django中间键重定向实例方法
Nov 10 #Python
Java文件与类动手动脑实例详解
Nov 10 #Python
python语言线程标准库threading.local解读总结
Nov 10 #Python
Python 脚本拉取 Docker 镜像问题
Nov 10 #Python
You might like
浅谈Windows下 PHP4.0与oracle 8的连接设置
2006/10/09 PHP
php 将字符串按大写字母分隔成字符串数组
2010/04/30 PHP
ThinkPHP行为扩展Behavior应用实例详解
2014/07/22 PHP
php中隐形字符65279(utf-8的BOM头)问题
2014/08/16 PHP
说明你的Javascript技术很烂的五个原因
2011/04/26 Javascript
JS中处理与当前时间间隔的函数代码
2012/05/23 Javascript
用Jquery重写windows.alert方法实现思路
2013/04/03 Javascript
jQuery密码强度验证控件使用详解
2017/01/05 Javascript
详解nodeJS中读写文件方法的区别
2017/03/06 NodeJs
NodeJS设计模式总结【单例模式,适配器模式,装饰模式,观察者模式】
2017/09/06 NodeJs
JS实现的简单四则运算计算器功能示例
2017/09/27 Javascript
BootStrap TreeView使用实例详解
2017/11/01 Javascript
JavaScript数组排序reverse()和sort()方法详解
2017/12/24 Javascript
使用react render props实现倒计时的示例代码
2018/12/06 Javascript
监听element-ui table滚动事件的方法
2019/03/26 Javascript
详解javascript对数组和json数组的操作
2019/04/15 Javascript
Javascript读取上传文件内容/类型/字节数
2019/04/30 Javascript
Openlayers实现距离面积测量
2020/09/28 Javascript
Python性能优化技巧
2015/03/09 Python
浅谈django model的get和filter方法的区别(必看篇)
2017/05/23 Python
python实现日常记账本小程序
2018/03/10 Python
python基于opencv检测程序运行效率
2019/12/28 Python
解决pyecharts运行后产生的html文件用浏览器打开空白
2020/03/11 Python
浅谈keras2 predict和fit_generator的坑
2020/06/17 Python
Python2与Python3关于字符串编码处理的差别总结
2020/09/07 Python
python 基于opencv实现图像增强
2020/12/23 Python
NBA欧洲商店(法国):NBA Europe Store FR
2016/10/19 全球购物
如何从一个文件档案的尾端新增记录
2016/12/02 面试题
个人简历自我评价
2014/02/02 职场文书
新教师工作感言
2014/02/16 职场文书
我的职业生涯规划:打造自己的运动帝国
2014/09/18 职场文书
家长会开场白和结束语
2015/05/29 职场文书
保留意见审计报告
2015/06/05 职场文书
解决Golang time.Parse和time.Format的时区问题
2021/04/29 Golang
python用海龟绘图写贪吃蛇游戏
2021/06/18 Python
Python sklearn分类决策树方法详解
2022/09/23 Python