Python 6.2 调试

调试

程序一次写完并且运行正常的概率非常低，基本不超过1%，总会有各种各样的bug需要修正。有的bug很简单，看看错误信息就知道，有的bug很复杂，我们需要知道出错时，哪些变量的值是正确的，哪些变量的值是错误的，因此，需要一整套调试程序的手段来修复bug。
第一种方法简单直接粗暴，就是用print()把可能有问题的变量打印出来看看。

def foo(s):
n =int(s)
print('>>> n =%d'% n)

return 10/n
def main():
foo('0')

main()
执行后在输出中查找打印的变量值：
>>>n =0

用print()最大的坏处就是将来还要删除它，想想程序到处都是print(),运行结果也包含很多垃圾信息。所以，我们有第二种方法。

断言
凡是可以使用print()来辅助查看的地方都可以使用断言(assert)来替代：
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:
AsserationError: n is zero!

程序中如果到处充斥着assert，和print()相比也好不到哪去。不过，启动Python解释器可以用-o参数来关闭assert。

关闭后，你可以把所有的assert语句当成pass看。

logging
把print()替换为logging是第三种方法，logging不会抛出错误，而且可以输出到文件:
import logging

s ='0'
n =int(s)

logging.info('n =%d'% n)

print( 10/n )
logging.info()就可以输出一段文本。运行，发现出了ZeroDivisionError外，没有任何信息，怎么回事？

再import logging之后添加一条配置再试试;
import logging

logging.bascConfig(level =logging.INFO)

看到输出了。

这就是logging的好处，它允许你指定记录信息的级别，有debug/info/warning/error几个级别，当我们指定level =logging.INFO，logging.debug就不起作用了。这样一来，就可以放心的输出不同级别的信息，也不用删除，最后统一控制输出那个级别的信息。
logging的另一个好处就是通过简单的配置，一条语句可以输出到不同的文件，比如console和文件。

pdb
第四种是启动Python的调试器pdb，让程序单步运行，可以随时查看运行状态。我们先准备好程序:
s ='0'
n =int(s)

print(10/n)
然后启动Python调试器pdb，让程序单步运行。

$ python3 -m pdb err.py
> /Users/michael/Github/learn-python3/samples/debug/err.py(2)<module>()
-> s = '0'

以参数 -m pdb启动后，pdb定位到下一步要执行的代码 ->s ='0'。输入命令1来查看代码:
(pdb)1

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

输入命令n，可以单步执行代码。
pdb(n)

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

任何时候都可以输入p变量名来查看变量
:

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

输入命令q结束调试，退出程序:
pdb(q)
这种通过pdb在命令行调试的方法理论上是万能的，但是实在是太麻烦了，当代码量很大时，该办法显得笨拙。

pdb.set_trace()
这个方法也是用pdb，但是不需要单步执行，我们只需要import pdb，然后在可能出错的地方放一个pdb.set_tarce()，就可以设置一个断点：
import pdb

s ='0'

n =int(s)

pdb.set_trace()

print(10/n)
运行代码，程序会在pdb.set_trace()暂停并进入pdb调试环境，可以使用命令p查看变量，或者用命令c继续执行。

$ python3 err.py
> /Users/michael/Github/learn-python3/samples/debug/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: division by zero

这个方法比直接启动pdb单步执行效率要高很多，但是也快不到哪去。

IDE
如果要比较爽的设置断点，单步执行，就需要一个支持调试功能的IDE。目前比较好的Python IDE有PyCharm: 另外，Eclipse加上pydev插件也可以调试Python程序。

小结：
写程序最痛苦的莫过于调试，程序往往会以你意想不到的流程执行，这时候需要调试。
虽然IDE调试起来比较简单，但是最终，你发现logging才是终极武器。