总结：Python中的异常处理
Post

总结：Python中的异常处理

04/12/2016
Toby Qin
11

异常处理在任何一门编程语言里都是值得关注的一个话题，良好的异常处理可以让你的程序更加健壮，清晰的错误信息更能帮助你快速修复问题。

在Python中，和不部分高级语言一样，使用了try/except/finally语句块来处理异常，如果你有其他编程语言的经验，实践起来并不难。

异常处理语句 try…excpet…finally

实例代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

def div(a, b):
    try:
        print(a / b)
    except ZeroDivisionError:
        print("Error: b should not be 0 !!")
    except Exception as e:
        print("Unexpected Error: {}".format(e))
    else:
        print('Run into else only when everything goes well')
    finally:
        print('Always run into finally block.')

# tests
div(2, 0)
div(2, 'bad type')
div(1, 2)

# Mutiple exception in one line
try:
    print(a / b)
except (ZeroDivisionError, TypeError) as e:
    print(e)

# Except block is optional when there is finally
try:
    open(database)
finally:
    close(database)

# catch all errors and log it
try:
    do_work()
except:    
    # get detail from logging module
    logging.exception('Exception caught!')
    
    # get detail from sys.exc_info() method
    error_type, error_value, trace_back = sys.exc_info()
    print(error_value)
    raise

总结如下

  1. except语句不是必须的，finally语句也不是必须的，但是二者必须要有一个，否则就没有try的意义了。
  2. except语句可以有多个，Python会按except语句的顺序依次匹配你指定的异常，如果异常已经处理就不会再进入后面的except语句。
  3. except语句可以以元组形式同时指定多个异常，参见实例代码。
  4. except语句后面如果不指定异常类型，则默认捕获所有异常，你可以通过logging或者sys模块获取当前异常。
  5. 如果要捕获异常后要重复抛出，请使用raise，后面不要带任何参数或信息。
  6. 不建议捕获并抛出同一个异常，请考虑重构你的代码。
  7. 不建议在不清楚逻辑的情况下捕获所有异常，有可能你隐藏了很严重的问题。
  8. 尽量使用内置的异常处理语句来 替换try/except语句，比如with语句，getattr()方法。

抛出异常 raise

如果你需要自主抛出异常一个异常，可以使用raise关键字，等同于C#和Java中的throw语句，其语法规则如下。

1

raise NameError("bad name!")

raise关键字后面需要指定你抛出的异常类型，一般来说抛出的异常越详细越好，Python在exceptions模块内建了很多的异常类型，通过使用dir()函数来查看exceptions中的异常类型，如下：

1
2
3
4

import exceptions

# ['ArithmeticError', 'AssertionError'.....]
print dir(exceptions)

当然你也可以查阅Python的文档库进行更详细的了解。

  • https://docs.python.org/2.7/library/exceptions.html#bltin-exceptions

自定义异常类型

Python中也可以自定义自己的特殊类型的异常，只需要要从Exception类继承(直接或间接)即可：

1
2

class SomeCustomException(Exception):
    pass

一般你在自定义异常类型时，需要考虑的问题应该是这个异常所应用的场景。如果内置异常已经包括了你需要的异常，建议考虑使用内置 的异常类型。比如你希望在函数参数错误时抛出一个异常，你可能并不需要定义一个InvalidArgumentError，使用内置的ValueError即可。

经验案例

传递异常 re-raise Exception

捕捉到了异常，但是又想重新引发它（传递异常），使用不带参数的raise语句即可：

1
2
3
4
5
6
7
8
9
10

def f1():
    print(1/0)

def f2():
    try:
        f1()
    except Exception as e:
        raise  # don't raise e !!!

f2()

在Python2中，为了保持异常的完整信息，那么你捕获后再次抛出时千万不能在raise后面加上异常对象，否则你的trace信息就会从此处截断。以上是最简单的重新抛出异常的做法。

还有一些技巧可以考虑，比如抛出异常前对异常的信息进行更新。

1
2
3
4
5
6

def f2():
    try:
        f1()
    except Exception as e:
        e.args += ('more info',)
        raise

如果你有兴趣了解更多，建议阅读这篇博客。

  • http://www.ianbicking.org/blog/2007/09/re-raising-exceptions.html

Python3对重复传递异常有所改进，你可以自己尝试一下，不过建议还是同上。

Exception 和 BaseException

当我们要捕获一个通用异常时，应该用Exception还是BaseException？我建议你还是看一下 官方文档说明，这两个异常到底有啥区别呢？ 请看它们之间的继承关系。

1
2
3
4
5
6
7
8

BaseException
 +-- SystemExit
 +-- KeyboardInterrupt
 +-- GeneratorExit
 +-- Exception
      +-- StopIteration...
      +-- StandardError...
      +-- Warning...

从Exception的层级结构来看，BaseException是最基础的异常类，Exception继承了它。BaseException除了包含所有的Exception外还包含了SystemExit，KeyboardInterrupt和GeneratorExit三个异常。

有此看来你的程序在捕获所有异常时更应该使用Exception而不是BaseException，因为另外三个异常属于更高级别的异常，合理的做法应该是交给Python的解释器处理。

except Exception as e和 except Exception, e

代码示例如下：

1
2
3
4
5
6

try:
    do_something()
except NameError as e:  # should
    pass
except KeyError, e:  # should not
    pass

在Python2的时代，你可以使用以上两种写法中的任意一种。在Python3中你只能使用第一种写法，第二种写法被废弃掉了。第一个种写法可读性更好，而且为了程序的兼容性和后期移植的成本，请你也抛弃第二种写法。

raise “Exception string”

把字符串当成异常抛出看上去是一个非常简洁的办法，但其实是一个非常不好的习惯。

1
2
3
4

if is_work_done():
    pass
else:
    raise "Work is not done!" # not cool

上面的语句如果抛出异常，那么会是这样的：

1
2
3
4

Traceback (most recent call last):
  File "/demo/exception_hanlding.py", line 48, in <module>
    raise "Work is not done!"
TypeError: exceptions must be old-style classes or derived from BaseException, not str

这在Python2.4以前是可以接受的做法，但是没有指定异常类型有可能会让下游没办法正确捕获并处理这个异常，从而导致你的程序挂掉。简单说，这种写法是是封建时代的陋习，应该扔了。

使用内置的语法范式代替try/except

Python 本身提供了很多的语法范式简化了异常的处理，比如for语句就处理的StopIteration异常，让你很流畅地写出一个循环。

with语句在打开文件后会自动调用finally中的关闭文件操作。我们在写Python代码时应该尽量避免在遇到这种情况时还使用try/except/finally的思维来处理。

1
2
3
4
5
6
7
8
9
10

# should not
try:
    f = open(a_file)
    do_something(f)
finally:
    f.close()

# should 
with open(a_file) as f:
    do_something(f)

再比如，当我们需要访问一个不确定的属性时，有可能你会写出这样的代码：

1
2
3
4
5

try:
    test = Test()
    name = test.name  # not sure if we can get its name
except AttributeError:
    name = 'default'

其实你可以使用更简单的getattr()来达到你的目的。

1

name = getattr(test, 'name', 'default')

最佳实践

最佳实践不限于编程语言，只是一些规则和填坑后的收获。

  1. 只处理你知道的异常，避免捕获所有 异常然后吞掉它们。
  2. 抛出的异常应该说明原因，有时候你知道异常类型也猜不出所以然的。
  3. 避免在catch语句块中干一些没意义的事情。
  4. 不要使用异常来控制流程，那样你的程序会无比难懂和难维护。
  5. 如果有需要，切记使用finally来释放资源。
  6. 如果有需要，请不要忘记在处理异常后做清理工作或者回滚操作。
Tech
python exception handling

Gif截屏工具 - GifCam

Move on to Python 3