Python常用的程式除錯方法

pythontab發表於2017-11-15

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

1. 斷點列印發

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

err.py

def foo(s):
  n = int(s)
  print '>>> n = %d' % n
  return 10 / n
def main():
  foo('0')
main()

執行後在輸出中查詢列印的變數值:

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

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

2. 斷言

凡是用print來輔助檢視的地方,都可以用斷言(assert)來替代:

err.py

def foo(s):
  n = int(s)
  assert n != 0, 'n is zero!'
  return 10 / n
def main():
  foo('0')

assert的意思是,表示式n != 0應該是True,否則,後面的程式碼就會出錯。

如果斷言失敗,assert語句本身就會丟擲AssertionError:

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

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

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

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

3. logging日誌

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

err.py

import logging
s = '0'
n = int(s)
logging.info('n = %d' % n)
print 10 / n

logging.info()就可以輸出一段文字。執行,發現除了ZeroDivisionError,沒有任何資訊。怎麼回事?

別急,在import logging之後新增一行配置再試試:

import logging
logging.basicConfig(level=logging.INFO)

看到輸出了:

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

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

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

4. pdb除錯

第4種方式是啟動Python的偵錯程式pdb,讓程式以單步方式執行,可以隨時檢視執行狀態。我們先準備好程式:

err.py

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

執行:

$ python -m pdb err.py
> /Users/PythonTab/Github/sicp/err.py(2)<module>()
-> 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/PythonTab/Github/sicp/err.py(3)<module>()

-> n = int(s)

(Pdb) n

> /Users/PythonTab/Github/sicp/err.py(4)<module>()

-> print 10 / n

任何時候都可以輸入命令p 變數名來檢視變數:

(Pdb) p s

'0'

(Pdb) p n

0

輸入命令q結束除錯,退出程式:

(Pdb) n

ZeroDivisionError: 'integer division or modulo by zero'

> /Users/PythonTab/Github/sicp/err.py(4)<module>()

-> print 10 / n

(Pdb) q

這種透過pdb在命令列除錯的方法理論上是萬能的,但實在是太麻煩了,如果有一千行程式碼,要執行到第999行得敲多少命令啊。還好,我們還有另一種除錯方法。

pdb.set_trace()

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

err.py

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

執行程式碼,程式會自動在pdb.set_trace()暫停並進入pdb除錯環境,可以用命令p檢視變數,或者用命令c繼續執行:

$ python err.py 
> /Users/PythonTab/Github/sicp/err.py(7)<module>()
-> print 10 / n
(Pdb) p n
0
(Pdb) c
Traceback (most recent call last):
 File "err.py", line 7, in <module>
  print 10 / n
ZeroDivisionError: integer division or modulo by zero

這個方式比直接啟動pdb單步除錯效率要高很多,但也高不到哪去。

5. IDE除錯

如果要比較爽地設定斷點、單步執行,就需要一個支援除錯功能的IDE。目前比較好的Python IDE有PyCharm,

另外,Eclipse加上pydev外掛也可以除錯Python程式。


小結

寫程式花費的時間往往要小於除錯的時間,這個是基本規律。

雖然用IDE除錯起來比較方便,但是最後你會發現,logging才是終極武器。斷點除錯也是高手的終極利器!


相關文章