使用pdb模块调试Python

在Python中，我们需要debug时，有三种方式：

加log语句。最简单的方式是添加print()语句来输出我们想要获知的状态或者变量，好处是简单容易操作，坏处是debug完了之后，还需要将print语句注释掉；进阶的方法是使用logging模块写log语句，这样做的好处是：能把log语句分级，并且能够根据参数决定输出什么样层级的log，用这种方法可以让我们不用注释掉log语句。
使用IDE(Intergrated Development Environment, 集成开发环境)，比如Pycharm，这类的IDE可以像visual studio一样帮助我们debug。
使用pdb这个python自带的模块来帮助我们debug。

使用 pdb 进行调试

pdb 是 python 自带的一个包，为 python 程序提供了一种交互的源代码调试功能，主要特性包括设置断点、单步调试、进入函数调试、查看当前代码、查看栈片段、动态改变变量的值等。pdb 提供了一些常用的调试命令，详情见表 1。

表 1. pdb 常用命令

命令	解释
break 或 b 设置断点	设置断点
continue 或 c	继续执行程序
list 或 l	查看当前行的代码段
step 或 s	进入函数
return 或 r	执行代码直到从当前函数返回
exit 或 q	中止并退出
next 或 n	执行下一行
p <arg_name>	打印变量的值
help	帮助

下面结合具体的实例讲述如何使用 pdb 进行调试。

import pdb

a = 1

pdb.set_trace()

b = 2

a = a + b
print(a)

这段是最简单的pdb模块调试示例代码。pdb.set_trace()这里就是一个断点，程序运行之后，会停留在pdb.set_trace()这里。此时输入n再按回车键，可以执行下一行语句。后面直接按回车键，可继续执行一行。其他参数作用也是如此，以此类推。

清单 2. 利用 pdb 调试

[root@rcc-pok-idg-2255 ~]# python epdb1.py

> /root/epdb1.py(4)?()

-> b = "bbb"

(Pdb) n

> /root/epdb1.py(5)?()

-> c = "ccc"

(Pdb)

> /root/epdb1.py(6)?()

-> final = a + b + c

(Pdb) list

1 import pdb

2 a = "aaa"

3 pdb.set_trace()

4 b = "bbb"

5 c = "ccc"

6 -> final = a + b + c

7 print final

[EOF]

(Pdb)

[EOF]

(Pdb) n

> /root/epdb1.py(7)?()

-> print final

(Pdb)

退出 debug：使用 quit 或者 q 可以退出当前的 debug，但是 quit 会以一种非常粗鲁的方式退出程序，其结果是直接 crash。

清单 3. 退出 debug

[root@rcc-pok-idg-2255 ~]# python epdb1.py

> /root/epdb1.py(4)?()

-> b = "bbb"

(Pdb) n

> /root/epdb1.py(5)?()

-> c = "ccc"

(Pdb) q

Traceback (most recent call last):

File "epdb1.py", line 5, in ?

c = "ccc"

File "epdb1.py", line 5, in ?

c = "ccc"

File "/usr/lib64/python2.4/bdb.py", line 48, in trace_dispatch

return self.dispatch_line(frame)

File "/usr/lib64/python2.4/bdb.py", line 67, in dispatch_line

if self.quitting: raise BdbQuit

bdb.BdbQuit

打印变量的值：如果需要在调试过程中打印变量的值，可以直接使用 p 加上变量名，但是需要注意的是打印仅仅在当前的 statement 已经被执行了之后才能看到具体的值，否则会报 NameError: < exceptions.NameError … ....> 错误。

清单 4. debug 过程中打印变量

[root@rcc-pok-idg-2255 ~]# python epdb1.py

> /root/epdb1.py(4)?()

-> b = "bbb"

(Pdb) n

> /root/epdb1.py(5)?()

-> c = "ccc"

(Pdb) p b

'bbb'

(Pdb)

'bbb'

(Pdb) n

> /root/epdb1.py(6)?()

-> final = a + b + c

(Pdb) p c

'ccc'

(Pdb) p final

*** NameError: <exceptions.NameError instance at 0x1551b710 >

(Pdb) n

> /root/epdb1.py(7)?()

-> print final

(Pdb) p final

'aaabbbccc'

(Pdb)

使用 c 可以停止当前的 debug 使程序继续执行。如果在下面的程序中继续有 set_statement() 的申明，则又会重新进入到 debug 的状态，读者可以在代码 print final 之前再加上 set_trace() 验证。

清单 5. 停止 debug 继续执行程序

[root@rcc-pok-idg-2255 ~]# python epdb1.py

> /root/epdb1.py(4)?()

-> b = "bbb"

(Pdb) n

> /root/epdb1.py(5)?()

-> c = "ccc"

(Pdb) c

aaabbbccc

显示代码：在 debug 的时候不一定能记住当前的代码块，如要要查看具体的代码块，则可以通过使用 list 或者 l 命令显示。list 会用箭头 -> 指向当前 debug 的语句。

清单 6. debug 过程中显示代码

[root@rcc-pok-idg-2255 ~]# python epdb1.py

> /root/epdb1.py(4)?()

-> b = "bbb"

(Pdb) list

1 import pdb

2 a = "aaa"

3 pdb.set_trace()

4 -> b = "bbb"

5 c = "ccc"

6 final = a + b + c

7 pdb.set_trace()

8 print final

[EOF]

(Pdb) c

> /root/epdb1.py(8)?()

-> print final

(Pdb) list

3 pdb.set_trace()

4 b = "bbb"

5 c = "ccc"

6 final = a + b + c

7 pdb.set_trace()

8 -> print final

[EOF]

(Pdb)

在使用函数的情况下进行 debug

清单 7. 使用函数的例子

import pdb

def combine(s1,s2): # define subroutine combine, which...

s3 = s1 + s2 + s1 # sandwiches s2 between copies of s1, ...

s3 = '"' + s3 +'"' # encloses it in double quotes,...

return s3 # and returns it.

a = "aaa"

pdb.set_trace()

b = "bbb"

c = "ccc"

final = combine(a,b)

print final

如果直接使用 n 进行 debug 则到 final=combine(a,b) 这句的时候会将其当做普通的赋值语句处理，进入到 print final。如果想要对函数进行 debug 如何处理呢 ? 可以直接使用 s 进入函数块。函数里面的单步调试与上面的介绍类似。如果不想在函数里单步调试可以在断点处直接按 r 退出到调用的地方。

清单 8. 对函数进行 debug

[root@rcc-pok-idg-2255 ~]# python epdb2.py

> /root/epdb2.py(10)?()

-> b = "bbb"

(Pdb) n

> /root/epdb2.py(11)?()

-> c = "ccc"

(Pdb) n

> /root/epdb2.py(12)?()

-> final = combine(a,b)

(Pdb) s

--Call--

> /root/epdb2.py(3)combine()

-> def combine(s1,s2): # define subroutine combine, which...

(Pdb) n

> /root/epdb2.py(4)combine()

-> s3 = s1 + s2 + s1 # sandwiches s2 between copies of s1, ...

(Pdb) list

1 import pdb

2

3 def combine(s1,s2): # define subroutine combine, which...

4 -> s3 = s1 + s2 + s1 # sandwiches s2 between copies of s1, ...

5 s3 = '"' + s3 +'"' # encloses it in double quotes,...

6 return s3 # and returns it.

7

8 a = "aaa"

9 pdb.set_trace()

10 b = "bbb"

11 c = "ccc"

(Pdb) n

> /root/epdb2.py(5)combine()

-> s3 = '"' + s3 +'"' # encloses it in double quotes,...

(Pdb) n

> /root/epdb2.py(6)combine()

-> return s3 # and returns it.

(Pdb) n

--Return--

> /root/epdb2.py(6)combine()->'"aaabbbaaa"'

-> return s3 # and returns it.

(Pdb) n

> /root/epdb2.py(13)?()

-> print final

(Pdb)

在调试的时候动态改变值。在调试的时候可以动态改变变量的值，具体如下实例。需要注意的是下面有个错误，原因是 b 已经被赋值了，如果想重新改变 b 的赋值，则应该使用！ B。

清单 9. 在调试的时候动态改变值

[root@rcc-pok-idg-2255 ~]# python epdb2.py

> /root/epdb2.py(10)?()

-> b = "bbb"

(Pdb) var = "1234"

(Pdb) b = "avfe"

*** The specified object '= "avfe"' is not a function

or was not found along sys.path.

(Pdb) !b="afdfd"

(Pdb)

pdb 调试有个明显的缺陷就是对于多线程，远程调试等支持得不够好，同时没有较为直观的界面显示，不太适合大型的 python 项目。而在较大的 python 项目中，这些调试需求比较常见，因此需要使用更为高级的调试工具。

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<first，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语句在当前环境下执行；

参考链接：

1. Python 调试器之pdb https://www.cnblogs.com/xiaohai2003ly/p/8529472.html

2. Python 代码调试技巧 https://www.ibm.com/developerworks/cn/linux/l-cn-pythondebugger/index.html