錯誤處理

在程序運行的過程中熙暴，如果發(fā)生錯誤闺属，可以事先約定返回一個錯誤代碼，這樣就可以知道是否有錯周霉，以及出錯的原因掂器。在操作系統(tǒng)的調(diào)用中，返回錯誤碼非常常見俱箱。
for example:打開文件的函數(shù)open()国瓮，成功時返回文件描述符（也就是一個整數(shù)），出錯時返回-1 。
但是用錯誤碼的方式返回錯誤信息不是很好乃摹，因為函數(shù)一般的返回值會與錯誤碼混合在一起厂财，不便于理解。

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

# -*- 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

高級語言都內(nèi)置了一套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')

當(dāng)我們認為某些代碼可能會出錯時与斤，就可以用try來運行這段代碼肪康，如果執(zhí)行出錯，則后續(xù)代碼不會繼續(xù)執(zhí)行撩穿，而是直接跳至處理錯誤代碼磷支，except語句塊，執(zhí)行完except后食寡，如果有finally語句塊雾狈，則執(zhí)行finally語句塊，直到執(zhí)行完畢抵皱。
上面的代碼在10/0的時候會出現(xiàn)divisionerror：

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

錯誤也有很多種類善榛，也有不同種類的except語句：

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')
   

此外，如果沒有錯誤發(fā)生呻畸，可以在except語句塊后面加一個else移盆，當(dāng)沒有錯誤發(fā)生時，會自動執(zhí)行else語句伤为。
Python的錯誤其實也是class咒循，所有的錯誤類型都繼承自BaseException，所以在使用except時需要注意的是绞愚，它不但捕獲該類型的錯誤叙甸，還把其子類也“一網(wǎng)打盡”。
[常見的錯誤類型和繼承關(guān)系]：https://docs.python.org/3/library/exceptions.html#exception-hierarchyhttps://docs.python.org/3/library/exceptions.html#exception-hierarchy
注意：不需要在每個可能出錯的地方去捕獲錯誤位衩，只要在合適的層次去捕獲錯誤就可以了裆蒸。

調(diào)用棧

如果錯誤一直沒有被捕捉，它就會一直往上拋蚂四，最后被Python解釋器捕捉光戈，打印一個錯誤信息，然后程序退出遂赠。

# 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

出錯的時候久妆，一定要分析錯誤的調(diào)用棧信息，才能定位錯誤的位置跷睦。

記錄錯誤

我們可以捕捉錯誤筷弦，把錯誤堆棧打印出來，然后分析錯誤原因，同時讓程序執(zhí)行烂琴。

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

同樣是出錯爹殊，但程序打印完錯誤信息后會繼續(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

拋出錯誤

因為錯誤是Class梗夸，捕捉錯誤就是捕捉到該Class的一個實例。因此号醉，錯誤并不是憑空產(chǎn)生的反症，而是有意被創(chuàng)建并拋出的。Python的內(nèi)置函數(shù)可以拋出錯誤畔派，我們也可以DIY铅碍。

如果要拋出錯誤，首先根據(jù)需要线椰，可以定義一個錯誤的Class胞谈，選擇好繼承關(guān)系然后在用raise語句拋出一個錯誤的實例：

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í)行，則可以最后跟蹤到我們自己定義的錯誤：

$ 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()把打印可能出錯的變量

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()來輔助查看的地方憨愉，都可以使用assert來替代：

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

def main():
    foo('0')

assert是指 assert的式子應(yīng)該是正確的烦绳，否則后面的代碼會有錯誤。
如果斷言失敗的話配紫，assert語句本身就會拋出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不會拋出錯誤笨蚁，還可以輸出到文件:

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的好處睹晒，它允許你指定記錄信息的級別，有debug括细，info伪很，warning，error等幾個級別奋单，當(dāng)我們指定level=INFO時锉试，logging.debug就不起作用了。同理览濒，指定level=WARNING后呆盖，debug和info就不起作用了。這樣一來贷笛，你可以放心地輸出不同級別的信息应又，也不用刪除，最后統(tǒng)一控制輸出哪個級別的信息乏苦。

pdb

啟動Python的調(diào)試器pdb株扛，讓程序以單步方式運行尤筐，可以隨時查看運行狀態(tài)。我們先準備好程序洞就。

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

啟動pdb：

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

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

(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)

任何時候都可以輸入命令p 變量名來查看變量：

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

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

(Pdb) q

代碼很多的時候你的手指會很累Ｓ桶骸！倾贰！

pdb.set_trace()

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

import pdb

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

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

$ 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大法好

單元測試

單元測試是用來對一個Module、一個函數(shù)和或者一個類來進行正確性檢驗的測試工作叹放。
如果單元測試 通過饰恕，說明我們測試的這個函數(shù)能夠正常工作。如果單元測試不通過井仰，要么函數(shù)有bug埋嵌，要么測試條件輸入不正確。
例子：

>>> 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

為了編寫單元測試俱恶，我們需要引入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開頭的方法就是測試方法，不以test開頭的方法不被認為是測試方法合是，測試的時候不會被執(zhí)行了罪。
對每一類測試都需要編寫一個test_xxx()方法。由于unittest.TestCase提供了很多內(nèi)置的條件判斷聪全，我們只需要調(diào)用這些方法就可以斷言輸出是否是我們所期望的泊藕。最常用的斷言就是assertEqual()：

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

另一種重要的斷言就是期待拋出指定類型的Error，比如通過d['empty']訪問不存在的key時难礼，斷言會拋出KeyError：

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

而通過d.empty訪問不存在的key時娃圆，我們期待拋出AttributeError：

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

運行單元測試

一旦編寫好單元測試，我們就可以運行單元測試蛾茉。最簡單的運行方式是在mydict_test.py的最后加上兩行代碼：

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

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

$ python mydict_test.py

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

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

OK

setUp and tearDown

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

setUp()和tearDown()方法有什么用呢谦炬？設(shè)想你的測試需要啟動一個數(shù)據(jù)庫吝岭，這時，就可以在setUp()方法中連接數(shù)據(jù)庫，在tearDown()方法中關(guān)閉數(shù)據(jù)庫窜管，這樣散劫，不必在每個測試方法中重復(fù)相同的代碼：

class TestDict(unittest.TestCase):

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

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

文檔測試