程序能一次写完并正常运行的概率很小,基本不超过1%。总会有各种各样的bug需要修正。有的bug很简单,看看错误信息就知道,有的bug很复杂,我们需要知道出错时,哪些变量的值是正确的,哪些变量的值是错误的,因此,需要一整套调试程序的手段来修复bug。
法一:用print() 函数,把可能有问题的变量打印出来看
1 def foo(s):
2 n = int(s)
3 print(‘>>> n = %d‘ % n)
4 return 10 / n
5
6 def main():
7 foo(‘0‘)
8
9 main()
执行后在输出中查找打印的变量值
1 $ python err.py
2 >>> n = 0
3 Traceback (most recent call last):
4 ...
5 ZeroDivisionError: integer division or modulo by zero
用print()
最大的坏处是将来还得删掉它,想想程序里到处都是print()
,运行结果也会包含很多垃圾信息。
法二:断言(凡是用print()
来辅助查看的地方,都可以用断言(assert)来替代)
1 def foo(s):
2 n = int(s)
3 assert n != 0, ‘n is zero!‘
4 return 10 / n
5
6 def main():
7 foo(‘0‘)
assert
的意思是,表达式n != 0
应该是True
,否则,根据程序运行的逻辑,后面的代码肯定会出错。
如果断言失败,assert
语句本身就会抛出AssertionError
1 $ python err.py
2 Traceback (most recent call last):
3 ...
4 AssertionError: n is zero!
程序中如果到处充斥着assert
,和print()
相比也好不到哪去。不过,启动Python解释器时可以用-O
参数来关闭assert
:
1 $ python -O err.py
2 Traceback (most recent call last):
3 ...
4 ZeroDivisionError: division by zero
关闭后,你可以把所有的assert
语句当成pass
来看。
法三:logging
和assert
比,logging
不会抛出错误,而且可以输出到文件
1 import logging
2 logging.basicConfig(level=logging.INFO)
3
4 s = ‘0‘
5 n = int(s)
6 logging.info(‘n = %d‘ % n)
7 print(10 / n)
输出为:
1 $ python err.py
2 INFO:root:n = 0
3 Traceback (most recent call last):
4 File "err.py", line 8, in <module>
5 print(10 / n)
6 ZeroDivisionError: division by zero
这就是logging
的好处,它允许你指定记录信息的级别,有debug
,info
,warning
,error
等几个级别,当我们指定level=INFO
时,logging.debug
就不起作用了。同理,指定level=WARNING
后,debug
和info
就不起作用了。这样一来,你可以放心地输出不同级别的信息,也不用删除,最后统一控制输出哪个级别的信息。
法四:pdb(启动Python的调试器pdb,让程序以单步方式运行,可以随时查看运行状态。)
程序代码为:
1 s = ‘0‘
2 n = int(s)
3 print(10 / n)
然后启动:
1 $ python -m pdb err.py
2 > /Users/michael/Github/learn-python3/samples/debug/err.py(2)<module>()
3 -> s = ‘0‘
以参数-m pdb
启动后,pdb定位到下一步要执行的代码-> s = ‘0‘
。输入命令l
来查看代码
1 (Pdb) l
2 1 # err.py
3 2 -> s = ‘0‘
4 3 n = int(s)
5 4 print(10 / n)
输入命令n
可以单步执行代码
1 (Pdb) n
2 > /Users/michael/Github/learn-python3/samples/debug/err.py(3)<module>()
3 -> n = int(s)
4 (Pdb) n
5 > /Users/michael/Github/learn-python3/samples/debug/err.py(4)<module>()
6 -> print(10 / n)
任何时候都可以输入命令p 变量名
来查看变量
1 (Pdb) p s
2 ‘0‘
3 (Pdb) p n
4 0
输入命令q
结束调试,退出程序
1 (Pdb) q
这种通过pdb在命令行调试的方法理论上是万能的,但实在是太麻烦了,如果有一千行代码,要运行到第999行得敲多少命令啊。
法五: pdb.set_trace()(这个方法也是用pdb,但是不需要单步执行,我们只需要import pdb
,然后,在可能出错的地方放一个pdb.set_trace()
,就可以设置一个断点)
1 # err.py
2 import pdb
3
4 s = ‘0‘
5 n = int(s)
6 pdb.set_trace() # 运行到这里会自动暂停
7 print(10 / n)
运行代码,程序会自动在pdb.set_trace()
暂停并进入pdb调试环境,可以用命令p
查看变量,或者用命令c
继续运行
1 $ python err.py
2 > /Users/michael/Github/learn-python3/samples/debug/err.py(7)<module>()
3 -> print(10 / n)
4 (Pdb) p n
5 0
6 (Pdb) c
7 Traceback (most recent call last):
8 File "err.py", line 7, in <module>
9 print(10 / n)
10 ZeroDivisionError: division by zero
这个方式比直接启动pdb单步调试效率要高很多,但也高不到哪去。
法六:IDE
如果要比较爽地设置断点、单步执行,就需要一个支持调试功能的IDE。目前比较好的Python IDE有:
Visual Studio Code:https://code.visualstudio.com/,需要安装Python插件。
PyCharm:http://www.jetbrains.com/pycharm/
另外,Eclipse加上pydev插件也可以调试Python程序。