调试Python程序代码的几种方法总结


Posted in Python onApril 28, 2015

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

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

# err.py
def foo(s):
  n = int(s)
  print '>>> n = %d' % n
  return 10 / n

def main():
  foo('0')

main()

执行后在输出中查找打印的变量值:

$ python err.py
>>> n = 0
Traceback (most recent call last):
 ...
ZeroDivisionError: integer division or modulo by zero

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

凡是用print来辅助查看的地方,都可以用断言(assert)来替代:

# err.py
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:

$ python err.py
Traceback (most recent call last):
 ...
AssertionError: n is zero!

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

$ python -O err.py
Traceback (most recent call last):
 ...
ZeroDivisionError: integer division or modulo by zero

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

把print替换为logging是第3种方式,和assert比,logging不会抛出错误,而且可以输出到文件:

# err.py
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: integer division or modulo by zero

这就是logging的好处,它允许你指定记录信息的级别,有debug,info,warning,error等几个级别,当我们指定level=INFO时,logging.debug就不起作用了。同理,指定level=WARNING后,debug和info就不起作用了。这样一来,你可以放心地输出不同级别的信息,也不用删除,最后统一控制输出哪个级别的信息。

logging的另一个好处是通过简单的配置,一条语句可以同时输出到不同的地方,比如console和文件。
pdb

第4种方式是启动Python的调试器pdb,让程序以单步方式运行,可以随时查看运行状态。我们先准备好程序:

# err.py
s = '0'
n = int(s)
print 10 / n

然后启动:

$ python -m pdb err.py
> /Users/michael/Github/sicp/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
[EOF]

输入命令n可以单步执行代码:

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

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

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

输入命令q结束调试,退出程序:

(Pdb) n
ZeroDivisionError: 'integer division or modulo by zero'
> /Users/michael/Github/sicp/err.py(4)<module>()
-> print 10 / n
(Pdb) q

这种通过pdb在命令行调试的方法理论上是万能的,但实在是太麻烦了,如果有一千行代码,要运行到第999行得敲多少命令啊。还好,我们还有另一种调试方法。
pdb.set_trace()

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

# err.py
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/sicp/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: integer division or modulo by zero

这个方式比直接启动pdb单步调试效率要高很多,但也高不到哪去。
IDE

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

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

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

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

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

Python 相关文章推荐
python 查找文件夹下所有文件 实现代码
Jul 01 Python
videocapture库制作python视频高速传输程序
Dec 23 Python
Windows系统下使用flup搭建Nginx和Python环境的方法
Dec 25 Python
python实现识别相似图片小结
Feb 22 Python
从零开始学Python第八周:详解网络编程基础(socket)
Dec 14 Python
Python基础教程之浅拷贝和深拷贝实例详解
Jul 15 Python
简单谈谈Python中的json与pickle
Jul 19 Python
python远程连接服务器MySQL数据库
Jul 02 Python
python如何生成网页验证码
Jul 28 Python
python爬虫之验证码篇3-滑动验证码识别技术
Apr 11 Python
pip安装tensorflow的坑的解决
Apr 19 Python
python 利用panda 实现列联表(交叉表)
Feb 06 Python
解析Python中的异常处理
Apr 28 #Python
python调用java模块SmartXLS和jpype修改excel文件的方法
Apr 28 #Python
Python EOL while scanning string literal问题解决方法
Sep 18 #Python
python中尾递归用法实例详解
Apr 28 #Python
在Python中使用元类的教程
Apr 28 #Python
python删除列表中重复记录的方法
Apr 28 #Python
python3实现短网址和数字相互转换的方法
Apr 28 #Python
You might like
索尼SONY ICF-7600A(W)电路分析
2021/03/01 无线电
一步一步学习PHP(2)――PHP类型
2010/02/15 PHP
PHP弹出对话框技巧详细解读
2015/09/26 PHP
PHP中检查isset()和!empty()函数的必要性
2019/02/13 PHP
Fastest way to build an HTML string(拼装html字符串的最快方法)
2011/08/20 Javascript
jQuery隔行变色与普通JS写法的对比
2013/04/21 Javascript
javascript自动改变文字大小和颜色的效果的小例子
2013/08/02 Javascript
jquery动态改变form属性提交表单
2014/06/03 Javascript
JavaScript中实现依赖注入的思路分享
2015/01/15 Javascript
jQuery实现带动画效果的二级下拉导航方法
2015/03/11 Javascript
JSON 的正确用法探讨:Pyhong、MongoDB、JavaScript与Ajax
2016/05/15 Javascript
JS在浏览器中解析Base64编码图像
2017/02/09 Javascript
jQuery模拟下拉框选择对应菜单的内容
2017/03/07 Javascript
node.js调用Chrome浏览器打开链接地址的方法
2017/05/17 Javascript
AngularJS集合数据遍历显示的实例
2017/12/27 Javascript
node.js博客项目开发手记
2018/03/16 Javascript
JS封装的模仿qq右下角消息弹窗功能示例
2018/08/22 Javascript
layer关闭当前窗口页面以及确认取消按钮的方法
2019/09/09 Javascript
p5.js临摹旋转爱心
2019/10/23 Javascript
vue-cli3 取消eslint校验代码的解决办法
2020/01/16 Javascript
python解析xml模块封装代码
2014/02/07 Python
Python中用于检查英文字母大写的isupper()方法
2015/05/19 Python
python实现数值积分的Simpson方法实例分析
2015/06/05 Python
Python实现一个服务器监听多个客户端请求
2018/04/12 Python
python遍历文件夹找出文件夹后缀为py的文件方法
2018/10/21 Python
详解python statistics模块及函数用法
2019/10/27 Python
Python连接Impala实现步骤解析
2020/08/04 Python
电气自动化自荐信
2013/10/10 职场文书
工程招投标邀请书
2014/01/30 职场文书
迟到检讨书5000字
2014/01/31 职场文书
创业者迈进成功第一步:如何写创业计划书?
2014/03/22 职场文书
安康杯竞赛活动总结
2014/05/05 职场文书
北京奥运会口号
2014/06/21 职场文书
2014教师教育实践活动对照检查材料思想汇报
2014/09/21 职场文书
个人剖析材料范文
2014/09/30 职场文书
大学生党员自我剖析材料
2014/10/06 职场文书