python错误处理
-
python错误处理采用try…except…finally…的错误处理机制。
try: print('try...') r = 10 / int('2') print('result:', r) except ValueError as e: print('ValueError:', e) except ZeroDivisionError as e: print('ZeroDivisionError:', e) else: print('no error!') finally: print('finally...') print('END')
1)当我们认为某些代码可能会出错时,就可以用try来运行这段代码,如果执行出错,则后续代码不会继续执行,而是直接跳转至错误处理代码,即except语句块,执行完except后,如果有finally语句块,则执行finally语句块,至此,执行完毕。如果没有发生错误,则except语句块不会被执行,但是finally存在的话finally会被执行。
2)有多个错误需要捕获时,可用多个except语句。
3)如果没有错误发生,可以在except语句块后面加上一个else,当没有错误发生时,会自动执行else语句。
4)python的错误其实也是class,所有的错误类型都继承自BaseException。except不但会捕获该类型的错误,还会捕获错误类型的子类。
try: foo() except ValueError as e: print('ValueError') except UnicodeError as e: print('UnicodeError')
第二个except永远不会被捕获,因为UnicodeError是ValueError的子类,如果有UnicodeError错误,也被第一个except捕获了。
-
python的所有错误都是从BaseException类派生的,常见的错误类型和继承关系参考:
https://docs.python.org/3/library/exceptions.html#exception-hierarchy
-
try…except捕获错误可以跨越多层调用,比如函数main()调用foo(),foo()调用bar(),结果bar()出错了,这是,只要main()捕获到了,就可以处理。也就是说,不需要在每个可能出错的地方去捕获错误,只要在合适的层次去捕获错误就可以了。这样一来,就大大减少了写try...except...finally的麻烦。
-
raise抛出错误
因为错误是class,捕获一个错误就是捕获到该class的一个实例。因此,错误并不是凭空产生的,而是有意创建并抛出的。
#!/usr/bin/env python3 # -*- coding: utf-8 -*- class FooError(ValueError): pass def foo(s): n = int(s) if n == 0: raise FooError('invalid value:%s', s) return 10/n foo('0')
执行结果:
$ ./err_raise.py Traceback (most recent call last): File "./err_raise.py", line 13, in <module> foo('0') File "./err_raise.py", line 10, in foo raise FooError('invalid value:%s', s) __main__.FooError: ('invalid value:%s', '0')
只有在必要的时候才定义我们自己的错误类型。如果可以选择Python已有的内置的错误类型(比如ValueError,TypeError),尽量使用Python内置的错误类型。
-
在except中再抛出一个错误或转换错误。捕获错误目的只是记录一下,便于后续追踪。但是,由于当前函数不知道应该怎么处理该错误,所以,最恰当的方式是继续往上抛,让顶层调用者去处理。
try: 10 / 0 except ZeroDivisionError: raise ValueError('input error!')
raise语句如果不带参数,就会把当前错误原样抛出。
在except中raise一个Error,还可以把一种类型的错误转化成另一种类型。
-
with 语句适用于对资源进行访问的场合,确保不管使用过程中是否发生异常都会执行必要的“清理”操作,释放资源,比如文件使用后自动关闭、线程中锁的自动获取和释放等。如文件调用中自动调用close()方法:
with open('/path/to/file', 'r') as f: print(f.read()) 等价于: try: f = open('/path/to/file', 'r') print(f.read()) finally: if f: f.close()
-
python支持断言
assert n != 0, 'n is zero!'
assert含义,表达式n!=0应该是True,否则后面的代码肯定有错。
assert会抛出AssertionError,错误记录为assert后面的语句。
python解释器可用-O参数来关闭assert。
-
python内置logging模块可以记录错误信息:
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')
通过配置,logging还可以把错误记录到日志文件里,方便事后排查。
logging有debug,info,warning,error等几个级别,当我们指定level=INFO时,logging.debug就不起作用了。同理,指定level=WARNING后,debug和info就不起作用了。这样一来,你可以放心地输出不同级别的信息,也不用删除,最后统一控制输出哪个级别的信息。
import logging
logging.basicConfig(level=logging.INFO)
-
单元测试
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
编写单元测试时,我们需要编写一个测试类,从unittest.TestCase继承。
以test开头的方法就是测试方法,不以test开头的方法不被认为是测试方法,测试的时候不会被执行。
对每一类测试都需要编写一个test_xxx()方法。由于unittest.TestCase提供了很多内置的条件判断,我们只需要调用这些方法就可以断言输出是否是我们所期望的。最常用的断言就是assertEqual():
self.assertEqual(abs(-1), 1) # 断言函数返回的结果与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当做正常的python脚本运行:
$ python mydict_test.py
在命令行运行mydict_test.py模块文件时,Python解释器把一个特殊变量__name__置为__main__,而如果在其他地方导入mydict_test.py模块时,if判断将失败。因此,这种if测试可以让一个模块通过命令行运行时执行一些额外的代码,最常见的就是运行测试。
另一种方法是在命令行通过参数-m unittest直接运行单元测试:
$ python -m unittest mydict_test ..... ---------------------------------------------------------------------- Ran 5 tests in 0.000s OK
这是推荐的做法,因为这样可以一次批量运行很多单元测试,并且,有很多工具可以自动来运行这些单元测试。
-
setUp与tearDown
可以在单元测试中编写两个特殊的setUp()和tearDown()方法。这两个方法会分别在每调用一个测试方法的前后分别被执行。
setUp()和tearDown()方法有什么用呢?设想你的测试需要启动一个数据库,这时,就可以在setUp()方法中连接数据库,在tearDown()方法中关闭数据库,这样,不必在每个测试方法中重复相同的代码:
class TestDict(unittest.TestCase): def setUp(self): print('setUp...') def tearDown(self): print('tearDown...')
可以再次运行测试看看每个测试方法调用前后是否会打印出setUp...和tearDown...。