python的调试

调试

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

第一种方法：print
简单直接粗暴有效，就是用print()把可能有问题的变量打印出来看看：

def foo(s):
    n = int(s)
    print(">>>n = %d" % n)
    return 10 / n

def main():
    foo("0")

main()

输出结果：

>>>n = 0
Traceback (most recent call last):
  File "C:/Python36/test.py", line 9, in <module>
    main()
  File "C:/Python36/test.py", line 7, in main
    foo("0")
  File "C:/Python36/test.py", line 4, in foo
    return 10 / n
ZeroDivisionError: division by zero

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


第二种方法：断言

凡是用print()来辅助查看的地方，都可以用断言（assert）来代替：
def foo(s):
    n =  int(s)
    assert n != 0, "n is zero!"
    return 10 / n

def main():
    foo("0")

main()

assert的意思是，表达式 n!=0 应该是True，否则根据程序运行的逻辑，后面的代码肯定会出错。
如果断言失败，assert语句本身就会抛出AssertionError:

Traceback (most recent call last):
  File "C:/Python36/test.py", line 9, in <module>
    main()
  File "C:/Python36/test.py", line 7, in main
    foo("0")
  File "C:/Python36/test.py", line 3, in foo
    assert n != 0, "n is zero!"
AssertionError: n is zero!

如果程序中到处充斥着assert，和print（）相比也好不到哪去。
不过启动python解释器可以用-o参数来关闭assert：
$ python3 -O err.py
Traceback (most recent call last):
  ...
ZeroDivisionError: division by zero

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


第三种方法：logging
把print（）替换为logging是第三种方式，和assert比，logging不会抛出错误，而且可以输出到文件。

import logging

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

输出结果：
Traceback (most recent call last):
  File "C:/Python36/test.py", line 6, in <module>
    print(10 / n)
ZeroDivisionError: division by zero
>>>

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

别急，在import logging 之后添加一行配置再试试
import logging
logging.basicConfig(level = logging.INFO)

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

输出结果：
INFO:root:n = 0
Traceback (most recent call last):
  File "C:/Python36/test.py", line 7, in <module>
    print(10 / n)
ZeroDivisionError: division by zero

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


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

s = "0"
n = int(s)
print(10 / n)

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

然后逐行输入代码检查。
这种通过pdb在命令行调试的方法理论上是万能的，但是实在太麻烦了。

IDE

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

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

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


总结：

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

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