python调试的几种方法

调试  

From ：https://www.liaoxuefeng.com/wiki/001374738125095c955c1e6d8bb493182103fac9270762a000/00138683229901532c40b749184441dbd428d2e0f8aa50e000

程序能一次写完并正常运行的几率很小，基本不超过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'。输入命令l来查看代码：

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

输入命令n能够单步执行代码：

(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

输入命令q结束调试，退出程序：

(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调试环境，能够用命令p查看变量，或者用命令c继续运行：

$ 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程序。

小结