3. 调试
    5. 阅读: 117162
    6. 程序能一次写完并正常运行的概率很小，基本不超过1%。总会有各种各样的bug需要修正。有的bug很简单，看看错误信息就知道，有的bug很复杂，我们需要知道出错时，哪些变量的值是正确的，哪些变量的值是错误的，因此，需要一整套调试程序的手段来修复bug。
    8. 第一种方法简单直接粗暴有效，就是用print()把可能有问题的变量打印出来看看：
    10. def foo(s):
    11.    n = int(s)
    12.    print('>>> n = %d' % n)
    13.    return 10 / n
    15. def main():
    16.    foo('0')
    18. main()
    19. 执行后在输出中查找打印的变量值：
    21. $ python err.py
    22. >>> n = 0
    23. Traceback (most recent call last):
    24.  ...
    25. ZeroDivisionError: integer division or modulo by zero
    26. 用print()最大的坏处是将来还得删掉它，想想程序里到处都是print()，运行结果也会包含很多垃圾信息。所以，我们又有第二种方法。
    28. 断言
    30. 凡是用print()来辅助查看的地方，都可以用断言（assert）来替代：
    32. def foo(s):
    33.    n = int(s)
    34.    assert n != 0, 'n is zero!'
    35.    return 10 / n
    37. def main():
    38.    foo('0')
    39. assert的意思是，表达式n != 0应该是True，否则，根据程序运行的逻辑，后面的代码肯定会出错。
    41. 如果断言失败，assert语句本身就会抛出AssertionError：
    43. $ python err.py
    44. Traceback (most recent call last):
    45.  ...
    46. AssertionError: n is zero!
    47. 程序中如果到处充斥着assert，和print()相比也好不到哪去。不过，启动Python解释器时可以用-O参数来关闭assert：
    49. $ python -O err.py
    50. Traceback (most recent call last):
    51.  ...
    52. ZeroDivisionError: division by zero
    53. 关闭后，你可以把所有的assert语句当成pass来看。
    55. logging
    57. 把print()替换为logging是第3种方式，和assert比，logging不会抛出错误，而且可以输出到文件：
    59. import logging
    61. s = '0'
    62. n = int(s)
    63. logging.info('n = %d' % n)
    64. print(10 / n)
    65. logging.info()就可以输出一段文本。运行，发现除了ZeroDivisionError，没有任何信息。怎么回事？
    67. 别急，在import logging之后添加一行配置再试试：
    69. import logging
    70. logging.basicConfig(level=logging.INFO)
    71. 看到输出了：
    73. $ python err.py
    74. INFO:root:n = 0
    75. Traceback (most recent call last):
    76.  File "err.py", line 8, in <module>
    77.    print(10 / n)
    78. ZeroDivisionError: division by zero
    79. 这就是logging的好处，它允许你指定记录信息的级别，有debug，info，warning，error等几个级别，当我们指定level=INFO时，logging.debug就不起作用了。同理，指定level=WARNING后，debug和info就不起作用了。这样一来，你可以放心地输出不同级别的信息，也不用删除，最后统一控制输出哪个级别的信息。
    81. logging的另一个好处是通过简单的配置，一条语句可以同时输出到不同的地方，比如console和文件。
    83. pdb
    85. 第4种方式是启动Python的调试器pdb，让程序以单步方式运行，可以随时查看运行状态。我们先准备好程序：
    87. # err.py
    88. s = '0'
    89. n = int(s)
    90. print(10 / n)
    91. 然后启动：
    93. $ python -m pdb err.py
    94. > /Users/michael/Github/learn-python3/samples/debug/err.py(2)<module>()
    95. -> s = '0'
    96. 以参数-m pdb启动后，pdb定位到下一步要执行的代码-> s = '0'。输入命令l来查看代码：
    98. (Pdb) l
    99.  1     # err.py
    100.  2  -> s = '0'
    101.  3     n = int(s)
    102.  4     print(10 / n)
    103. 输入命令n可以单步执行代码：
    105. (Pdb) n
    106. > /Users/michael/Github/learn-python3/samples/debug/err.py(3)<module>()
    107. -> n = int(s)
    108. (Pdb) n
    109. > /Users/michael/Github/learn-python3/samples/debug/err.py(4)<module>()
    110. -> print(10 / n)
    111. 任何时候都可以输入命令p 变量名来查看变量：
    113. (Pdb) p s
    114. '0'
    115. (Pdb) p n
    116. 0
    117. 输入命令q结束调试，退出程序：
    119. (Pdb) q
    120. 这种通过pdb在命令行调试的方法理论上是万能的，但实在是太麻烦了，如果有一千行代码，要运行到第999行得敲多少命令啊。还好，我们还有另一种调试方法。
    122. pdb.set_trace()
    124. 这个方法也是用pdb，但是不需要单步执行，我们只需要import pdb，然后，在可能出错的地方放一个pdb.set_trace()，就可以设置一个断点：
    126. # err.py
    127. import pdb
    129. s = '0'
    130. n = int(s)
    131. pdb.set_trace() # 运行到这里会自动暂停
    132. print(10 / n)
    133. 运行代码，程序会自动在pdb.set_trace()暂停并进入pdb调试环境，可以用命令p查看变量，或者用命令c继续运行：
    135. $ python err.py
    136. > /Users/michael/Github/learn-python3/samples/debug/err.py(7)<module>()
    137. -> print(10 / n)
    138. (Pdb) p n
    139. 0
    140. (Pdb) c
    141. Traceback (most recent call last):
    142.  File "err.py", line 7, in <module>
    143.    print(10 / n)
    144. ZeroDivisionError: division by zero
    145. 这个方式比直接启动pdb单步调试效率要高很多，但也高不到哪去。
    147. IDE
    149. 如果要比较爽地设置断点、单步执行，就需要一个支持调试功能的IDE。目前比较好的Python IDE有：
    151. Visual Studio Code：https://code.visualstudio.com/，需要安装Python插件。
    153. PyCharm：http://www.jetbrains.com/pycharm/
    155. 另外，Eclipse加上pydev插件也可以调试Python程序。
    157. 小结
    159. 写程序最痛苦的事情莫过于调试，程序往往会以你意想不到的流程来运行，你期待执行的语句其实根本没有执行，这时候，就需要调试了。
    161. 虽然用IDE调试起来比较方便，但是最后你会发现，logging才是终极武器。
    163. 参考源码
    165. do_assert.py
    167. do_logging.py
    169. do_pdb.py