You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

12 KiB

08 | 异常处理:如何提高程序的稳定性?

你好,我是景霄。

今天这节课我想和你聊聊Python的异常处理。和其他语言一样异常处理是Python中一种很常见并且很重要的机制与代码规范。

我在实际工作中见过很多次这样的情况一位工程师提交了代码不过代码某处忘记了异常处理。碰巧这种异常发生的频率不低所以在代码push到线上后没多久就会收到紧急通知——服务器崩溃了。

如果事情严重,对用户的影响也很大,这位工程师还得去专门的会议上做自我检讨,可以说是很惨了。这类事件层出不穷,也告诉我们,正确理解和处理程序中的异常尤为关键。

错误与异常

首先要了解Python中的错误和异常是什么两者之间又有什么联系和区别呢

通常来说,程序中的错误至少包括两种,一种是语法错误,另一种则是异常。

所谓语法错误,你应该很清楚,也就是你写的代码不符合编程规范,无法被识别与执行,比如下面这个例子:

if name is not None
    print(name)

If语句漏掉了冒号不符合Python的语法规范所以程序就会报错invalid syntax

而异常则是指程序的语法正确也可以被执行但在执行过程中遇到了错误抛出了异常比如下面的3个例子

10 / 0
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ZeroDivisionError: integer division or modulo by zero

order * 2
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'order' is not defined

1 + [1, 2]
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: unsupported operand type(s) for +: 'int' and 'list'

它们语法完全正确但显然我们不能做除法时让分母为0也不能使用未定义的变量做运算而让一个整型和一个列表相加也是不可取的。

于是,当程序运行到这些地方时,就抛出了异常,并且终止运行。例子中的ZeroDivisionError NameErrorTypeError,就是三种常见的异常类型。

当然Python中还有很多其他异常类型比如KeyError是指字典中的键找不到;FileNotFoundError是指发送了读取文件的请求,但相应的文件不存在等等,我在此不一一赘述,你可以自行参考相应文档

如何处理异常

刚刚讲到如果执行到程序中某处抛出了异常程序就会被终止并退出。你可能会问那有没有什么办法可以不终止程序让其照样运行下去呢答案当然是肯定的这也就是我们所说的异常处理通常使用try和except来解决比如

try:
    s = input('please enter two numbers separated by comma: ')
    num1 = int(s.split(',')[0].strip())
    num2 = int(s.split(',')[1].strip())
    ... 
except ValueError as err:
    print('Value Error: {}'.format(err))

print('continue')
...

这里默认用户输入以逗号相隔的两个整形数字将其提取后做后续的操作注意input函数会将输入转换为字符串类型。如果我们输入a,b,程序便会抛出异常invalid literal for int() with base 10: 'a'然后跳出try这个block。

由于程序抛出的异常类型是ValueError和except block所catch的异常类型相匹配所以except block便会被执行最终输出Value Error: invalid literal for int() with base 10: 'a',并打印出continue

please enter two numbers separated by comma: a,b
Value Error: invalid literal for int() with base 10: 'a'
continue

我们知道except block只接受与它相匹配的异常类型并执行如果程序抛出的异常并不匹配那么程序照样会终止并退出。

所以,还是刚刚这个例子,如果我们只输入1,程序抛出的异常就是IndexError: list index out of range与ValueError不匹配那么except block就不会被执行程序便会终止并退出continue不会被打印

please enter two numbers separated by comma: 1
IndexError Traceback (most recent call last)
IndexError: list index out of range

不过,很显然,这样强调一种类型的写法有很大的局限性。那么,该怎么解决这个问题呢?

其中一种解决方案是在except block中加入多种异常的类型比如下面这样的写法

try:
    s = input('please enter two numbers separated by comma: ')
    num1 = int(s.split(',')[0].strip())
    num2 = int(s.split(',')[1].strip())
    ...
except (ValueError, IndexError) as err:
    print('Error: {}'.format(err))
    
print('continue')
...

或者第二种写法:

try:
    s = input('please enter two numbers separated by comma: ')
    num1 = int(s.split(',')[0].strip())
    num2 = int(s.split(',')[1].strip())
    ...
except ValueError as err:
    print('Value Error: {}'.format(err))
except IndexError as err:
    print('Index Error: {}'.format(err))

print('continue')
...

这样每次程序执行时except block中只要有一个exception类型与实际匹配即可。

不过很多时候我们很难保证程序覆盖所有的异常类型所以更通常的做法是在最后一个except block声明其处理的异常类型是Exception。Exception是其他所有非系统异常的基类能够匹配任意非系统异常。那么这段代码就可以写成下面这样

try:
    s = input('please enter two numbers separated by comma: ')
    num1 = int(s.split(',')[0].strip())
    num2 = int(s.split(',')[1].strip())
    ...
except ValueError as err:
    print('Value Error: {}'.format(err))
except IndexError as err:
    print('Index Error: {}'.format(err))
except Exception as err:
    print('Other error: {}'.format(err))

print('continue')
...

或者你也可以在except后面省略异常类型这表示与任意异常相匹配包括系统异常等

try:
    s = input('please enter two numbers separated by comma: ')
    num1 = int(s.split(',')[0].strip())
    num2 = int(s.split(',')[1].strip())
    ...
except ValueError as err:
    print('Value Error: {}'.format(err))
except IndexError as err:
    print('Index Error: {}'.format(err))
except:
    print('Other error')

print('continue')
...

需要注意当程序中存在多个except block时最多只有一个except block会被执行。换句话说如果多个except声明的异常类型都与实际相匹配那么只有最前面的except block会被执行其他则被忽略。

异常处理中还有一个很常见的用法是finally经常和try、except放在一起来用。无论发生什么情况finally block中的语句都会被执行哪怕前面的try和excep block中使用了return语句。

一个常见的应用场景,便是文件的读取:

import sys
try:
    f = open('file.txt', 'r')
    .... # some data processing
except OSError as err:
    print('OS error: {}'.format(err))
except:
    print('Unexpected error:', sys.exc_info()[0])
finally:
    f.close()

这段代码中try block尝试读取file.txt这个文件并对其中的数据进行一系列的处理到最后无论是读取成功还是读取失败程序都会执行finally中的语句——关闭这个文件流确保文件的完整性。因此在finally中我们通常会放一些无论如何都要执行的语句。

值得一提的是对于文件的读取我们也常常使用with open你也许在前面的例子中已经看到过with open会在最后自动关闭文件让语句更加简洁。

用户自定义异常

前面的例子里充斥了很多Python内置的异常类型你可能会问我可以创建自己的异常类型吗

答案是肯定是Python当然允许我们这么做。下面这个例子我们创建了自定义的异常类型MyInputError定义并实现了初始化函数和str函数直接print时调用

class MyInputError(Exception):
    """Exception raised when there're errors in input"""
    def __init__(self, value): # 自定义异常类型的初始化
        self.value = value
    def __str__(self): # 自定义异常类型的string表达形式
        return ("{} is invalid input".format(repr(self.value)))
    
try:
    raise MyInputError(1) # 抛出MyInputError这个异常
except MyInputError as err:
    print('error: {}'.format(err))

如果你执行上述代码块并输出,便会得到下面的结果:

error: 1 is invalid input

实际工作中如果内置的异常类型无法满足我们的需求或者为了让异常更加详细、可读想增加一些异常类型的其他功能我们可以自定义所需异常类型。不过大多数情况下Python内置的异常类型就足够好了。

异常的使用场景与注意点

学完了前面的基础知识,接下来我们着重谈一下,异常的使用场景与注意点。

通常来说,在程序中,如果我们不确定某段代码能否成功执行,往往这个地方就需要使用异常处理。除了上述文件读取的例子,我可以再举一个例子来说明。

大型社交网站的后台需要针对用户发送的请求返回相应记录。用户记录往往储存在key-value结构的数据库中每次有请求过来后我们拿到用户的ID并用ID查询数据库中此人的记录就能返回相应的结果。

而数据库返回的原始数据往往是json string的形式这就需要我们首先对json string进行decode解码你可能很容易想到下面的方法

import json
raw_data = queryDB(uid) # 根据用户的id返回相应的信息
data = json.loads(raw_data)

这样的代码是不是就足够了呢?

要知道在json.loads()函数中,输入的字符串如果不符合其规范,那么便无法解码,就会抛出异常,因此加上异常处理十分必要。

try:
    data = json.loads(raw_data)
    ....
except JSONDecodeError as err:
    print('JSONDecodeError: {}'.format(err))

不过,有一点切记,我们不能走向另一个极端——滥用异常处理。

比如,当你想要查找字典中某个键对应的值时,绝不能写成下面这种形式:

d = {'name': 'jason', 'age': 20}
try:
    value = d['dob']
    ...
except KeyError as err:
    print('KeyError: {}'.format(err))

诚然这样的代码并没有bug但是让人看了摸不着头脑也显得很冗余。如果你的代码中充斥着这种写法无疑对阅读、协作来说都是障碍。因此对于flow-control流程控制的代码逻辑我们一般不用异常处理。

字典这个例子,写成下面这样就很好。

if 'dob' in d:
    value = d['dob']
    ...

总结

这节课, 我们一起学习了Python的异常处理及其使用场景你需要重点掌握下面几点。

  • 异常通常是指程序运行的过程中遇到了错误终止并退出。我们通常使用try except语句去处理异常这样程序就不会被终止仍能继续执行。

  • 处理异常时如果有必须执行的语句比如文件打开后必须关闭等等则可以放在finally block中。

  • 异常处理通常用在你不确定某段代码能否成功执行也无法轻易判断的情况下比如数据库的连接、读取等等。正常的flow-control逻辑不要使用异常处理直接用条件语句解决就可以了。

思考题

最后给你留一个思考题。在异常处理时如果try block中有多处抛出异常需要我们使用多个try except block吗以数据库的连接、读取为例下面两种写法你觉得哪种更好呢

第一种:

try:
    db = DB.connect('<db path>') # 可能会抛出异常
    raw_data = DB.queryData('<viewer_id>') # 可能会抛出异常
except (DBConnectionError, DBQueryDataError) err:
    print('Error: {}'.format(err))

第二种:

try:
    db = DB.connect('<db path>') # 可能会抛出异常
    try:
        raw_data = DB.queryData('<viewer_id>')
    except DBQueryDataError as err:
         print('DB query data error: {}'.format(err))
except DBConnectionError as err:
     print('DB connection error: {}'.format(err))

欢迎在留言区写下你的答案,还有你今天学习的心得和疑惑,也欢迎你把这篇文章分享给你的同事、朋友。