一、声明

本文为转载,内容有修改，转载需遵守:转载前文章版权

二、什么是调试

在程序编写过程中，会出现种种错误。有些错误比较简单，看到报错信息，即可以知道是哪里出问题了。但是有些错误，就比较复杂，这个时候就需要进行调试了。

三、print输出

这种方法是最简单，直接在怀疑出错的地方，使用print输出变量值，或者表达式。

#!/usr/bin/env python3  

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 "yichang.py", line 11, in <module>  
    main()  
  File "yichang.py", line 9, in main  
    foo('0')  
  File "yichang.py", line 6, in foo  
    return 10 / n  
ZeroDivisionError: division by zero  

四、打印到日志

可以把报错信息打印到日志中，这里可以使用python自带的第三方日志模块logging
以下内容来自廖雪峰python3课程

#!/usr/bin/env python3  

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: division by zero  

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

五、断言

assert断言和print()输出，其实差不多。区别在于print()输出是输出信息，然后人工判断，而assert可以把判断加载程序中。通过下面的程序说明：

#!/usr/bin/env python3  

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

python yichang.py  
Traceback (most recent call last):  
  File "yichang.py", line 11, in <module>  
    main()  
  File "yichang.py", line 9, in main  
    foo('0')  
  File "yichang.py", line 5, in foo  
    assert n != 0, 'n is zero!'  
AssertionError: n is zero!  

assert断言可以在程序运行时，使用-O参数关闭assert

python -O yichang.py  
Traceback (most recent call last):  
  File "yichang.py", line 11, in <module>  
    main()  
  File "yichang.py", line 9, in main  
    foo('0')  
  File "yichang.py", line 6, in foo  
    return 10 / n  
ZeroDivisionError: division by zero  

六、pdb

pdb方式是让程序单步运行，这样可以随时查看运行状态。通过一个程序查看下(以下内容来自廖雪峰python3，部分内容有更改)：

#!/usr/bin/env python3  

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

pdb方式运行程序的时候，要通过-m pdb指定：

$ python -m pdb err.py  
> /Users/michael/Github/learn-python3/samples/debug/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)  

输入命令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在命令行调试的方法理论上是万能的，但实在是太麻烦了，如果有一千行代码，要运行到第999行得敲多少命令啊。还好，我们还有另一种调试方法。

七、pdb.set_trace()

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

#!/usr/bin/env python3  

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/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  

八、IDE

其实在工作中，大部分程序都是使用IDE工具来写程序的。IDE提供了很多相关的功能。这里推荐两款IDE工具(来自廖雪峰python3)。
PyCharm
Visual Studio Code
需要安装python插件

九、文章原地址

廖雪峰python3