調試Python程式碼的幾種方法總結

程式能一次寫完並正常啟動並執行機率很小，基本不超過1%。總會有各種各樣的bug需要修正。有的bug很簡單，看看錯誤資訊就知道，有的bug很複雜，我們需要知道出錯時，哪些變數的值是正確的，哪些變數的值是錯誤的，因此，需要一整套偵錯工具的手段來修複bug。

第一種方法簡單直接粗暴有效，就是用print把可能有問題的變數列印出來看看：

# err.pydef foo(s):  n = int(s)  print '>>> n = %d' % n  return 10 / ndef main():  foo('0')main()

執行後在輸出中尋找列印的變數值：

$ python err.py>>> n = 0Traceback (most recent call last): ...ZeroDivisionError: integer division or modulo by zero

用print最大的壞處是將來還得刪掉它，想想程式裡到處都是print，運行結果也會包含很多垃圾資訊。所以，我們又有第二種方法。
斷言

凡是用print來輔助查看的地方，都可以用斷言（assert）來替代：

# err.pydef foo(s):  n = int(s)  assert n != 0, 'n is zero!'  return 10 / ndef main():  foo('0')

assert的意思是，運算式n != 0應該是True，否則，後面的代碼就會出錯。

如果宣告失敗，assert語句本身就會拋出AssertionError：

$ python err.pyTraceback (most recent call last): ...AssertionError: n is zero!

程式中如果到處充斥著assert，和print相比也好不到哪去。不過，啟動Python解譯器時可以用-O參數來關閉assert：

$ python -O err.pyTraceback (most recent call last): ...ZeroDivisionError: integer division or modulo by zero

關閉後，你可以把所有的assert語句當成pass來看。
logging

把print替換為logging是第3種方式，和assert比，logging不會拋出錯誤，而且可以輸出到檔案：

# err.pyimport loggings = '0'n = int(s)logging.info('n = %d' % n)print 10 / n

logging.info()就可以輸出一段文本。運行，發現除了ZeroDivisionError，沒有任何資訊。怎麼回事？

別急，在import logging之後添加一行配置再試試：

import logginglogging.basicConfig(level=logging.INFO)

看到輸出了：

$ python err.pyINFO:root:n = 0Traceback (most recent call last): File "err.py", line 8, in   print 10 / nZeroDivisionError: integer division or modulo by zero

這就是logging的好處，它允許你指定記錄資訊的層級，有debug，info，warning，error等幾個層級，當我們指定level=INFO時，logging.debug就不起作用了。同理，指定level=WARNING後，debug和info就不起作用了。這樣一來，你可以放心地輸出不同層級的資訊，也不用刪除，最後統一控制輸出哪個層級的資訊。

logging的另一個好處是通過簡單的配置，一條語句可以同時輸出到不同的地方，比如console和檔案。
pdb

第4種方式是啟動Python的調試器pdb，讓程式以單步方式運行，可以隨時查看運行狀態。我們先準備好程式：

# err.pys = '0'n = int(s)print 10 / n

然後啟動：

$ python -m pdb err.py> /Users/michael/Github/sicp/err.py(2)()-> s = '0'

以參數-m pdb啟動後，pdb定位到下一步要執行的代碼-> s = '0'。輸入命令l來查看代碼：

(Pdb) l 1   # err.py 2 -> s = '0' 3   n = int(s) 4   print 10 / n[EOF]

輸入命令n可以逐步執行代碼：

(Pdb) n> /Users/michael/Github/sicp/err.py(3)()-> n = int(s)(Pdb) n> /Users/michael/Github/sicp/err.py(4)()-> print 10 / n

任何時候都可以輸入命令p 變數名來查看變數：

(Pdb) p s'0'(Pdb) p n0

輸入命令q結束調試，退出程式：

(Pdb) nZeroDivisionError: 'integer division or modulo by zero'> /Users/michael/Github/sicp/err.py(4)()-> print 10 / n(Pdb) q

這種通過pdb在命令列調試的方法理論上是萬能的，但實在是太麻煩了，如果有一千行代碼，要運行到第999行得敲多少命令啊。還好，我們還有另一種調試方法。
pdb.set_trace()

這個方法也是用pdb，但是不需要逐步執行，我們只需要import pdb，然後，在可能出錯的地方放一個pdb.set_trace()，就可以設定一個斷點：

# err.pyimport pdbs = '0'n = int(s)pdb.set_trace() # 運行到這裡會自動暫停print 10 / n

運行代碼，程式會自動在pdb.set_trace()暫停並進入pdb調試環境，可以用命令p查看變數，或者用命令c繼續運行：

$ python err.py > /Users/michael/Github/sicp/err.py(7)()-> print 10 / n(Pdb) p n0(Pdb) cTraceback (most recent call last): File "err.py", line 7, in   print 10 / nZeroDivisionError: integer division or modulo by zero

這個方式比直接啟動pdb單步調試效率要高很多，但也高不到哪去。
IDE

如果要比較爽地設定斷點、逐步執行，就需要一個支援調試功能的IDE。目前比較好的Python IDE有PyCharm：

http://www.jetbrains.com/pycharm/

另外，Eclipse加上pydev外掛程式也可以調試Python程式。
小結

寫程式最痛苦的事情莫過於調試，程式往往會以你意想不到的流程來運行，你期待執行的語句其實根本沒有執行，這時候，就需要調試了。

雖然用IDE調試起來比較方便，但是最後你會發現，logging才是終極武器。

