4. 錯誤、調試、測試.md · python3教程-廖雪峰

# 錯誤程序運行過程中，有時會遇到各種錯誤 - 如果是程序本身的問題，稱為bug - 如果是用戶輸入造成的，則可以通過檢查用戶輸入來處理 - 如果無法在程序運行過程中預測，比如說磁盤滿了等，稱為異常，也需要進行處理。 ## 錯誤處理在程序運行的過程中，如果發生了錯誤，可以事先約定返回一個錯誤代碼， Python內置了一套try...except...finally... 的錯誤處理機制 ### try 當我們認為某些代碼可能會出錯時，就可以用 try 來運行這段代碼，如果執行出錯，則后續代碼不會繼續執行，而是直接跳轉至錯誤處理代碼，即 except 語句塊，執行完 except 后，如果有 finally 語句塊，則執行 finally 語句塊，至此，執行完畢也可以用多不except來捕獲不同類型的錯誤如果沒有錯誤發生，可以在except后面加一個else，當沒有錯誤發生的時候，會自動執行。 ```python try: print('try...') r = 10 / int('2') print('result:', r) except ValueError as e: print('ValueError:', e) except ZeroDivisionError as e: print('ZeroDivisionError:', e) else: print('no error!') finally: print('finally...') print('END') ``` Python 的錯誤其實也是 class，所有的錯誤類型都繼承自 BaseException > 在使用 except 時需要注意的是，它不但捕獲該類型的錯誤，還把其子類也 “一網打盡” 使用 try...except 捕獲錯誤還有一個的好處，就是可以跨越多層調用，比如函數 main() 調用 bar(), bar() 調用 foo()，結果 foo() 出錯了，這時，只要 main() 捕獲到了，就可以處理 ```python def foo(s): return 10 / int(s) def bar(s): return foo(s) * 2 def main(): try: bar('0') except Exception as e: print('Error:', e) finally: print('finally...') ``` 不需要在每個可能出錯的地方去捕獲錯誤 ### 調用棧 ```python 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 解釋器來打印出錯誤堆棧，但程序也被結束了。既然我們能捕獲錯誤，就可以把錯誤堆棧打印出來，然后分析錯誤原因，同時，讓程序繼續執行下去我們可以使用內置模塊 `logging` 來記錄錯誤信息 ```python # 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') ``` ### 拋出錯誤 ```python 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() 函數中，我們已經捕獲了錯誤，但是 foo又把錯誤拋出去了。原因是捕獲錯誤目的只是記錄一下，便于后續追蹤。但是，由于當前函數不知道應該怎么處理該錯誤，所以，最恰當的方式是繼續往上拋，讓頂層調用者去處理 raise 語句如果不帶參數，就會把當前錯誤原樣拋出。此外，在 except 中 raise 一個 Error，還可以把一種類型的錯誤轉化成另一種類型： ```python try: 10 / 0 except ZeroDivisionError: raise ValueError('input error!') ``` ## 調試 ### 斷言使用print()來打印的最大壞處就是將來還得刪除它。凡是使用print()作為輔助的地方，都可以使用斷言。 ```python def foo(s): n = int(s) assert n != 0, 'n is zero!' return 10 / n def main(): foo('0') AssertionError: n is zero! ``` assert 的意思是，表達式 n != 0 應該是 True，否則，根據程序運行的邏輯，后面的代碼肯定會出錯。如果斷言失敗，assert 語句本身就會拋出 AssertionError：啟動 Python 解釋器時可以用 -O 參數來關閉 assert： ### logging 和 assert 比，logging 不會拋出錯誤，而且可以輸出到文件： ```python import logging logging.basicConfig(level=logging.INFO) s = '0' n = int(s) logging.info('n = %d' % n) print(10 / n) ``` logging 允許你指定記錄信息的級別，有 debug，info，warning，error 等幾個級別，當我們指定 level=INFO 時，logging.debug 就不起作用了。同理，指定 level=WARNING 后，debug 和 info 就不起作用了。 ### pdb pdb，讓程序以單步方式運行，可以隨時查看運行狀態。 ```python python -m pdb err.py ``` pdb 定位到下一步要執行的代碼 -> s = '0'。輸入命令 l 來查看代碼：輸入n可以單步執行代碼使用 `p 變量名` 來查看變量輸入命令 q 結束調試同樣我們可以設置斷點在可能出錯的地方放一個 pdb.set_trace()，就可以設置一個斷點： ```python import pdb s = '0' n = int(s) pdb.set_trace() # 運行到這里會自動暫停 print(10 / n) ``` 可以使用命令 p 查看變量，使用c繼續運行 ## 單元測試單元測試是用來對一個模塊、一個函數或者一個類來進行正確性檢驗的測試工作比如對函數 abs()，我們可以編寫出以下幾個測試用例： - 輸入正數，比如 1、1.2、0.99，期待返回值與輸入相同； - 輸入負數，比如 -1、-1.2、-0.99，期待返回值與輸入相反； - 輸入 0，期待返回 0； - 輸入非數值類型，比如 None、[]、{}，期待拋出 TypeError 單元測試通過有什么意義呢？如果我們對 abs() 函數代碼做了修改，只需要再跑一遍單元測試，如果通過，說明我們的修改不會對 abs() 函數原有的行為造成影響，如果測試不通過，說明我們的修改與原有行為不一致，要么修改代碼，要么修改測試。這種以測試為驅動的開發模式最大的好處就是確保一個程序模塊的行為符合我們設計的測試用例。在將來修改的時候，可以極大程度地保證該模塊行為仍然是正確的。現在我們可以編寫一個 `Dict`類，這個類與 `dict` 一致。但是可以通過屬性來訪問。 ```python >>> d = Dict(a=1, b=2) >>> d['a'] 1 >>> d.a 1 ``` 代碼如下： ```python class Dict(dict): def __init__(self, **kw): super().__init__(**kw) def __getattr__(self, key): try: return self[key] except KeyError: raise AttributeError(r"'Dict' object has no attribute '%s'" % key) def __setattr__(self, key, value): self[key] = value ``` 如果要編寫單元測試，我們可以使用 `unittest`模塊。 ```python import unittest from mydict import Dict class TestDict(unittest.TestCase): def test_init(self): d = Dict(a=1, b='test') self.assertEqual(d.a, 1) self.assertEqual(d.b, 'test') self.assertTrue(isinstance(d, dict)) def test_key(self): d = Dict() d['key'] = 'value' self.assertEqual(d.key, 'value') def test_attr(self): d = Dict() d.key = 'value' self.assertTrue('key' in d) self.assertEqual(d['key'], 'value') def test_keyerror(self): d = Dict() with self.assertRaises(KeyError): value = d['empty'] def test_attrerror(self): d = Dict() with self.assertRaises(AttributeError): value = d.empty ``` 編寫單元測試時，我們需要編寫一個測試類，從 unittest.TestCase 繼承。以 test 開頭的方法就是測試方法，不以 test 開頭的方法不被認為是測試方法，測試的時候不會被執行。 unittest.TestCase 提供了很多內置的條件判斷，我們只需要調用這些方法就可以斷言輸出是否是我們所期望的。最常用的斷言就是 assertEqual() ```python self.assertEqual(abs(-1), 1) # 斷言函數返回的結果與1相等 ``` 另一種重要的斷言就是期待拋出指定類型的 Error，比如通過 d['empty'] 訪問不存在的 key 時，斷言會拋出 KeyError ```python with self.assertRaises(KeyError): value = d['empty'] ``` 那么如何運行單元測試呢？ ```python if __name__ == '__main__': unittest.main() ``` 然后就可以當做正常腳本運行。也可以使用命令行參數來運行，這種方法更為推薦。 ```python python -m unittest mydict_test ``` 可以在單元測試中編寫兩個特殊的 setUp() 和 tearDown() 方法。這兩個方法會分別在每調用一個測試方法的前后分別被執行。 ```python class TestDict(unittest.TestCase): def setUp(self): print('setUp...') def tearDown(self): print('tearDown...') ``` setUp() 和 tearDown() 方法有什么用呢？設想你的測試需要啟動一個數據庫，這時，就可以在 setUp() 方法中連接數據庫，在 tearDown() 方法中關閉數據庫，這樣，不必在每個測試方法中重復相同的代碼 ## 文檔測試當我們編寫注釋時，如果寫上這樣的注釋 ```python def abs(n): ''' Function to get absolute value of number. Example: >>> abs(1) 1 >>> abs(-1) 1 >>> abs(0) 0 ''' return n if n >= 0 else (-n) ``` 告訴函數的調用者該函數的期望輸入和輸出。同時，這些代碼與其他說明寫在注釋中，然后，Python 內置的 “文檔測試”（doctest）模塊可以直接提取注釋中的代碼并執行測試。 ```python # mydict2.py class Dict(dict): ''' Simple dict but also support access as x.y style. >>> d1 = Dict() >>> d1['x'] = 100 >>> d1.x 100 >>> d1.y = 200 >>> d1['y'] 200 >>> d2 = Dict(a=1, b=2, c='3') >>> d2.c '3' >>> d2['empty'] Traceback (most recent call last): ... KeyError: 'empty' >>> d2.empty Traceback (most recent call last): ... AttributeError: 'Dict' object has no attribute 'empty' ''' def __init__(self, **kw): super(Dict, self).__init__(**kw) def __getattr__(self, key): try: return self[key] except KeyError: raise AttributeError(r"'Dict' object has no attribute '%s'" % key) def __setattr__(self, key, value): self[key] = value if __name__=='__main__': import doctest doctest.testmod() ``` 當模塊正常導入時，doctest 不會被執行。只有在命令行直接運行時，才執行 doctest。所以，不必擔心 doctest 會在非測試環境下執行。