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中实现定制类的特殊方法总结
Sep 28 Python
Python开发常用的一些开源Package分享
Feb 14 Python
Python网络爬虫出现乱码问题的解决方法
Jan 05 Python
Python使用re模块实现信息筛选的方法
Apr 29 Python
python实现支付宝当面付(扫码支付)功能
May 30 Python
Django rest framework工具包简单用法示例
Jul 20 Python
Django unittest 设置跳过某些case的方法
Dec 26 Python
Django对数据库进行添加与更新的例子
Jul 12 Python
利用python实现汉字转拼音的2种方法
Aug 12 Python
Django框架HttpResponse对象用法实例分析
Nov 01 Python
Pycharm连接gitlab实现过程图解
Sep 01 Python
python基于selenium爬取斗鱼弹幕
Feb 20 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
php 面向对象的一个例子
2011/04/12 PHP
PHP整数取余返回负数的相关解决方法
2014/05/15 PHP
ThinkPHP框架任意代码执行漏洞的利用及其修复方法
2014/07/04 PHP
PHP中常用的输出函数总结
2014/09/22 PHP
smarty模板判断数组为空的方法
2015/06/10 PHP
thinkphp3.2中实现phpexcel导出带生成图片示例
2017/02/14 PHP
php 生成加密公钥加密私钥实例详解
2017/06/16 PHP
使用Node.js为其他程序编写扩展的基本方法
2015/06/23 Javascript
JSON与XML优缺点对比分析
2015/07/17 Javascript
JavaScript自学笔记(必看篇)
2016/06/23 Javascript
JS实现京东首页之页面顶部、Logo和搜索框功能
2017/01/12 Javascript
AngularJS 购物车全选/取消全选功能的实现方法
2017/08/14 Javascript
ECMAScript6变量的解构赋值实例详解
2017/09/19 Javascript
Js中async/await的执行顺序详解
2017/09/22 Javascript
vue+layui实现select动态加载后台数据的例子
2019/09/20 Javascript
安装多版本Vue-CLI的实现方法
2020/03/24 Javascript
零基础写python爬虫之爬虫编写全记录
2014/11/06 Python
Python探索之Metaclass初步了解
2017/10/28 Python
Python 中Pickle库的使用详解
2018/02/24 Python
Window 64位下python3.6.2环境搭建图文教程
2018/09/19 Python
简单瞅瞅Python vars()内置函数的实现
2019/09/27 Python
python getpass模块用法及实例详解
2019/10/07 Python
python中JWT用户认证的实现
2020/05/18 Python
MONNIER Frères英国官网:源自巴黎女士奢侈品配饰电商平台
2018/12/06 全球购物
Paper Cape官网:美国婴儿和儿童服装品牌
2019/11/02 全球购物
什么是JNDI的上下文?如何初始化JNDI上下文
2012/03/10 面试题
六一儿童节演讲稿
2014/05/23 职场文书
小学英语教师先进事迹
2014/05/28 职场文书
个人授权委托书样本
2014/09/13 职场文书
销售员未完成销售业绩的检讨书
2014/10/12 职场文书
红十字会救护培训简讯
2015/07/20 职场文书
2016年社区“6.26”禁毒日宣传活动总结
2016/04/05 职场文书
MongoDB使用场景总结
2022/02/24 MongoDB
python 判断文件或文件夹是否存在
2022/03/18 Python
cypress测试本地web应用
2022/06/01 Javascript
element tree树形组件回显数据问题解决
2022/08/14 Javascript