使用pdb模組除錯Python Python 偵錯程式之pdb
在Python中,我們需要debug時,有三種方式:
- 加log語句。最簡單的方式是新增print()語句來輸出我們想要獲知的狀態或者變數,好處是簡單容易操作,壞處是debug完了之後,還需要將print語句註釋掉;進階的方法是使用logging模組寫log語句,這樣做的好處是:能把log語句分級,並且能夠根據引數決定輸出什麼樣層級的log,用這種方法可以讓我們不用註釋掉log語句。
- 使用IDE(Intergrated Development Environment, 整合開發環境),比如Pycharm,這類的IDE可以像visual studio一樣幫助我們debug。
- 使用pdb
使用 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 除錯
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
[[email protected] ~]# 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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
[[email protected] ~]# 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 過程中列印變數
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
[[email protected] ~]# 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 繼續執行程式
1 2 3 4 5 6 7 8 |
[[email protected] ~]# 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 過程中顯示程式碼
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
[[email protected] ~]# 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. 使用函式的例子
1 2 3 4 5 6 7 8 9 10 11 |
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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
[[email protected] ~]# 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. 在除錯的時候動態改變值
1 2 3 4 5 6 7 8 9 |
[[email protected] ~]# 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