Python學習之錯誤除錯和測試

stonezhu發表於2018-06-20
Python除錯

Python學習目錄

  1. 在Mac下使用Python3
  2. Python學習之資料型別
  3. Python學習之函式
  4. Python學習之高階特性
  5. Python學習之函數語言程式設計
  6. Python學習之模組
  7. Python學習之物件導向程式設計
  8. Python學習之物件導向高階程式設計
  9. Python學習之錯誤除錯和測試
  10. Python學習之IO程式設計
  11. Python學習之程式和執行緒
  12. Python學習之正則
  13. Python學習之常用模組
  14. Python學習之網路程式設計

在程式執行過程中，總會遇到各種各樣的錯誤，Python內建了一套異常處理機制，來幫助我們進行錯誤處理。

debug

錯誤處理

在程式執行的過程中，如果發生了錯誤，可以事先約定返回一個錯誤程式碼，這樣，就可以知道是否有錯，以及出錯的原因。在作業系統提供的呼叫中，返回錯誤碼非常常見。比如開啟檔案的函式open()，成功時返回檔案描述符（就是一個整數），出錯時返回-1。

用錯誤碼來表示是否出錯十分不便，因為函式本身應該返回的正常結果和錯誤碼混在一起，造成呼叫者必須用大量的程式碼來判斷是否出錯，所以高階語言通常都內建了一套try...except...finally...的錯誤處理機制，Python也不例外。

try

try:
    print('try...')
    r = 10 / 0
    print('result:', r)
except ZeroDivisionError as e:
    print('except:', e)
finally:
    print('finally...')
print('END')
複製程式碼

當我們認為某些程式碼可能會出錯時，就可以用try來執行這段程式碼，如果執行出錯，則後續程式碼不會繼續執行，而是直接跳轉至錯誤處理程式碼，即except語句塊，執行完except後，如果有finally語句塊，則執行finally語句塊，至此，執行完畢。

Python的錯誤其實也是class，所有的錯誤型別都繼承自BaseException，所以在使用except時需要注意的是，它不但捕獲該型別的錯誤，還把其子類也“一網打盡”。

呼叫棧

如果錯誤沒有被捕獲，它就會一直往上拋，最後被Python直譯器捕獲，列印一個錯誤資訊，然後程式退出。來看看err.py：

# err.py:
def foo(s):
    return 10 / int(s)

def bar(s):
    return foo(s) * 2

def main():
    bar('0')

main()
複製程式碼

執行，結果如下：

$ python3 err.py
Traceback (most recent call last):
  File "err.py", line 11, in <module>
    main()
  File "err.py", line 9, in main
    bar('0')
  File "err.py", line 6, in bar
    return foo(s) * 2
  File "err.py", line 3, in foo
    return 10 / int(s)
ZeroDivisionError: division by zero
複製程式碼

我們從上往下可以看到整個錯誤的呼叫函式鏈。

記錄錯誤

如果不捕獲錯誤，自然可以讓Python直譯器來列印出錯誤堆疊，但程式也被結束了。既然我們能捕獲錯誤，就可以把錯誤堆疊列印出來，然後分析錯誤原因，同時，讓程式繼續執行下去。

Python內建的logging模組可以非常容易地記錄錯誤資訊：

# err_logging.py

import logging

def foo(s):
    return 10 / int(s)

def bar(s):
    return foo(s) * 2

def main():
    try:
        bar('0')
    except Exception as e:
        logging.exception(e)

main()
print('END')
複製程式碼

執行上述模組：

$ python3 err_logging.py
ERROR:root:division by zero
Traceback (most recent call last):
  File "err_logging.py", line 13, in main
    bar('0')
  File "err_logging.py", line 9, in bar
    return foo(s) * 2
  File "err_logging.py", line 6, in foo
    return 10 / int(s)
ZeroDivisionError: division by zero
END
複製程式碼

丟擲錯誤

因為錯誤是class，捕獲一個錯誤就是捕獲到該class的一個例項。因此，錯誤並不是憑空產生的，而是有意建立並丟擲的。Python的內建函式會丟擲很多型別的錯誤，我們自己編寫的函式也可以丟擲錯誤。

如果要丟擲錯誤，首先根據需要，可以定義一個錯誤的class，選擇好繼承關係，然後，用raise語句丟擲一個錯誤的例項：

# err_raise.py
class FooError(ValueError):
    pass

def foo(s):
    n = int(s)
    if n==0:
        raise FooError('invalid value: %s' % s)
    return 10 / n

foo('0')
複製程式碼

執行，可以最後跟蹤到我們自己定義的錯誤：

$ python3 err_raise.py 
Traceback (most recent call last):
  File "err_throw.py", line 11, in <module>
    foo('0')
  File "err_throw.py", line 8, in foo
    raise FooError('invalid value: %s' % s)
__main__.FooError: invalid value: 0
複製程式碼

最後，我們來看另一種錯誤處理的方式：

# err_reraise.py

def foo(s):
    n = int(s)
    if n==0:
        raise ValueError('invalid value: %s' % s)
    return 10 / n

def bar():
    try:
        foo('0')
    except ValueError as e:
        print('ValueError!')
        raise

bar()
複製程式碼

在bar()函式中，我們明明已經捕獲了錯誤，但是，列印一個ValueError!後，又把錯誤通過raise語句丟擲去了，這不有病麼？

其實這種錯誤處理方式不但沒病，而且相當常見。捕獲錯誤目的只是記錄一下，便於後續追蹤。但是，由於當前函式不知道應該怎麼處理該錯誤，所以，最恰當的方式是繼續往上拋，讓頂層呼叫者去處理。好比一個員工處理不了一個問題時，就把問題拋給他的老闆，如果他的老闆也處理不了，就一直往上拋，最終會拋給CEO去處理。

raise語句如果不帶引數，就會把當前錯誤原樣丟擲。此外，在except中raise一個Error，還可以把一種型別的錯誤轉化成另一種型別：

try:
    10 / 0
except ZeroDivisionError:
    raise ValueError('input error!')
複製程式碼

除錯

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

print()

用print()把可能有問題的變數列印出來看看。

斷言

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。

logging

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

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

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

s = '0'
n = int(s)
logging.info('n = %d' % n)
print(10 / n)
複製程式碼

pdb

Python的偵錯程式pdb，讓程式以單步方式執行，可以隨時檢視執行狀態。我們先準備好程式：

# err.py
s = '0'
n = int(s)
print(10 / n)
複製程式碼

然後啟動：

$ python -m pdb err.py
> /Users/michael/Github/learn-python3/samples/debug/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)
複製程式碼

輸入命令n可以單步執行程式碼。

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繼續執行。

IDE

目前比較好的Python IDE有：

isual Studio Code：code.visualstudio.com/，需要安裝Python外掛。

PyCharm：www.jetbrains.com/pycharm/

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

單元測試

單元測試是用來對一個模組、一個函式或者一個類來進行正確性檢驗的測試工作。

文件測試

如果你經常閱讀Python的官方文件，可以看到很多文件都有示例程式碼。

可以把這些示例程式碼在Python的互動式環境下輸入並執行，結果與文件中的示例程式碼顯示的一致。

這些程式碼與其他說明可以寫在註釋中，然後，由一些工具來自動生成文件。

下一篇：Python學習之IO程式設計

相關文章