如何使用Pdb调试Python

Python的调试方法有三种，一种是执行时调试，一种是交互调试，一种是程序里埋点调试，其中，最常用的是执行时调试，也就是pdb调试，这个调试在命令行中键入python -m pdb some.py即可进入Python pdb调试，（这行命令在Linux系统下进入的是Python2的调试，如果要进入Python3的调试需要在python的后面加一个3，即python3 -m pdb some.py），键入命令并敲回车后，如果出现类似下面图片中的界面，证明成功进入了pdb调试：

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

https://blog.csdn.net/zone_/article/details/91158718

如何添加断点？
说到 debug，肯定是要添加断点的，这里有两种方式添加断点：

在想要断点代码后添加一行
pdb.set_trace()
若是使用这种方式，直接运行 Python 文件即可进入断点调试。

用命令行来添加断点
b line_number（代码行数）
若是使用这种方式，需要 python -m pdb xxx.py 来启动断点调试。
————————————————

下面给出一些执行时pdb调试的常用命令：

l:显示当前的代码
n:向下执行一行代码，在函数里也可以
c:相当于continue，从当前位置继续执行代码直到结束
b:break的意思，添加断点，格式为:b+数字（中间有空格）按下c键，程序执行到这行的时候会停止
clear+断点序号（中间有空格）删除这个断点
s:在调用函数这一行加断点，程序执行到这行后，按s，进入函数中
p+形参名字查看形参的值
a:查看所有形参的值
q:quit 退出调试
r:相当于return，快速执行到函数最后一行，需要在函数里用

使用PDB的方式有两种:

1. 单步执行代码,通过命令 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<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语句在当前环境下执行；

实例：

#test1.py

s = '0'
n = int(s)
print(10/n)

打开命令行运行test1.py

python -m pdb test1.py

pdm定位到下一步要执行的代码-> s = '0',输入命令l，就是上面的第15个命令l(list)来查看下代码：

输入命令n可以单步执行代码

还可以输入 p 变量名来查看变量

但是这个变量所在的代码必须是运行过之后才能查看，否则，会出现找不到变量的情况，如下

刚开始运行test.py，到第一行代码s = '0',这行代码实际还未执行。此时查看变量s会提示找不到变量

输入命令q结束调试，退出程序

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

修改下上面的实例如下，import pdb, 添加了pdb.set_trace()到可能出错的代码前面

# test1.py

import pdb

s = '0'
n = int(s)
pdb.set_trace() #运行到这里会自动暂停
print(10/n)

运行之后，程序到断电的下一行代码就暂停了

举个简单的栗子
为了验证一下 pdb 的用法，我写了个简单的 Python 代码，如下：

__author__ = 'zone'
__gzh__ = '公号：zone7'
import pdb

class MyScrapy:
urls = []

def start_url(self, urls):
pdb.set_trace()
for url in urls:
print(url)
self.urls.append(url)

def parse(self):
pdb.set_trace()
for url in self.urls:
result = self.request_something(url)

def request_something(self, url):
print('requesting...')
data = '''<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
</body>
</html>'''
return data

scrapy= MyScrapy()
scrapy.start_url(["http://www.zone7.cn", "http://www.zone7.cn", "http://www.zone7.cn", "http://www.zone7.cn", ])
scrapy.parse()
运行实例：（这里为了方便大家阅读，我添加了中文注释，实际运行时不会有注释的）

D:\work\venv\Scripts\python.exe D:/work_test/test/pdb_test/pdb_test.py
> d:\work_test\test\pdb_test\pdb_test.py(11)start_url()
-> for url in urls:

(Pdb) n 注释：n（next）执行下一步
> d:\work_test\test\pdb_test\pdb_test.py(12)start_url()
-> print(url)

(Pdb) l 注释： l（list）列出当前代码
7 urls = []
8
9 def start_url(self, urls):
10 pdb.set_trace()
11 for url in urls:
12 -> print(url)
13 self.urls.append(url)
14
15 def parse(self):
16 pdb.set_trace()
17 for url in self.urls:

(Pdb) c 注释：c（continue），继续执行，知道遇到下一个断点
http://www.zone7.cn
http://www.zone7.cn
http://www.zone7.cn
http://www.zone7.cn
> d:\work_test\test\pdb_test\pdb_test.py(17)parse()
-> for url in self.urls:

(Pdb) n 注释：n（next）执行下一步
> d:\work_test\test\pdb_test\pdb_test.py(18)parse()
-> result = self.request_something(url)

(Pdb) l 注释： l（list）列出当前代码
13 self.urls.append(url)
14
15 def parse(self):
16 pdb.set_trace()
17 for url in self.urls:
18 -> result = self.request_something(url)
19
20 def request_something(self, url):
21 print('requesting...')
22 data = '''<!DOCTYPE html>
23 <html lang="en">

(Pdb) s 注释： s（step）这里是进入 request_something() 函数的意思
--Call--
> d:\work_test\test\pdb_test\pdb_test.py(20)request_something()
-> def request_something(self, url):

(Pdb) n 注释：n（next）执行下一步
> d:\work_test\test\pdb_test\pdb_test.py(21)request_something()
-> print('requesting...')

(Pdb) l 注释： l（list）列出当前代码
16 pdb.set_trace()
17 for url in self.urls:
18 result = self.request_something(url)
19
20 def request_something(self, url):
21 -> print('requesting...')
22 data = '''<!DOCTYPE html>
23 <html lang="en">
24 <head>
25 <meta charset="UTF-8">
26 <title>Title</title>

(Pdb) p url 注释：p（print）打印出 url 变量的数据
'http://www.zone7.cn'

(Pdb) n 注释：n（next）执行下一步
requesting...
> d:\work_test\test\pdb_test\pdb_test.py(31)request_something()
-> </html>'''

(Pdb) p data 注释：p（print）打印出指定变量的数据，这里由于赋值还没完成，所以报错
*** NameError: name 'data' is not defined

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

清单 1. 测试代码示例

 import pdb 
 a = "aaa"
 pdb.set_trace() 
 b = "bbb"
 c = "ccc"
 final = a + b + c 
 print final

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

清单 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 退出到调用的地方。

对函数进行 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) n 注释：n（next）执行下一步
> d:\work_test\test\pdb_test\pdb_test.py(32)request_something()
-> return data

(Pdb) p data 注释：p（print）打印出指定变量的数据
'<!DOCTYPE html>\n<html lang="en">\n<head>\n <meta charset="UTF-8">\n <title>Title</title>\n</head>\n<body>\n\n</body>\n</html>'

(Pdb) q 注释：q（quit）退出

posted @ 2019-12-17 22:58 konglingbin 阅读(14453) 评论(0) 编辑收藏举报

刷新页面返回顶部

konglingbin