什么是pdb和ipdb
不知道大家在用Python写代码出现报错时是怎样调试的,从报错提示定位回去一步一步check每一行?如果没有IDE或者命令行写代码时又该怎样快速调试?这时如果使用pdb进行调试将会异常方便。
Pdb就是Python debugger,是python自带的调试器。通过 pdb 我们可以交互式的查看运行过程中变量的值、设置断点、逐行执行代码、查看代码的调用栈等等。并且如果环境没有 GUI 的话,那么 pdb 能够助你更快速的调试代码。
之前我使用ubuntu系统界面或者windows,使用断点调试,而实际工作过程中都是采用linux远程ssh模式,无法可视化界面,那么调试技巧就是pdb,这也是必须要学习pdb的原因,pdb很简单,一起学习把!
ipdb其实就是基于pdb的ipython版本,方法要比pdb更加方便!
示例:
def test(p):p = p + 1return pdef fastdebug():print('start')temp = 'ready' print('ok')res = test(temp) print('end')fastdebug()
这段代码很简单,当我们执行fastdebug()时,会执行fastdebug函数并在该函数中调用另一个函数test(),test函数接收一个参数p并计算p+1的值传出。很明显,在高亮的一句代码中传进去的参数temp是str,所以当我们执行上面一段代码时一定会报错
现在让我们假装不知道问题出在哪,使用pdb来调试这段代码。
使用pdb
由于pdb是python标准库因此我们可以直接import 使用
import pdb
接着在我们需要调试的代码段前设一个断点
pdb.set_trace()
应用到我们的代码👇
可以看到运行代码后,pdb的调试器控制台将从放置set_trace()的位置开始等待我们的命令,并且箭头标记指向pdb接下来要运行的行。那么接下来介绍一些pdb中常用命令
使用n来执行下一行
可以看到此时调试器指向
print(‘start’)
在弹出的文本框中输入n即可执行该行,并且箭头将指向下一行即将执行的代码
使用ENTER重复上一个命令
现在还没有到报错的位置,我们使用n或者直接回车重复执行上一个命令
使用p打印变量值
在Pdb中我们可以使用p + 变量名来查看变量值,比如我们查看变量temp的值
使用l查看上下行代码
在Pdb中我们可以使用l查看当前行上下几行代码
使用s进入子函数
现在,我们来到出错的这一行,之所以报错就是传进去变量出了问题,因此我们可以在pdb交互行中使用s来进入子函数test()
使用r执行函数直到结束
在pdb中可以使用r来执行当前运行函数到结束
使用c停止调试并继续运行
现在我们修改相关代码完成调试,可以使用c命令继续执行命令
当然也可以输入q直接退出调试界面
总结
# 导入
import pdb
# 设置断点
pdb.set_trace()
# -------------------
# 断点命令
p + 变量名 # 打印变量 或者直接变量名
n # 执行下一行
s # 进入函数
r # 执行函数到结束
c # 停止调试并继续运行
q # 退出调试
# enter 重复上一次命令
ipdb方法
帮助
帮助文档就是这样一个东西:当你写的时候觉得这TM也要写?当你看别人的东西的时候觉得这TM都没写?
使用h即可调出IPDB的帮助。可以使用help command的方法查询特定命令的具体用法。
下一条语句
使用n(next)执行下一条语句。注意一个函数调用也是一个语句。如何能够实现类似“进入函数内部”的功能呢?
进入函数内部
使用s(step into)进入函数调用的内部。
打断点
使用b line_number(break)的方式给指定的行号位置加上断点。使用b file_name:line_number的方法给指定的文件(还没执行到的代码可能在外部文件中)中指定行号位置打上断点。
另外,打断点还支持指定条件下进入,可以查询帮助文档。
一直执行直到遇到下一个断点
使用c(continue)执行代码直到遇到某个断点或程序执行完毕。
一直执行直到返回
使用r(return)执行代码直到当前所在的这个函数返回。
跳过某段代码
使用j line_number(jump)可以跳过某段代码,直接执行指定行号所在的代码。
更多上下文
在IPDB调试环境中,默认只显示当前执行的代码行,以及其上下各一行的代码。如果想要看到更多的上下文代码,可以使用l first, second命令。
其中first指示向上最多显示的行号,second指示向下最多显示的行号(可以省略)。当second小于first时,second指的是从first开始的向下的行数(相对值vs绝对值)。
根据SO上的这个问题,你还可以修改IPDB的源码,一劳永逸地改变上下文的行数。
我在哪里
调试兴起,可能你会忘了自己目前所在的行号。例如在打印了若干变量值后,屏幕完全被这些值占据。使用w或者where可以打印出目前所在的行号位置以及上下文信息。
这是啥
我们可以使用whatis variable_name的方法,查看变量的类别(感觉有点鸡肋,用type也可以办到)。
列出当前函数的全部参数
当你身处一个函数内部的时候,可以使用a(argument)打印出传入函数的所有参数的值。
打印
使用p(print)和pp(pretty print)可以打印表达式的值。
清除断点
使用cl或者clear file:line_number清除断点。如果没有参数,则清除所有断点。
再来一次
使用restart重新启动调试器,断点等信息都会保留。restart实际是run的别名,使用run args的方式传入参数。
退出
使用q退出调试,并清除所有信息。