# 错误
程序运行过程中,有时会遇到各种错误
- 如果是程序本身的问题,称为bug
- 如果是用户输入造成的,则可以通过检查用户输入来处理
- 如果无法在程序运行过程中预测,比如说磁盘满了等,称为异常,也需要进行处理。
## 错误处理
在程序运行的过程中,如果发生了错误,可以事先约定返回一个错误代码,
Python内置了一套try...except...finally... 的错误处理机制
### try
当我们认为某些代码可能会出错时,就可以用 try 来运行这段代码,如果执行出错,则后续代码不会继续执行,而是直接跳转至错误处理代码,即 except 语句块,执行完 except 后,如果有 finally 语句块,则执行 finally 语句块,至此,执行完毕
也可以用多不except来捕获不同类型的错误
如果没有错误发生,可以在except后面加一个else,当没有错误发生的时候,会自动执行。
```python
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')
```
Python 的错误其实也是 class,所有的错误类型都继承自 BaseException
> 在使用 except 时需要注意的是,它不但捕获该类型的错误,还把其子类也 “一网打尽”
使用 try...except 捕获错误还有一个的好处,就是可以跨越多层调用,比如函数 main() 调用 bar(), bar() 调用 foo(),结果 foo() 出错了,这时,只要 main() 捕获到了,就可以处理
```python
def foo(s):
return 10 / int(s)
def bar(s):
return foo(s) * 2
def main():
try:
bar('0')
except Exception as e:
print('Error:', e)
finally:
print('finally...')
```
不需要在每个可能出错的地方去捕获错误
### 调用栈
```python
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
```
出错的时候,一定要分析错误的调用栈信息,才能定位错误的位置。
### 记录错误
如果不捕获错误,自然可以让 Python 解释器来打印出错误堆栈,但程序也被结束了。
既然我们能捕获错误,就可以把错误堆栈打印出来,然后分析错误原因,同时,让程序继续执行下去
我们可以使用内置模块 `logging` 来记录错误信息
```python
# err_logging.py
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')
```
### 抛出错误
```python
def foo(s):
n = int(s)
if n==0:
raise ValueError('invalid value: %s' % s)
return 10 / n
def bar():
try:
foo('0')
except ValueError as e:
print('ValueError!')
raise
bar()
```
在 bar() 函数中,我们已经捕获了错误,但是 foo又把错误抛出去了。
原因是捕获错误目的只是记录一下,便于后续追踪。但是,由于当前函数不知道应该怎么处理该错误,所以,最恰当的方式是继续往上抛,让顶层调用者去处理
raise 语句如果不带参数,就会把当前错误原样抛出。此外,在 except 中 raise 一个 Error,还可以把一种类型的错误转化成另一种类型:
```python
try:
10 / 0
except ZeroDivisionError:
raise ValueError('input error!')
```
## 调试
### 断言
使用print()来打印的最大坏处就是将来还得删除它。
凡是使用print()作为辅助的地方,都可以使用断言。
```python
def foo(s):
n = int(s)
assert n != 0, 'n is zero!'
return 10 / n
def main():
foo('0')
AssertionError: n is zero!
```
assert 的意思是,表达式 n != 0 应该是 True,否则,根据程序运行的逻辑,后面的代码肯定会出错。
如果断言失败,assert 语句本身就会抛出 AssertionError:
启动 Python 解释器时可以用 -O 参数来关闭 assert:
### logging
和 assert 比,logging 不会抛出错误,而且可以输出到文件:
```python
import logging
logging.basicConfig(level=logging.INFO)
s = '0'
n = int(s)
logging.info('n = %d' % n)
print(10 / n)
```
logging 允许你指定记录信息的级别,有 debug,info,warning,error 等几个级别,当我们指定 level=INFO 时,logging.debug 就不起作用了。同理,指定 level=WARNING 后,debug 和 info 就不起作用了。
### pdb
pdb,让程序以单步方式运行,可以随时查看运行状态。
```python
python -m pdb err.py
```
pdb 定位到下一步要执行的代码 -> s = '0'。输入命令 l 来查看代码:
输入n可以单步执行代码
使用 `p 变量名` 来查看变量
输入命令 q 结束调试
同样我们可以设置断点
在可能出错的地方放一个 pdb.set_trace(),就可以设置一个断点:
```python
import pdb
s = '0'
n = int(s)
pdb.set_trace() # 运行到这里会自动暂停
print(10 / n)
```
可以使用命令 p 查看变量,使用c继续运行
## 单元测试
单元测试是用来对一个模块、一个函数或者一个类来进行正确性检验的测试工作
比如对函数 abs(),我们可以编写出以下几个测试用例:
- 输入正数,比如 1、1.2、0.99,期待返回值与输入相同;
- 输入负数,比如 -1、-1.2、-0.99,期待返回值与输入相反;
- 输入 0,期待返回 0;
- 输入非数值类型,比如 None、[]、{},期待抛出 TypeError
单元测试通过有什么意义呢?
如果我们对 abs() 函数代码做了修改,只需要再跑一遍单元测试,如果通过,说明我们的修改不会对 abs() 函数原有的行为造成影响,如果测试不通过,说明我们的修改与原有行为不一致,要么修改代码,要么修改测试。
这种以测试为驱动的开发模式最大的好处就是确保一个程序模块的行为符合我们设计的测试用例。在将来修改的时候,可以极大程度地保证该模块行为仍然是正确的。
现在我们可以编写一个 `Dict`类,这个类与 `dict` 一致。
但是可以通过属性来访问。
```python
>>> d = Dict(a=1, b=2)
>>> d['a']
1
>>> d.a
1
```
代码如下:
```python
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
```
如果要编写单元测试,我们可以使用 `unittest`模块。
```python
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 开头的方法不被认为是测试方法,测试的时候不会被执行。
unittest.TestCase 提供了很多内置的条件判断,我们只需要调用这些方法就可以断言输出是否是我们所期望的。
最常用的断言就是 assertEqual()
```python
self.assertEqual(abs(-1), 1) # 断言函数返回的结果与1相等
```
另一种重要的断言就是期待抛出指定类型的 Error,比如通过 d['empty'] 访问不存在的 key 时,断言会抛出 KeyError
```python
with self.assertRaises(KeyError):
value = d['empty']
```
那么如何运行单元测试呢?
```python
if __name__ == '__main__':
unittest.main()
```
然后就可以当做正常脚本运行。
也可以使用命令行参数来运行,这种方法更为推荐。
```python
python -m unittest mydict_test
```
可以在单元测试中编写两个特殊的 setUp() 和 tearDown() 方法。这两个方法会分别在每调用一个测试方法的前后分别被执行。
```python
class TestDict(unittest.TestCase):
def setUp(self):
print('setUp...')
def tearDown(self):
print('tearDown...')
```
setUp() 和 tearDown() 方法有什么用呢?设想你的测试需要启动一个数据库,这时,就可以在 setUp() 方法中连接数据库,在 tearDown() 方法中关闭数据库,这样,不必在每个测试方法中重复相同的代码
## 文档测试
当我们编写注释时,如果写上这样的注释
```python
def abs(n):
'''
Function to get absolute value of number.
Example:
>>> abs(1)
1
>>> abs(-1)
1
>>> abs(0)
0
'''
return n if n >= 0 else (-n)
```
告诉函数的调用者该函数的期望输入和输出。
同时,这些代码与其他说明写在注释中,然后,Python 内置的 “文档测试”(doctest)模块可以直接提取注释中的代码并执行测试。
```python
# mydict2.py
class Dict(dict):
'''
Simple dict but also support access as x.y style.
>>> d1 = Dict()
>>> d1['x'] = 100
>>> d1.x
100
>>> d1.y = 200
>>> d1['y']
200
>>> d2 = Dict(a=1, b=2, c='3')
>>> d2.c
'3'
>>> d2['empty']
Traceback (most recent call last):
...
KeyError: 'empty'
>>> d2.empty
Traceback (most recent call last):
...
AttributeError: 'Dict' object has no attribute 'empty'
'''
def __init__(self, **kw):
super(Dict, self).__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
if __name__=='__main__':
import doctest
doctest.testmod()
```
当模块正常导入时,doctest 不会被执行。只有在命令行直接运行时,才执行 doctest。所以,不必担心 doctest 会在非测试环境下执行。