在程序運行的過程中,如果發生了錯誤,可以事先約定返回一個錯誤代碼,這樣,就可以知道是否有錯,以及出錯的原因。在操作系統提供的調用中,返回錯誤碼非常常見。比如打開文件的函數open(),成功時返回文件描述符(就是一個整數),出錯時返回-1。
用錯誤碼來表示是否出錯十分不便,因為函數本身應該返回的正常結果和錯誤碼混在一起,造成調用者必須用大量的代碼來判斷是否出錯:
1
2
3
4
5
6
7
8
9
10
11
12
13
|
def foo(): r = some_function() if r = = ( - 1 ): return ( - 1 ) # do something return r def bar(): r = foo() if r = = ( - 1 ): print 'Error' else : pass |
一旦出錯,還要一級一級上報,直到某個函數可以處理該錯誤(比如,給用戶輸出一個錯誤信息)。
所以高級語言通常都內置了一套try...except...finally...的錯誤處理機制,Python也不例外。
try
讓我們用一個例子來看看try的機制:
1
2
3
4
5
6
7
8
9
|
try : print 'try...' r = 10 / 0 print 'result:' , r except ZeroDivisionError, e: print 'except:' , e finally : print 'finally...' print 'END' |
當我們認為某些代碼可能會出錯時,就可以用try來運行這段代碼,如果執行出錯,則后續代碼不會繼續執行,而是直接跳轉至錯誤處理代碼,即except語句塊,執行完except后,如果有finally語句塊,則執行finally語句塊,至此,執行完畢。
上面的代碼在計算10 / 0時會產生一個除法運算錯誤:
1
2
3
4
|
try ... except : integer division or modulo by zero finally ... END |
從輸出可以看到,當錯誤發生時,后續語句print 'result:', r不會被執行,except由于捕獲到ZeroDivisionError,因此被執行。最后,finally語句被執行。然后,程序繼續按照流程往下走。
如果把除數0改成2,則執行結果如下:
1
2
3
4
|
try ... result: 5 finally ... END |
由于沒有錯誤發生,所以except語句塊不會被執行,但是finally如果有,則一定會被執行(可以沒有finally語句)。
你還可以猜測,錯誤應該有很多種類,如果發生了不同類型的錯誤,應該由不同的except語句塊處理。沒錯,可以有多個except來捕獲不同類型的錯誤:
1
2
3
4
5
6
7
8
9
10
11
|
try : print 'try...' r = 10 / int ( 'a' ) print 'result:' , r except ValueError, e: print 'ValueError:' , e except ZeroDivisionError, e: print 'ZeroDivisionError:' , e finally : print 'finally...' print 'END' |
int()函數可能會拋出ValueError,所以我們用一個except捕獲ValueError,用另一個except捕獲ZeroDivisionError。
此外,如果沒有錯誤發生,可以在except語句塊后面加一個else,當沒有錯誤發生時,會自動執行else語句:
1
2
3
4
5
6
7
8
9
10
11
12
13
|
try : print 'try...' r = 10 / int ( 'a' ) print 'result:' , r except ValueError, e: print 'ValueError:' , e except ZeroDivisionError, e: print 'ZeroDivisionError:' , e else : print 'no error!' finally : print 'finally...' print 'END' |
Python的錯誤其實也是class,所有的錯誤類型都繼承自BaseException,所以在使用except時需要注意的是,它不但捕獲該類型的錯誤,還把其子類也“一網打盡”。比如:
1
2
3
4
5
6
|
try : foo() except StandardError, e: print 'StandardError' except ValueError, e: print 'ValueError' |
第二個except永遠也捕獲不到ValueError,因為ValueError是StandardError的子類,如果有,也被第一個except給捕獲了。
Python所有的錯誤都是從BaseException類派生的,常見的錯誤類型和繼承關系看這里:
https://docs.python.org/2/library/exceptions.html#exception-hierarchy
使用try...except捕獲錯誤還有一個巨大的好處,就是可以跨越多層調用,比如函數main()調用foo(),foo()調用bar(),結果bar()出錯了,這時,只要main()捕獲到了,就可以處理:
1
2
3
4
5
6
7
8
9
10
11
12
13
|
def foo(s): return 10 / int (s) def bar(s): return foo(s) * 2 def main(): try : bar( '0' ) except StandardError, e: print 'Error!' finally : print 'finally...' |
也就是說,不需要在每個可能出錯的地方去捕獲錯誤,只要在合適的層次去捕獲錯誤就可以了。這樣一來,就大大減少了寫try...except...finally的麻煩。
調用堆棧
如果錯誤沒有被捕獲,它就會一直往上拋,最后被Python解釋器捕獲,打印一個錯誤信息,然后程序退出。來看看err.py:
1
2
3
4
5
6
7
8
9
10
11
|
# err.py: def foo(s): return 10 / int (s) def bar(s): return foo(s) * 2 def main(): bar( '0' ) main() |
執行,結果如下:
1
2
3
4
5
6
7
8
9
10
11
|
$ python 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: integer division or modulo by zero |
出錯并不可怕,可怕的是不知道哪里出錯了。解讀錯誤信息是定位錯誤的關鍵。我們從上往下可以看到整個錯誤的調用函數鏈:
錯誤信息第1行:
1
|
Traceback (most recent call last): |
告訴我們這是錯誤的跟蹤信息。
第2行:
1
2
|
File "err.py" , line 11 , in <module> main() |
調用main()出錯了,在代碼文件err.py的第11行代碼,但原因是第9行:
1
2
|
File "err.py" , line 9 , in main bar( '0' ) |
調用bar('0')出錯了,在代碼文件err.py的第9行代碼,但原因是第6行:
1
2
|
File "err.py" , line 6 , in bar return foo(s) * 2 |
原因是return foo(s) * 2這個語句出錯了,但這還不是最終原因,繼續往下看:
1
2
|
File "err.py" , line 3 , in foo return 10 / int (s) |
原因是return 10 / int(s)這個語句出錯了,這是錯誤產生的源頭,因為下面打印了:
ZeroDivisionError: integer division or modulo by zero
根據錯誤類型ZeroDivisionError,我們判斷,int(s)本身并沒有出錯,但是int(s)返回0,在計算10 / 0時出錯,至此,找到錯誤源頭。
記錄錯誤
如果不捕獲錯誤,自然可以讓Python解釋器來打印出錯誤堆棧,但程序也被結束了。既然我們能捕獲錯誤,就可以把錯誤堆棧打印出來,然后分析錯誤原因,同時,讓程序繼續執行下去。
Python內置的logging模塊可以非常容易地記錄錯誤信息:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
# err.py import logging def foo(s): return 10 / int (s) def bar(s): return foo(s) * 2 def main(): try : bar( '0' ) except StandardError, e: logging.exception(e) main() print 'END' |
同樣是出錯,但程序打印完錯誤信息后會繼續執行,并正常退出:
1
2
3
4
5
6
7
8
9
10
11
|
$ python err.py ERROR:root:integer division or modulo by zero Traceback (most recent call last): File "err.py" , line 12 , in main bar( '0' ) File "err.py" , line 8 , in bar return foo(s) * 2 File "err.py" , line 5 , in foo return 10 / int (s) ZeroDivisionError: integer division or modulo by zero END |
通過配置,logging還可以把錯誤記錄到日志文件里,方便事后排查。
拋出錯誤
因為錯誤是class,捕獲一個錯誤就是捕獲到該class的一個實例。因此,錯誤并不是憑空產生的,而是有意創建并拋出的。Python的內置函數會拋出很多類型的錯誤,我們自己編寫的函數也可以拋出錯誤。
如果要拋出錯誤,首先根據需要,可以定義一個錯誤的class,選擇好繼承關系,然后,用raise語句拋出一個錯誤的實例:
1
2
3
4
5
6
7
8
9
|
# err.py class FooError(StandardError): pass def foo(s): n = int (s) if n = = 0 : raise FooError( 'invalid value: %s' % s) return 10 / n |
執行,可以最后跟蹤到我們自己定義的錯誤:
1
2
3
4
|
$ python err.py Traceback (most recent call last): ... __main__.FooError: invalid value: 0 |
只有在必要的時候才定義我們自己的錯誤類型。如果可以選擇Python已有的內置的錯誤類型(比如ValueError,TypeError),盡量使用Python內置的錯誤類型。
最后,我們來看另一種錯誤處理的方式:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
# err.py def foo(s): n = int (s) return 10 / n def bar(s): try : return foo(s) * 2 except StandardError, e: print 'Error!' raise def main(): bar( '0' ) main() |
在bar()函數中,我們明明已經捕獲了錯誤,但是,打印一個Error!后,又把錯誤通過raise語句拋出去了,這不有病么?
其實這種錯誤處理方式不但沒病,而且相當常見。捕獲錯誤目的只是記錄一下,便于后續追蹤。但是,由于當前函數不知道應該怎么處理該錯誤,所以,最恰當的方式是繼續往上拋,讓頂層調用者去處理。
raise語句如果不帶參數,就會把當前錯誤原樣拋出。此外,在except中raise一個Error,還可以把一種類型的錯誤轉化成另一種類型:
1
2
3
4
|
try : 10 / 0 except ZeroDivisionError: raise ValueError( 'input error!' ) |
只要是合理的轉換邏輯就可以,但是,決不應該把一個IOError轉換成毫不相干的ValueError。
小結
Python內置的try...except...finally用來處理錯誤十分方便。出錯時,會分析錯誤信息并定位錯誤發生的代碼位置才是最關鍵的。
程序也可以主動拋出錯誤,讓調用者來處理相應的錯誤。但是,應該在文檔中寫清楚可能會拋出哪些錯誤,以及錯誤產生的原因。