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脚本监控docker容器
Apr 27 Python
Python实现Youku视频批量下载功能
Mar 14 Python
Python 查看文件的编码格式方法
Dec 21 Python
Python基于列表模拟堆栈和队列功能示例
Jan 05 Python
Python OpenCV实现图片上输出中文
Jan 22 Python
python opencv人脸检测提取及保存方法
Aug 03 Python
Python魔法方法 容器部方法详解
Jan 02 Python
python numpy实现多次循环读取文件 等间隔过滤数据示例
Mar 14 Python
使用Python项目生成所有依赖包的清单方式
Jul 13 Python
基于python实现删除指定文件类型
Jul 21 Python
Python+unittest+requests 接口自动化测试框架搭建教程
Oct 09 Python
10个python爬虫入门基础代码实例 + 1个简单的python爬虫完整实例
Dec 16 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 魔术函数使用说明
2010/05/14 PHP
解析php防止form重复提交的方法
2013/07/01 PHP
PHP 中使用explode()函数切割字符串为数组的示例
2017/05/06 PHP
PHP 爬取网页的主要方法
2018/07/13 PHP
javascript学习笔记(十九) 节点的操作实现代码
2012/06/20 Javascript
浅谈jQuery中 wrap() wrapAll() 与 wrapInner()的差异
2014/11/12 Javascript
谈谈jQuery Ajax用法详解
2015/11/27 Javascript
jQuery判断浏览器并动态调整select宽度的方法
2016/03/02 Javascript
基于vue实现分页/翻页组件paginator示例
2017/03/09 Javascript
Ionic3 UI组件之autocomplete详解
2017/06/08 Javascript
nuxt+axios解决前后端分离SSR的示例代码
2017/10/24 Javascript
jQuery与vue实现拖动验证码功能
2018/01/30 jQuery
JavaScript基于遍历操作实现对象深拷贝功能示例
2019/03/05 Javascript
[01:12:08]LGD vs OG 2019国际邀请赛淘汰赛 胜者组 BO3 第一场 8.24
2019/09/10 DOTA
说一说Python logging
2016/04/15 Python
Python基于回溯法解决01背包问题实例
2017/12/06 Python
详解如何在Apache中运行Python WSGI应用
2019/01/02 Python
python3利用ctypes传入一个字符串类型的列表方法
2019/02/12 Python
flask应用部署到服务器的方法
2019/07/12 Python
Python之Class&Object用法详解
2019/12/25 Python
Python搭建Keras CNN模型破解网站验证码的实现
2020/04/07 Python
基于CSS3实现立方体自转效果
2016/03/01 HTML / CSS
Wiggle中国:英国骑行、跑步、游泳 & 铁三运动装备专卖网店
2016/08/02 全球购物
有影响力的人、名人和艺术家的官方商品:Represent
2019/11/26 全球购物
德国玩具商店:Planet Happy DE
2021/01/16 全球购物
生日邀请函范文
2014/01/13 职场文书
经济类毕业生求职信
2014/06/26 职场文书
群众路线学习笔记范文
2014/11/06 职场文书
淘宝文案策划岗位职责
2015/04/14 职场文书
2015年七七事变78周年纪念活动方案
2015/05/06 职场文书
七年级数学教学反思
2016/02/17 职场文书
写作之关于描写老人的好段摘抄
2019/11/14 职场文书
MySQL学习之基础命令实操总结
2022/03/19 MySQL
【海涛教你打dota】体验一超神发条:咱是抢盾专业户
2022/04/01 DOTA
Spring Boot项目传参校验的最佳实践指南
2022/04/05 Java/Android
SQL解决未能删除约束问题drop constraint
2022/05/30 SQL Server