使用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這個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 調試

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24

[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

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

[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 過程當中打印變量

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

[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 繼續執行程序

1 2 3 4 5 6 7 8

[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 過程當中顯示代碼

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

[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. 使用函數的例子

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

[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. 在調試的時候動態改變值

1 2 3 4 5 6 7 8 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