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)退出