Python內置了一套try...except...finally...
的錯誤處理機制。
當我們認為某些代碼可能會出錯時,就可以用try
來運行這段代碼,如果執行出錯,則後續代碼不會繼續執行,而是直接跳轉至錯誤處理代碼,即except
語句塊,執行完except
後,如果有finally
語句塊,則執行finally
語句塊,至此,執行完畢。
try:
print('try...')
r = 10 / 0
print('result:', r)
except ZeroDivisionError as e:
print('except:', e)
finally:
print('finally...')
print('END')
上面的代碼在計算10 / 0
時會產生一個除法運算錯誤:
try...
except: division by zero
finally...
END
錯誤應該有很多種類,如果發生了不同類型的錯誤,應該由不同的except
語句塊處理。
此外,如果沒有錯誤發生,可以在except
語句塊後面加一個else
,當沒有錯誤發生時,會自動執行else
語句
常見的錯誤類型和繼承關系參考:https://docs.python.org/3/library/exceptions.html#exception-hierarchy
Python內置的logging
模塊可以非常容易地記錄錯誤信息打印出來,然後分析錯誤原因,同時,讓程序繼續執行下去:
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')
同樣是出錯,但程序打印完錯誤信息後會繼續執行
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
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
語句拋出去了。這種處理方式較為常見。捕獲錯誤目的只是記錄一下,便於後續追蹤。但是,由於當前函數不知道應該怎麼處理該錯誤,所以,最恰當的方式是繼續往上拋,讓頂層調用者去處理。
raise
語句如果不帶參數,就會把當前錯誤原樣拋出。
眾所周知,程序能一次寫完並正常運行的概率幾乎不存在。總會有各種各樣的bug,因此,需要一整套調試程序的手段來修復bug。
最簡單粗暴的方法就是用print()
把可能有問題的變量打印出來看看,用print()
最大的壞處是將來還得刪掉它。
凡是用print()
來輔助查看的地方,都可以用斷言(assert)來替代:assert 表達式, '打印的信息'
,如果斷言assert表達式為True,則無效果繼續執行,如果斷言表達式出錯,則打印信息。
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
,這樣程序中如果到處充斥著assert
,和print()
相比也好不到哪去。不過,啟動Python解釋器時可以用-O
參數來關閉assert
:
$ python -O err.py
和assert
比,logging
不會拋出錯誤,而且可以輸出到文件:
import logging
logging.basicConfig(level=logging.INFO)
s = '0'
n = int(s)
logging.info('n = %d' % n)
print(10 / n)
它允許你指定記錄信息的級別,有debug
,info
,warning
,error
等幾個級別,當我們指定level=INFO
時,logging.debug
就不起作用了。同理,指定level=WARNING
後,debug
和info
就不起作用了。這樣一來,你可以放心地輸出不同級別的信息,也不用刪除,最後統一控制輸出哪個級別的信息。
logging
的另一個好處是通過簡單的配置,一條語句可以同時輸出到不同的地方,比如console和文件。
(1)pdb
啟動Python的調試器pdb,讓程序以單步方式運行,可以隨時查看運行狀態。
$ python -m pdb err.py
以參數-m pdb
啟動後,pdb定位到下一步要執行的代碼。
l
來查看代碼n
可以單步執行代碼。p 變量名
來查看變量q
結束調試,退出程序(2)pdb.set_trace()
這個方法也是用pdb,但是不需要單步執行,我們只需要import pdb
,然後,在可能出錯的地方放一個pdb.set_trace()
,就可以設置一個斷點。
運行代碼,程序會自動在pdb.set_trace()
暫停並進入pdb調試環境,可以用命令p
查看變量,或者用命令c
繼續運行。
(3)IDE
使用一個支持調試功能的IDE,可以更好的設置斷點、單步執行。
常規使用推薦Visual Studio Code:https://code.visualstudio.com/,需要安裝Python插件。
大型項目推薦PyCharm:http://www.jetbrains.com/pycharm/。
單元測試是用來對一個模塊、一個函數或者一個類來進行正確性檢驗的測試工作。
比如對函數abs()
,我們可以編寫出以下幾個測試用例:
1
、1.2
、0.99
,期待返回值與輸入相同;-1
、-1.2
、-0.99
,期待返回值與輸入相反;0
,期待返回0
;None
、[]
、{}
,期待拋出TypeError
。把上面的測試用例放到一個測試模塊裡,就是一個完整的單元測試。
(1)編寫單元測試
編寫單元測試時,我們需要編寫一個測試類,從unittest.TestCase
繼承。
以test
開頭的方法就是測試方法,不以test
開頭的方法不被認為是測試方法,測試的時候不會被執行。
import unittest
class TestStudent(unittest.TestCase):
def test_80_to_100(self):
s1 = Student('Bart', 80)
s2 = Student('Lisa', 100)
self.assertEqual(s1.get_grade(), 'A')
self.assertEqual(s2.get_grade(), 'A')
def test_60_to_80(self):
s1 = Student('Bart', 60)
s2 = Student('Lisa', 79)
self.assertEqual(s1.get_grade(), 'B')
self.assertEqual(s2.get_grade(), 'B')
def test_0_to_60(self):
s1 = Student('Bart', 0)
s2 = Student('Lisa', 59)
self.assertEqual(s1.get_grade(), 'C')
self.assertEqual(s2.get_grade(), 'C')
def test_invalid(self):
s1 = Student('Bart', -1)
s2 = Student('Lisa', 101)
with self.assertRaises(ValueError):
s1.get_grade()
with self.assertRaises(ValueError):
s2.get_grade()
if __name__ == '__main__':
unittest.main()
對每一類測試都需要編寫一個test_xxx()
方法。由於unittest.TestCase
提供了很多內置的條件判斷,我們只需要調用這些方法就可以斷言輸出是否是我們所期望的。最常用的斷言就是assertEqual()
:
self.assertEqual(abs(-1), 1) # 斷言函數返回的結果與1相等
(2)運行單元測試
最簡單的運行方式是:
if __name__ == '__main__':
unittest.main()
另一種方法是在命令行通過參數-m unittest
直接運行單元測試:
$ python -m unittest mydict_test
Python內置的“文檔測試”(doctest)模塊可以直接提取注釋中的代碼並執行測試。
當我們編寫注釋時,如果寫上這樣的注釋:
def fact(n):
''' Calculate 1*2*...*n >>> fact(1) 1 >>> fact(10) 3628800 >>> fact(-1) Traceback (most recent call last): ... ValueError '''
if n < 1:
raise ValueError()
if n == 1:
return 1
return n * fact(n - 1)
無疑更明確地告訴函數的調用者該函數的期望輸入和輸出。
使用doctest進行測試:
if __name__=='__main__':
import doctest
doctest.testmod()
運行測試程序:
$ python test.py
什麼輸出也沒有。這說明我們編寫的doctest運行都是正確的。