錯(cuò)誤處理

在程序運(yùn)行的過(guò)程中，如果發(fā)生錯(cuò)誤，可以事先約定返回一個(gè)錯(cuò)誤代碼，這樣就可以知道是否有錯(cuò)，以及出錯(cuò)的原因。在操作系統(tǒng)的調(diào)用中，返回錯(cuò)誤碼非常常見(jiàn)。
for example:打開(kāi)文件的函數(shù)open()，成功時(shí)返回文件描述符（也就是一個(gè)整數(shù)），出錯(cuò)時(shí)返回-1 。
但是用錯(cuò)誤碼的方式返回錯(cuò)誤信息不是很好，因?yàn)楹瘮?shù)一般的返回值會(huì)與錯(cuò)誤碼混合在一起，不便于理解。

#調(diào)用者必須用大量的代碼來(lái)判斷是否出錯(cuò)

# -*- coding: utf-8 -*-
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

高級(jí)語(yǔ)言都內(nèi)置了一套try...except...finally...的錯(cuò)誤處理機(jī)制，Python也不例外。

try

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

當(dāng)我們認(rèn)為某些代碼可能會(huì)出錯(cuò)時(shí)，就可以用try來(lái)運(yùn)行這段代碼，如果執(zhí)行出錯(cuò)，則后續(xù)代碼不會(huì)繼續(xù)執(zhí)行，而是直接跳至處理錯(cuò)誤代碼，except語(yǔ)句塊，執(zhí)行完except后，如果有finally語(yǔ)句塊，則執(zhí)行finally語(yǔ)句塊，直到執(zhí)行完畢。
上面的代碼在10/0的時(shí)候會(huì)出現(xiàn)divisionerror：

try...
except: division by zero
finally...
END

錯(cuò)誤也有很多種類，也有不同種類的except語(yǔ)句：

try:
    print('try...')
    r = 10 / int('a')
    print('result:', r)
except ValueError as e:
    print('ValueError:', e)
except ZeroDivisionError as e
    print('ZeroDivisionError:',e)
finally:
    print('finally')
   print('END')
   

此外，如果沒(méi)有錯(cuò)誤發(fā)生，可以在except語(yǔ)句塊后面加一個(gè)else，當(dāng)沒(méi)有錯(cuò)誤發(fā)生時(shí)，會(huì)自動(dòng)執(zhí)行else語(yǔ)句。
Python的錯(cuò)誤其實(shí)也是class，所有的錯(cuò)誤類型都繼承自BaseException，所以在使用except時(shí)需要注意的是，它不但捕獲該類型的錯(cuò)誤，還把其子類也“一網(wǎng)打盡”。
[常見(jiàn)的錯(cuò)誤類型和繼承關(guān)系]：https://docs.python.org/3/library/exceptions.html#exception-hierarchyhttps://docs.python.org/3/library/exceptions.html#exception-hierarchy
注意：不需要在每個(gè)可能出錯(cuò)的地方去捕獲錯(cuò)誤，只要在合適的層次去捕獲錯(cuò)誤就可以了。

調(diào)用棧

如果錯(cuò)誤一直沒(méi)有被捕捉，它就會(huì)一直往上拋，最后被Python解釋器捕捉，打印一個(gè)錯(cuò)誤信息，然后程序退出。

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

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

def main():
    bar('0')

main()

執(zhí)行后結(jié)果如下：

$ 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

出錯(cuò)的時(shí)候，一定要分析錯(cuò)誤的調(diào)用棧信息，才能定位錯(cuò)誤的位置。

記錄錯(cuò)誤

我們可以捕捉錯(cuò)誤，把錯(cuò)誤堆棧打印出來(lái)，然后分析錯(cuò)誤原因，同時(shí)讓程序執(zhí)行。

#使用Python內(nèi)置的logging Module可以清晰的記錄錯(cuò)誤信息
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')

同樣是出錯(cuò)，但程序打印完錯(cuò)誤信息后會(huì)繼續(xù)執(zhí)行，并正常退出。

$ 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

拋出錯(cuò)誤

因?yàn)殄e(cuò)誤是Class，捕捉錯(cuò)誤就是捕捉到該Class的一個(gè)實(shí)例。因此，錯(cuò)誤并不是憑空產(chǎn)生的，而是有意被創(chuàng)建并拋出的。Python的內(nèi)置函數(shù)可以拋出錯(cuò)誤，我們也可以DIY。

如果要拋出錯(cuò)誤，首先根據(jù)需要，可以定義一個(gè)錯(cuò)誤的Class，選擇好繼承關(guān)系然后在用raise語(yǔ)句拋出一個(gè)錯(cuò)誤的實(shí)例：

class FooError(ValueError):
    pass


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


foo('0')

執(zhí)行，則可以最后跟蹤到我們自己定義的錯(cuò)誤：

$ 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

調(diào)試的幾種方法

使用print()把打印可能出錯(cuò)的變量

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

def main():
    foo('0')

main()

執(zhí)行：

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

斷言

凡是使用print()來(lái)輔助查看的地方，都可以使用assert來(lái)替代：

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

def main():
    foo('0')

assert是指 assert的式子應(yīng)該是正確的，否則后面的代碼會(huì)有錯(cuò)誤。
如果斷言失敗的話，assert語(yǔ)句本身就會(huì)拋出AssertionError：

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

可以使用 -0 參數(shù)關(guān)閉assert：

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

關(guān)閉后assert可以看做pass

logging

第三種方式是將print替換成logging，和assert相比，logging不會(huì)拋出錯(cuò)誤，還可以輸出到文件:

import logging
logging.basicConfig(level=logging.INFO) #logging信息可以輸出到屏幕

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

輸出：

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

這就是logging的好處，它允許你指定記錄信息的級(jí)別，有debug，info，warning，error等幾個(gè)級(jí)別，當(dāng)我們指定level=INFO時(shí)，logging.debug就不起作用了。同理，指定level=WARNING后，debug和info就不起作用了。這樣一來(lái)，你可以放心地輸出不同級(jí)別的信息，也不用刪除，最后統(tǒng)一控制輸出哪個(gè)級(jí)別的信息。

pdb

啟動(dòng)Python的調(diào)試器pdb，讓程序以單步方式運(yùn)行，可以隨時(shí)查看運(yùn)行狀態(tài)。我們先準(zhǔn)備好程序。

# err.py
s = '0'
n = int(s)
print(10 / n)

啟動(dòng)pdb：

$ python -m pdb err.py
> /Users/michael/Github/learn-python3/samples/debug/err.py(2)<module>()
-> s = '0

以參數(shù)-m pdb啟動(dòng)后，pdb定位到下一步要執(zhí)行的代碼-> s = '0'。輸入命令l來(lái)查看代碼：

(Pdb) l
  1     # err.py
  2  -> s = '0'
  3     n = int(s)
  4     print(10 / n)

輸入命令n可以單步執(zhí)行代碼：

(Pdb) n
> /Users/michael/Github/learn-python3/samples/debug/err.py(3)<module>()
-> n = int(s)
(Pdb) n
> /Users/michael/Github/learn-python3/samples/debug/err.py(4)<module>()
-> print(10 / n)

任何時(shí)候都可以輸入命令p 變量名來(lái)查看變量：

(Pdb) p s
'0'
(Pdb) p n
0

輸入命令q結(jié)束調(diào)試，退出程序：

(Pdb) q

代碼很多的時(shí)候你的手指會(huì)很累！！！

pdb.set_trace()

這個(gè)方法也是使用pdb，但是不需要單步執(zhí)行，只需要Import pdb，在可能出錯(cuò)的地方放一個(gè)pdb.set_trace(),就可以設(shè)置一個(gè)斷點(diǎn)：

import pdb

s = '0'
n = int(s)
pdb.set_trace()
print(10 / n)

運(yùn)行代碼，程序會(huì)自動(dòng)在pdb.set_trace()暫停并進(jìn)入pdb調(diào)試環(huán)境，可以使用p查看變量，或者c繼續(xù)運(yùn)行：

$ python err.py 
> /Users/michael/Github/learn-python3/samples/debug/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: division by zero

IDE

IDE大法好

單元測(cè)試

單元測(cè)試是用來(lái)對(duì)一個(gè)Module、一個(gè)函數(shù)和或者一個(gè)類來(lái)進(jìn)行正確性檢驗(yàn)的測(cè)試工作。
如果單元測(cè)試 通過(guò)，說(shuō)明我們測(cè)試的這個(gè)函數(shù)能夠正常工作。如果單元測(cè)試不通過(guò)，要么函數(shù)有bug，要么測(cè)試條件輸入不正確。
例子：

>>> d = Dict(a=1, b=2)
>>> d['a']
1
>>> d.a
1

mydict.py代碼如下：

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

為了編寫單元測(cè)試，我們需要引入Python自帶的unittest模塊，編寫mydict_test.py如：

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

以test開(kāi)頭的方法就是測(cè)試方法，不以test開(kāi)頭的方法不被認(rèn)為是測(cè)試方法，測(cè)試的時(shí)候不會(huì)被執(zhí)行。
對(duì)每一類測(cè)試都需要編寫一個(gè)test_xxx()方法。由于unittest.TestCase提供了很多內(nèi)置的條件判斷，我們只需要調(diào)用這些方法就可以斷言輸出是否是我們所期望的。最常用的斷言就是assertEqual()：

self.assertEqual(abs(-1), 1) # 斷言函數(shù)返回的結(jié)果與1相等

另一種重要的斷言就是期待拋出指定類型的Error，比如通過(guò)d['empty']訪問(wèn)不存在的key時(shí)，斷言會(huì)拋出KeyError：

with self.assertRaises(KeyError):
    value = d['empty']

而通過(guò)d.empty訪問(wèn)不存在的key時(shí)，我們期待拋出AttributeError：

with self.assertRaises(AttributeError):
    value = d.empty

運(yùn)行單元測(cè)試

一旦編寫好單元測(cè)試，我們就可以運(yùn)行單元測(cè)試。最簡(jiǎn)單的運(yùn)行方式是在mydict_test.py的最后加上兩行代碼：

if __name__ == '__main__':
    unittest.main()

這樣就可以把mydict_test.py當(dāng)做正常的Python腳本 運(yùn)行：

$ python mydict_test.py

另一種方法是在命令行通過(guò)參數(shù)-m unittest直接運(yùn)行單元測(cè)試：

$ python -m unittest mydict_test
.....
----------------------------------------------------------------------
Ran 5 tests in 0.000s

OK

setUp and tearDown

可以在單元測(cè)試中編寫兩個(gè)特殊的setUp()和tearDown()方法。這兩個(gè)方法會(huì)分別在每調(diào)用一個(gè)測(cè)試方法的前后分別被執(zhí)行。

setUp()和tearDown()方法有什么用呢？設(shè)想你的測(cè)試需要啟動(dòng)一個(gè)數(shù)據(jù)庫(kù)，這時(shí)，就可以在setUp()方法中連接數(shù)據(jù)庫(kù)，在tearDown()方法中關(guān)閉數(shù)據(jù)庫(kù)，這樣，不必在每個(gè)測(cè)試方法中重復(fù)相同的代碼：

class TestDict(unittest.TestCase):

    def setUp(self):
        print('setUp...')

    def tearDown(self):
        print('tearDown...')

文檔測(cè)試