记录 | python pdb调试

pdb 是 python 自带的一个库，可以提供交互式的调试功能，提供了断点设置、单步调试、源码查看、堆栈查看等丰富的功能。

pdb 类似于 C++ 中的 gdb 调试工具。通常有两种方式来使用 pdb，第一种方式是在命令行中加入 pdb 模块来启动 python 程序，如下：

python -m pdb test.py

这种方式会从程序第一行开始就进入交互环境，适用于较小的程序调试。在更大型的工程里，我们更习惯用插入断点的方式进行调试，如下：

import pdb
pdb.set_trace()

将 set_trace() 函数放到代码中的任何地方，执行程序时都会在此处产生一个断点，尤其是在使用 pytorch 这种极度 python 化的框架时，使用极为方便。pdb 主要的调试命令如表所示

---

下面是一些主要的指令介绍

使用 pdb 调试的方法有两种
● 单步执行代码,通过命令 python -m pdb xxx.py 启动脚本，进入单步执行模式
pdb命令行：
1）进入命令行Debug模式，python -m pdb xxx.py
2）h：（help）帮助
3）w：（where）打印当前执行堆栈
4）d：（down）执行跳转到在当前堆栈的深一层（个人没觉得有什么用处）
5）u：（up）执行跳转到当前堆栈的上一层
6）b：（break）添加断点
b 列出当前所有断点，和断点执行到统计次数
b line_no：当前脚本的 line_no 行添加断点
b filename:line_no：脚本 filename 的 line_no 行添加断点
b function：在函数 function 的第一条可执行语句处添加断点
7）tbreak：（temporary break）临时断点
在第一次执行到这个断点之后，就自动删除这个断点，用法和b一样
8）cl：（clear）清除断点
cl 清除所有断点
cl bpnumber1 bpnumber2… 清除断点号为 bpnumber1, bpnumber2… 的断点
cl lineno 清除当前脚本 lineno 行的断点
cl filename: line_no 清除脚本 filename 的 line_no 行的断点
9）disable：停用断点，参数为 bpnumber，和 cl 的区别是，断点依然存在，只是不启用
10）enable：激活断点，参数为 bpnumber
11）s：（step）执行下一条命令
如果本句是函数调用，则s会执行到函数的第一句
12）n：（next）执行下一条语句
如果本句是函数调用，则执行函数，接着执行当前执行语句的下一条。
13）r：（return）执行当前运行函数到结束
14）c：（continue）继续执行，直到遇到下一条断点
15）l：（list）列出源码
l 列出当前执行语句周围 11 条代码
l first 列出 first 行周围 11 条代码
l first second 列出 first–second 范围的代码，如果 second
16）a：（args）列出当前执行函数的函数
17）p expression：（print）输出 expression 的值
18）pp expression：好看一点的 p expression
19）run：重新启动 debug，相当于 restart
20）q：（quit）退出 debug
21）j lineno：（jump）设置下条执行的语句函数
只能在堆栈的最底层跳转，向后重新执行，向前可直接执行到行号
22）unt：（until）执行到下一行（跳出循环），或者当前堆栈结束
23）condition bpnumber conditon，给断点设置条件，当参数 condition 返回 True 的时候 bpnumber 断点有效，否则 bpnumber 断点无效

注意：
1：直接输入Enter，会执行上一条命令；
2：输入 PDB 不认识的命令，PDB 会把他当做 Python 语句在当前环境下执行；

● 第二种方法是 import pdb 之后，直接在代码里需要调试的地方放一个 pdb.set_trace()，就可以设置一个断点， 程序会在 pdb.set_trace() 暂停并进入pdb调试环境，可以用 pdb 变量名 查看变量，或者 c 继续运行