Python使用pdb进行调试

转自：JefferyZh和IBM

在命令行使用参数进入调试

运行

运行python -m pdb test.py

(Pdb) 会自动停在第一行，等待调试，这时你可以看看帮助
(Pdb) h

几个关键命令

• 断点设置

  (Pdb)b 10 #断点设置在本py的第10行
  或(Pdb)b ots.py:20 #断点设置到 ots.py第20行
  删除断点（Pdb）b #查看断点编号 (Pdb)cl 2 #删除第2个断点

• 运行

  (Pdb)n #单步运行
  (Pdb)s #细点运行 也就是会下到，方法
  (Pdb)c #跳到下个断点

• 查看

  (Pdb)p param #查看当前 变量值
  (Pdb)l #查看运行到某处代码
  (Pdb)a #查看全部栈内变量

• 打印变量

　　　    (Pdb)p param # 如果变量是个复杂的对象，可以先打印查看变量的属性，然后查看变量的某个属性值 (Pdb)p dir(param) (Pdb)p param.xxx　　

命令集合

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

在.py中载入pdb模块

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

表 1. pdb 常用命令

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

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

清单 1. 测试代码示例

1 import pdb
2 a = "aaa"
3 pdb.set_trace()
4 b = "bbb"
5 c = "ccc"
6 final = a + b + c
7 print final

 

开始调试：直接运行脚本，会停留在 pdb.set_trace() 处，选择 n+enter 可以执行当前的 statement。在第一次按下了 n+enter 之后可以直接按 enter 表示重复执行上一条 debug 命令。

清单 2. 利用 pdb 调试

 1 [root@rcc-pok-idg-2255 ~]#  python epdb1.py
 2 > /root/epdb1.py(4)?()
 3 -> b = "bbb"
 4 (Pdb) n
 5 > /root/epdb1.py(5)?()
 6 -> c = "ccc"
 7 (Pdb)
 8 > /root/epdb1.py(6)?()
 9 -> final = a + b + c
10 (Pdb) list
11 1     import pdb
12 2     a = "aaa"
13 3     pdb.set_trace()
14 4     b = "bbb"
15 5     c = "ccc"
16 6  -> final = a + b + c
17 7     print final
18 [EOF]
19 (Pdb)
20 [EOF]
21 (Pdb) n
22 > /root/epdb1.py(7)?()
23 -> print final
24 (Pdb)

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

清单 3. 退出 debug

 1 [root@rcc-pok-idg-2255 ~]#  python epdb1.py 
 2 > /root/epdb1.py(4)?() 
 3 -> b = "bbb"
 4 (Pdb) n 
 5 > /root/epdb1.py(5)?() 
 6 -> c = "ccc"
 7 (Pdb) q 
 8 Traceback (most recent call last): 
 9 File "epdb1.py", line 5, in ? 
10 c = "ccc"
11 File "epdb1.py", line 5, in ? 
12 c = "ccc"
13 File "/usr/lib64/python2.4/bdb.py", line 48, in trace_dispatch 
14 return self.dispatch_line(frame) 
15 File "/usr/lib64/python2.4/bdb.py", line 67, in dispatch_line 
16 if self.quitting: raise BdbQuit 
17 bdb.BdbQuit

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

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

 1 [root@rcc-pok-idg-2255 ~]#  python epdb1.py 
 2 > /root/epdb1.py(4)?() 
 3 -> b = "bbb"
 4 (Pdb) n 
 5 > /root/epdb1.py(5)?() 
 6 -> c = "ccc"
 7 (Pdb) p b 
 8 'bbb'
 9 (Pdb) 
10 'bbb'
11 (Pdb) n 
12 > /root/epdb1.py(6)?() 
13 -> final = a + b + c 
14 (Pdb) p c 
15 'ccc'
16 (Pdb) p final 
17 *** NameError: <exceptions.NameError instance at 0x1551b710 > 
18 (Pdb) n 
19 > /root/epdb1.py(7)?() 
20 -> print final 
21 (Pdb) p final 
22 'aaabbbccc'
23 (Pdb)

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

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

1 [root@rcc-pok-idg-2255 ~]#  python epdb1.py 
2 > /root/epdb1.py(4)?() 
3 -> b = "bbb"
4 (Pdb) n 
5 > /root/epdb1.py(5)?() 
6 -> c = "ccc"
7 (Pdb) c 
8 aaabbbccc

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

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

 1 [root@rcc-pok-idg-2255 ~]#  python epdb1.py 
 2 > /root/epdb1.py(4)?() 
 3 -> b = "bbb"
 4 (Pdb) list 
 5 1     import pdb 
 6 2     a = "aaa"
 7 3     pdb.set_trace() 
 8 4  -> b = "bbb"
 9 5     c = "ccc"
10 6     final = a + b + c 
11 7     pdb.set_trace() 
12 8     print final 
13 [EOF] 
14 (Pdb) c 
15 > /root/epdb1.py(8)?() 
16 -> print final 
17 (Pdb) list 
18 3     pdb.set_trace() 
19 4     b = "bbb"
20 5     c = "ccc"
21 6     final = a + b + c 
22 7     pdb.set_trace() 
23 8  -> print final 
24 [EOF] 
25 (Pdb)

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

清单 7. 使用函数的例子

 1 import pdb 
 2 def combine(s1,s2):      # define subroutine combine, which... 
 3 s3 = s1 + s2 + s1    # sandwiches s2 between copies of s1, ... 
 4 s3 = '"' + s3 +'"'   # encloses it in double quotes,... 
 5 return s3            # and returns it. 
 6 a = "aaa"
 7 pdb.set_trace() 
 8 b = "bbb"
 9 c = "ccc"
10 final = combine(a,b) 
11 print final

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

清单 8. 对函数进行 debug

 1 [root@rcc-pok-idg-2255 ~]# python epdb2.py 
 2 > /root/epdb2.py(10)?() 
 3 -> b = "bbb"
 4 (Pdb) n 
 5 > /root/epdb2.py(11)?() 
 6 -> c = "ccc"
 7 (Pdb) n 
 8 > /root/epdb2.py(12)?() 
 9 -> final = combine(a,b) 
10 (Pdb) s 
11 --Call-- 
12 > /root/epdb2.py(3)combine() 
13 -> def combine(s1,s2):      # define subroutine combine, which... 
14 (Pdb) n 
15 > /root/epdb2.py(4)combine() 
16 -> s3 = s1 + s2 + s1    # sandwiches s2 between copies of s1, ... 
17 (Pdb) list 
18 1     import pdb 
19 2 
20 3     def combine(s1,s2):      # define subroutine combine, which... 
21 4  ->     s3 = s1 + s2 + s1    # sandwiches s2 between copies of s1, ... 
22 5         s3 = '"' + s3 +'"'   # encloses it in double quotes,... 
23 6         return s3            # and returns it. 
24 7 
25 8     a = "aaa"
26 9     pdb.set_trace() 
27 10     b = "bbb"
28 11     c = "ccc"
29 (Pdb) n 
30 > /root/epdb2.py(5)combine() 
31 -> s3 = '"' + s3 +'"'   # encloses it in double quotes,... 
32 (Pdb) n 
33 > /root/epdb2.py(6)combine() 
34 -> return s3            # and returns it. 
35 (Pdb) n 
36 --Return-- 
37 > /root/epdb2.py(6)combine()->'"aaabbbaaa"'
38 -> return s3            # and returns it. 
39 (Pdb) n 
40 > /root/epdb2.py(13)?() 
41 -> print final 
42 (Pdb)

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

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

1 [root@rcc-pok-idg-2255 ~]# python epdb2.py 
2 > /root/epdb2.py(10)?() 
3 -> b = "bbb"
4 (Pdb) var = "1234"
5 (Pdb) b = "avfe"
6 *** The specified object '= "avfe"' is not a function 
7 or was not found along sys.path. 
8 (Pdb) !b="afdfd"
9 (Pdb)