1. 错误处理
    2. 阅读: 177262
    3. 在程序运行的过程中,如果发生了错误,可以事先约定返回一个错误代码,这样,就可以知道是否有错,以及出错的原因。在操作系统提供的调用中,返回错误码非常常见。比如打开文件的函数open(),成功时返回文件描述符(就是一个整数),出错时返回-1
    4. 用错误码来表示是否出错十分不便,因为函数本身应该返回的正常结果和错误码混在一起,造成调用者必须用大量的代码来判断是否出错:
    5. def foo():
    6. r = some_function()
    7. if r==(-1):
    8. return (-1)
    9. # do something
    10. return r
    11. def bar():
    12. r = foo()
    13. if r==(-1):
    14. print('Error')
    15. else:
    16. pass
    17. 一旦出错,还要一级一级上报,直到某个函数可以处理该错误(比如,给用户输出一个错误信息)。
    18. 所以高级语言通常都内置了一套try...except...finally...的错误处理机制,Python也不例外。
    19. try
    20. 让我们用一个例子来看看try的机制:
    21. try:
    22. print('try...')
    23. r = 10 / 0
    24. print('result:', r)
    25. except ZeroDivisionError as e:
    26. print('except:', e)
    27. finally:
    28. print('finally...')
    29. print('END')
    30. 当我们认为某些代码可能会出错时,就可以用try来运行这段代码,如果执行出错,则后续代码不会继续执行,而是直接跳转至错误处理代码,即except语句块,执行完except后,如果有finally语句块,则执行finally语句块,至此,执行完毕。
    31. 上面的代码在计算10 / 0时会产生一个除法运算错误:
    32. try...
    33. except: division by zero
    34. finally...
    35. END
    36. 从输出可以看到,当错误发生时,后续语句print('result:', r)不会被执行,except由于捕获到ZeroDivisionError,因此被执行。最后,finally语句被执行。然后,程序继续按照流程往下走。
    37. 如果把除数0改成2,则执行结果如下:
    38. try...
    39. result: 5
    40. finally...
    41. END
    42. 由于没有错误发生,所以except语句块不会被执行,但是finally如果有,则一定会被执行(可以没有finally语句)。
    43. 你还可以猜测,错误应该有很多种类,如果发生了不同类型的错误,应该由不同的except语句块处理。没错,可以有多个except来捕获不同类型的错误:
    44. try:
    45. print('try...')
    46. r = 10 / int('a')
    47. print('result:', r)
    48. except ValueError as e:
    49. print('ValueError:', e)
    50. except ZeroDivisionError as e:
    51. print('ZeroDivisionError:', e)
    52. finally:
    53. print('finally...')
    54. print('END')
    55. int()函数可能会抛出ValueError,所以我们用一个except捕获ValueError,用另一个except捕获ZeroDivisionError
    56. 此外,如果没有错误发生,可以在except语句块后面加一个else,当没有错误发生时,会自动执行else语句:
    57. try:
    58. print('try...')
    59. r = 10 / int('2')
    60. print('result:', r)
    61. except ValueError as e:
    62. print('ValueError:', e)
    63. except ZeroDivisionError as e:
    64. print('ZeroDivisionError:', e)
    65. else:
    66. print('no error!')
    67. finally:
    68. print('finally...')
    69. print('END')
    70. Python的错误其实也是class,所有的错误类型都继承自BaseException,所以在使用except时需要注意的是,它不但捕获该类型的错误,还把其子类也"一网打尽"。比如:
    71. try:
    72. foo()
    73. except ValueError as e:
    74. print('ValueError')
    75. except UnicodeError as e:
    76. print('UnicodeError')
    77. 第二个except永远也捕获不到UnicodeError,因为UnicodeErrorValueError的子类,如果有,也被第一个except给捕获了。
    78. Python所有的错误都是从BaseException类派生的,常见的错误类型和继承关系看这里:
    79. https://docs.python.org/3/library/exceptions.html#exception-hierarchy
    80. 使用try...except捕获错误还有一个巨大的好处,就是可以跨越多层调用,比如函数main()调用foo(),foo()调用bar(),结果bar()出错了,这时,只要main()捕获到了,就可以处理:
    81. def foo(s):
    82. return 10 / int(s)
    83. def bar(s):
    84. return foo(s) * 2
    85. def main():
    86. try:
    87. bar('0')
    88. except Exception as e:
    89. print('Error:', e)
    90. finally:
    91. print('finally...')
    92. 也就是说,不需要在每个可能出错的地方去捕获错误,只要在合适的层次去捕获错误就可以了。这样一来,就大大减少了写try...except...finally的麻烦。
    93. 调用栈
    94. 如果错误没有被捕获,它就会一直往上抛,最后被Python解释器捕获,打印一个错误信息,然后程序退出。来看看err.py
    95. # err.py:
    96. def foo(s):
    97. return 10 / int(s)
    98. def bar(s):
    99. return foo(s) * 2
    100. def main():
    101. bar('0')
    102. main()
    103. 执行,结果如下:
    104. $ python3 err.py
    105. Traceback (most recent call last):
    106. File "err.py", line 11, in <module>
    107. main()
    108. File "err.py", line 9, in main
    109. bar('0')
    110. File "err.py", line 6, in bar
    111. return foo(s) * 2
    112. File "err.py", line 3, in foo
    113. return 10 / int(s)
    114. ZeroDivisionError: division by zero
    115. 出错并不可怕,可怕的是不知道哪里出错了。解读错误信息是定位错误的关键。我们从上往下可以看到整个错误的调用函数链:
    116. 错误信息第1行:
    117. Traceback (most recent call last):
    118. 告诉我们这是错误的跟踪信息。
    119. 2~3行:
    120. File "err.py", line 11, in <module>
    121. main()
    122. 调用main()出错了,在代码文件err.py的第11行代码,但原因是第9行:
    123. File "err.py", line 9, in main
    124. bar('0')
    125. 调用bar('0')出错了,在代码文件err.py的第9行代码,但原因是第6行:
    126. File "err.py", line 6, in bar
    127. return foo(s) * 2
    128. 原因是return foo(s) * 2这个语句出错了,但这还不是最终原因,继续往下看:
    129. File "err.py", line 3, in foo
    130. return 10 / int(s)
    131. 原因是return 10 / int(s)这个语句出错了,这是错误产生的源头,因为下面打印了:
    132. ZeroDivisionError: integer division or modulo by zero
    133. 根据错误类型ZeroDivisionError,我们判断,int(s)本身并没有出错,但是int(s)返回0,在计算10 / 0时出错,至此,找到错误源头。
    134. 出错的时候,一定要分析错误的调用栈信息,才能定位错误的位置。
    135. 谁教你提问不贴异常栈
    136. 记录错误
    137. 如果不捕获错误,自然可以让Python解释器来打印出错误堆栈,但程序也被结束了。既然我们能捕获错误,就可以把错误堆栈打印出来,然后分析错误原因,同时,让程序继续执行下去。
    138. Python内置的logging模块可以非常容易地记录错误信息:
    139. # err_logging.py
    140. import logging
    141. def foo(s):
    142. return 10 / int(s)
    143. def bar(s):
    144. return foo(s) * 2
    145. def main():
    146. try:
    147. bar('0')
    148. except Exception as e:
    149. logging.exception(e)
    150. main()
    151. print('END')
    152. 同样是出错,但程序打印完错误信息后会继续执行,并正常退出:
    153. $ python3 err_logging.py
    154. ERROR:root:division by zero
    155. Traceback (most recent call last):
    156. File "err_logging.py", line 13, in main
    157. bar('0')
    158. File "err_logging.py", line 9, in bar
    159. return foo(s) * 2
    160. File "err_logging.py", line 6, in foo
    161. return 10 / int(s)
    162. ZeroDivisionError: division by zero
    163. END
    164. 通过配置,logging还可以把错误记录到日志文件里,方便事后排查。
    165. 抛出错误
    166. 因为错误是class,捕获一个错误就是捕获到该class的一个实例。因此,错误并不是凭空产生的,而是有意创建并抛出的。Python的内置函数会抛出很多类型的错误,我们自己编写的函数也可以抛出错误。
    167. 如果要抛出错误,首先根据需要,可以定义一个错误的class,选择好继承关系,然后,用raise语句抛出一个错误的实例:
    168. # err_raise.py
    169. class FooError(ValueError):
    170. pass
    171. def foo(s):
    172. n = int(s)
    173. if n==0:
    174. raise FooError('invalid value: %s' % s)
    175. return 10 / n
    176. foo('0')
    177. 执行,可以最后跟踪到我们自己定义的错误:
    178. $ python3 err_raise.py
    179. Traceback (most recent call last):
    180. File "err_throw.py", line 11, in <module>
    181. foo('0')
    182. File "err_throw.py", line 8, in foo
    183. raise FooError('invalid value: %s' % s)
    184. __main__.FooError: invalid value: 0
    185. 只有在必要的时候才定义我们自己的错误类型。如果可以选择Python已有的内置的错误类型(比如ValueErrorTypeError),尽量使用Python内置的错误类型。
    186. 最后,我们来看另一种错误处理的方式:
    187. # err_reraise.py
    188. def foo(s):
    189. n = int(s)
    190. if n==0:
    191. raise ValueError('invalid value: %s' % s)
    192. return 10 / n
    193. def bar():
    194. try:
    195. foo('0')
    196. except ValueError as e:
    197. print('ValueError!')
    198. raise
    199. bar()
    200. bar()函数中,我们明明已经捕获了错误,但是,打印一个ValueError!后,又把错误通过raise语句抛出去了,这不有病么?
    201. 其实这种错误处理方式不但没病,而且相当常见。捕获错误目的只是记录一下,便于后续追踪。但是,由于当前函数不知道应该怎么处理该错误,所以,最恰当的方式是继续往上抛,让顶层调用者去处理。好比一个员工处理不了一个问题时,就把问题抛给他的老板,如果他的老板也处理不了,就一直往上抛,最终会抛给CEO去处理。
    202. raise语句如果不带参数,就会把当前错误原样抛出。此外,在exceptraise一个Error,还可以把一种类型的错误转化成另一种类型:
    203. try:
    204. 10 / 0
    205. except ZeroDivisionError:
    206. raise ValueError('input error!')
    207. 只要是合理的转换逻辑就可以,但是,决不应该把一个IOError转换成毫不相干的ValueError
    208. 练习
    209. 运行下面的代码,根据异常信息进行分析,定位出错误源头,并修复:
    210. # -*- coding: utf-8 -*-
    211. from functools import reduce
    212. def str2num(s):
    213. return int(s)
    214. def calc(exp):
    215. ss = exp.split('+')
    216. ns = map(str2num, ss)
    217. return reduce(lambda acc, x: acc + x, ns)
    218. def main():
    219. r = calc('100 + 200 + 345')
    220. print('100 + 200 + 345 =', r)
    221. r = calc('99 + 88 + 7.6')
    222. print('99 + 88 + 7.6 =', r)
    223. main()
    224. Run
    225. 小结
    226. Python内置的try...except...finally用来处理错误十分方便。出错时,会分析错误信息并定位错误发生的代码位置才是最关键的。
    227. 程序也可以主动抛出错误,让调用者来处理相应的错误。但是,应该在文档中写清楚可能会抛出哪些错误,以及错误产生的原因。
    228. 参考源码
    229. do_try.py
    230. err.py
    231. err_logging.py
    232. err_raise.py
    233. err_reraise.py