您的位置：首页 > 编程语言 > Python开发

python 2.7 : 错误处理、调试

2016-12-29 13:38 495 查看

转载于：http://www.liaoxuefeng.com/wiki/001374738125095c955c1e6d8bb493182103fac9270762a000/001386832284796780f5db7b5744bf9989f8d845ef77712000

错误处理

在程序运行的过程中，如果发生了错误，可以事先约定返回一个错误代码，这样，就可以知道是否有错，以及出错的原因。在操作系统提供的调用中，返回错误码非常常见。比如打开文件的函数

open()

，成功时返回文件描述符（就是一个整数），出错时返回

-1

。

用错误码来表示是否出错十分不便，因为函数本身应该返回的正常结果和错误码混在一起，造成调用者必须用大量的代码来判断是否出错：

def foo():
r = some_function()
if r==(-1):
return (-1)
# do something
return r

def bar():
r = foo()
if r==(-1):
print 'Error'
else:
pass

一旦出错，还要一级一级上报，直到某个函数可以处理该错误（比如，给用户输出一个错误信息）。

所以高级语言通常都内置了一套

try...except...finally...

的错误处理机制，Python也不例外。

try

让我们用一个例子来看看

try

的机制：

try:
print 'try...'
r = 10 / 0
print 'result:', r
except ZeroDivisionError, e:
print 'except:', e
finally:
print 'finally...'
print 'END'

当我们认为某些代码可能会出错时，就可以用

try

来运行这段代码，如果执行出错，则后续代码不会继续执行，而是直接跳转至错误处理代码，即

except

语句块，执行完

except

后，如果有

finally

语句块，则执行

finally

语句块，至此，执行完毕。

上面的代码在计算

10 / 0

时会产生一个除法运算错误：

try...
except: integer division or modulo by zero
finally...
END

从输出可以看到，当错误发生时，后续语句

print 'result:', r

不会被执行，

except

由于捕获到

ZeroDivisionError

，因此被执行。最后，

finally

语句被执行。然后，程序继续按照流程往下走。

如果把除数

改成

，则执行结果如下：

try...
result: 5
finally...
END

由于没有错误发生，所以

except

语句块不会被执行，但是

finally

如果有，则一定会被执行（可以没有

finally

语句）。

你还可以猜测，错误应该有很多种类，如果发生了不同类型的错误，应该由不同的

except

语句块处理。没错，可以有多个

except

来捕获不同类型的错误：

try:
print 'try...'
r = 10 / int('a')
print 'result:', r
except ValueError, e:
print 'ValueError:', e
except ZeroDivisionError, e:
print 'ZeroDivisionError:', e
finally:
print 'finally...'
print 'END'

int()

函数可能会抛出

ValueError

，所以我们用一个

except

捕获

ValueError

，用另一个

except

捕获

ZeroDivisionError

。

此外，如果没有错误发生，可以在

except

语句块后面加一个

else

，当没有错误发生时，会自动执行

else

语句：

try:
print 'try...'
r = 10 / int('a')
print 'result:', r
except ValueError, e:
print 'ValueError:', e
except ZeroDivisionError, e:
print 'ZeroDivisionError:', e
else:
print 'no error!'
finally:
print 'finally...'
print 'END'

Python的错误其实也是class，所有的错误类型都继承自

BaseException

，所以在使用

except

时需要注意的是，它不但捕获该类型的错误，还把其子类也“一网打尽”。比如：

try:
foo()
except StandardError, e:
print 'StandardError'
except ValueError, e:
print 'ValueError'

第二个

except

永远也捕获不到

ValueError

，因为

ValueError

是

StandardError

的子类，如果有，也被第一个

except

给捕获了。

Python所有的错误都是从

BaseException

类派生的，常见的错误类型和继承关系看这里：

https://docs.python.org/2/library/exceptions.html#exception-hierarchy

使用

try...except

捕获错误还有一个巨大的好处，就是可以跨越多层调用，比如函数

main()

调用

foo()

，

foo()

调用

bar()

，结果

bar()

出错了，这时，只要

main()

捕获到了，就可以处理：

def foo(s):
return 10 / int(s)

def bar(s):
return foo(s) * 2

def main():
try:
bar('0')
except StandardError, e:
print 'Error!'
finally:
print 'finally...'

也就是说，不需要在每个可能出错的地方去捕获错误，只要在合适的层次去捕获错误就可以了。这样一来，就大大减少了写

try...except...finally

的麻烦。

调用堆栈

如果错误没有被捕获，它就会一直往上抛，最后被Python解释器捕获，打印一个错误信息，然后程序退出。来看看

err.py

：

# err.py:
def foo(s):
return 10 / int(s)

def bar(s):
return foo(s) * 2

def main():
bar('0')

main()

执行，结果如下：

$ python err.py
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: integer division or modulo by zero

出错并不可怕，可怕的是不知道哪里出错了。解读错误信息是定位错误的关键。我们从上往下可以看到整个错误的调用函数链：

错误信息第1行：

Traceback (most recent call last):

告诉我们这是错误的跟踪信息。

第2行：

File "err.py", line 11, in <module>
main()

调用

main()

出错了，在代码文件

err.py

的第11行代码，但原因是第9行：

File "err.py", line 9, in main
bar('0')

调用

bar('0')

出错了，在代码文件

err.py

的第9行代码，但原因是第6行：

File "err.py", line 6, in bar
return foo(s) * 2

原因是

return foo(s) * 2

这个语句出错了，但这还不是最终原因，继续往下看：

File "err.py", line 3, in foo
return 10 / int(s)

原因是

return 10 / int(s)

这个语句出错了，这是错误产生的源头，因为下面打印了：

ZeroDivisionError: integer division or modulo by zero

根据错误类型

ZeroDivisionError

，我们判断，

int(s)

本身并没有出错，但是

int(s)

，在计算

10
/ 0

时出错，至此，找到错误源头。

记录错误

如果不捕获错误，自然可以让Python解释器来打印出错误堆栈，但程序也被结束了。既然我们能捕获错误，就可以把错误堆栈打印出来，然后分析错误原因，同时，让程序继续执行下去。

Python内置的

logging

模块可以非常容易地记录错误信息：

# err.py
import logging

def foo(s):
return 10 / int(s)

def bar(s):
return foo(s) * 2

def main():
try:
bar('0')
except StandardError, e:
logging.exception(e)

main()
print 'END'

同样是出错，但程序打印完错误信息后会继续执行，并正常退出：

$ python err.py
ERROR:root:integer division or modulo by zero
Traceback (most recent call last):File "err.py", line 12, in main
bar('0')
File "err.py", line 8, in bar
return foo(s) * 2
File "err.py", line 5, in foo
return 10 / int(s)
ZeroDivisionError: integer division or modulo by zeroEND

通过配置，

logging

还可以把错误记录到日志文件里，方便事后排查。

抛出错误

因为错误是class，捕获一个错误就是捕获到该class的一个实例。因此，错误并不是凭空产生的，而是有意创建并抛出的。Python的内置函数会抛出很多类型的错误，我们自己编写的函数也可以抛出错误。

如果要抛出错误，首先根据需要，可以定义一个错误的class，选择好继承关系，然后，用

raise

语句抛出一个错误的实例：

# err.py
class FooError(StandardError):
pass

def foo(s):
n = int(s)
if n==0:
raise FooError('invalid value: %s' % s)
return 10 / n

执行，可以最后跟踪到我们自己定义的错误：

$ python err.py
Traceback (most recent call last):...
__main__.FooError: invalid value: 0

只有在必要的时候才定义我们自己的错误类型。如果可以选择Python已有的内置的错误类型（比如ValueError，TypeError），尽量使用Python内置的错误类型。

最后，我们来看另一种错误处理的方式：

# err.py
def foo(s):
n = int(s)
return 10 / n

def bar(s):
try:
return foo(s) * 2
except StandardError, e:
print 'Error!'
raise

def main():
bar('0')

main()

在

bar()

函数中，我们明明已经捕获了错误，但是，打印一个

Error!

后，又把错误通过

raise

语句抛出去了，这不有病么？

其实这种错误处理方式不但没病，而且相当常见。捕获错误目的只是记录一下，便于后续追踪。但是，由于当前函数不知道应该怎么处理该错误，所以，最恰当的方式是继续往上抛，让顶层调用者去处理。

raise

语句如果不带参数，就会把当前错误原样抛出。此外，在

except

中

raise

一个Error，还可以把一种类型的错误转化成另一种类型：

try:
10 / 0
except ZeroDivisionError:
raise ValueError('input error!')

只要是合理的转换逻辑就可以，但是，决不应该把一个

IOError

转换成毫不相干的

ValueError

。

小结

Python内置的

try...except...finally

用来处理错误十分方便。出错时，会分析错误信息并定位错误发生的代码位置才是最关键的。

程序也可以主动抛出错误，让调用者来处理相应的错误。但是，应该在文档中写清楚可能会抛出哪些错误，以及错误产生的原因。

调试

程序能一次写完并正常运行的概率很小，基本不超过1%。总会有各种各样的bug需要修正。有的bug很简单，看看错误信息就知道，有的bug很复杂，我们需要知道出错时，哪些变量的值是正确的，哪些变量的值是错误的，因此，需要一整套调试程序的手段来修复bug。

第一种方法简单直接粗暴有效，就是用

print

把可能有问题的变量打印出来看看：

# err.py
def foo(s):
n = int(s)
print '>>> n = %d' % n
return 10 / n

def main():
foo('0')

main()

执行后在输出中查找打印的变量值：

$ python err.py
>>> n = 0
Traceback (most recent call last):...
ZeroDivisionError: integer division or modulo by zero

用

print

最大的坏处是将来还得删掉它，想想程序里到处都是

print

，运行结果也会包含很多垃圾信息。所以，我们又有第二种方法。

断言

凡是用

print

来辅助查看的地方，都可以用断言（assert）来替代：

# err.py
def foo(s):
n = int(s)
assert n != 0, 'n is zero!'
return 10 / n

def main():
foo('0')

assert

的意思是，表达式

n
!= 0

应该是

True

，否则，后面的代码就会出错。

如果断言失败，

assert

语句本身就会抛出

AssertionError

：

$ python err.py
Traceback (most recent call last):...
AssertionError: n is zero!

程序中如果到处充斥着

assert

，和

print

相比也好不到哪去。不过，启动Python解释器时可以用

-O

参数来关闭

assert

：

$ python -O err.py
Traceback (most recent call last):...
ZeroDivisionError: integer division or modulo by zero

关闭后，你可以把所有的

assert

语句当成

pass

来看。

logging

把

print

替换为

logging

是第3种方式，和

assert

比，

logging

不会抛出错误，而且可以输出到文件：

# err.py
import logging

s = '0'
n = int(s)
logging.info('n = %d' % n)
print 10 / n

logging.info()

就可以输出一段文本。运行，发现除了

ZeroDivisionError

，没有任何信息。怎么回事？

别急，在

import logging

之后添加一行配置再试试：

import logging
logging.basicConfig(level=logging.INFO)

看到输出了：

$ python err.py
INFO:root:n = 0
Traceback (most recent call last):File "err.py", line 8, in <module>
print 10 / n
ZeroDivisionError: integer division or modulo by zero

这就是

logging

的好处，它允许你指定记录信息的级别，有

debug

，

info

，

warning

，

error

等几个级别，当我们指定

level=INFO

时，

logging.debug

就不起作用了。同理，指定

level=WARNING

后，

debug

和

info

就不起作用了。这样一来，你可以放心地输出不同级别的信息，也不用删除，最后统一控制输出哪个级别的信息。

logging

的另一个好处是通过简单的配置，一条语句可以同时输出到不同的地方，比如console和文件。

pdb

第4种方式是启动Python的调试器pdb，让程序以单步方式运行，可以随时查看运行状态。我们先准备好程序：

# err.py
s = '0'
n = int(s)
print 10 / n

然后启动：

$ python -m pdb err.py
> /Users/michael/Github/sicp/err.py(2)<module>()
-> s = '0'

以参数

-m pdb

启动后，pdb定位到下一步要执行的代码

->
s = '0'

。输入命令

来查看代码：

(Pdb) l
1     # err.py
2  -> s = '0'
3     n = int(s)
4     print 10 / n
[EOF]

输入命令

可以单步执行代码：

(Pdb) n
> /Users/michael/Github/sicp/err.py(3)<module>()
-> n = int(s)
(Pdb) n
> /Users/michael/Github/sicp/err.py(4)<module>()
-> print 10 / n

任何时候都可以输入命令

p 变量名

来查看变量：

(Pdb) p s
'0'
(Pdb) p n
0

输入命令

结束调试，退出程序：

(Pdb) n
ZeroDivisionError: 'integer division or modulo by zero'
> /Users/michael/Github/sicp/err.py(4)<module>()
-> print 10 / n
(Pdb) q

这种通过pdb在命令行调试的方法理论上是万能的，但实在是太麻烦了，如果有一千行代码，要运行到第999行得敲多少命令啊。还好，我们还有另一种调试方法。

pdb.set_trace()

这个方法也是用pdb，但是不需要单步执行，我们只需要

import pdb

，然后，在可能出错的地方放一个

pdb.set_trace()

，就可以设置一个断点：

# err.py
import pdb

s = '0'
n = int(s)
pdb.set_trace() # 运行到这里会自动暂停
print 10 / n

运行代码，程序会自动在

pdb.set_trace()

暂停并进入pdb调试环境，可以用命令

查看变量，或者用命令

继续运行：

$ python err.py
> /Users/michael/Github/sicp/err.py(7)<module>()
-> print 10 / n
(Pdb) p n
0
(Pdb) c
Traceback (most recent call last):File "err.py", line 7, in <module>
print 10 / n
ZeroDivisionError: integer division or modulo by zero

这个方式比直接启动pdb单步调试效率要高很多，但也高不到哪去。

IDE

如果要比较爽地设置断点、单步执行，就需要一个支持调试功能的IDE。目前比较好的Python IDE有PyCharm：

http://www.jetbrains.com/pycharm/

另外，Eclipse加上pydev插件也可以调试Python程序。

小结

写程序最痛苦的事情莫过于调试，程序往往会以你意想不到的流程来运行，你期待执行的语句其实根本没有执行，这时候，就需要调试了。

虽然用IDE调试起来比较方便，但是最后你会发现，logging才是终极武器。

内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理

标签：

相关文章推荐

新的分享

章节导航