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

   这篇文章主要介绍了调试Python程序代码的几种方法总结,文中代码基于Python2.x版本,需要的朋友可以参考下

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

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

  ?

1
2
3
4
5
6
7
8
9
10

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

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

  ?

1
2
3
4
5

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

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

  断言

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

  ?

1
2
3
4
5
6
7
8

# 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:

  ?

1
2
3
4

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

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

  ?

1
2
3
4

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

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

  logging

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

  ?

1
2
3
4
5
6
7

# err.py
import logging
 
s = '0'
n = int(s)
logging.info('n = %d' % n)
print 10 / n

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

  别急,在import logging之后添加一行配置再试试:

  ?

1
2

import logging
logging.basicConfig(level=logging.INFO)

  看到输出了:

  ?

1
2
3
4
5
6

$ 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,让程序以单步方式运行,可以随时查看运行状态。我们先准备好程序:

  ?

1
2
3
4

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

  然后启动:

  ?

1
2
3

$ python -m pdb err.py
> /Users/michael/Github/sicp/err.py(2)<module>()
-> s = '0'

  以参数-m pdb启动后,pdb定位到下一步要执行的代码-> s = '0'。输入命令l来查看代码:

  ?

1
2
3
4
5
6

(Pdb) l
1 # err.py
2 -> s = '0'
3 n = int(s)
4 print 10 / n
[EOF]

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

  ?

1
2
3
4
5
6

(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 变量名来查看变量:

  ?

1
2
3
4

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

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

  ?

1
2
3
4
5

(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(),就可以设置一个断点:

  ?

1
2
3
4
5
6
7

# err.py
import pdb
 
s = '0'
n = int(s)
pdb.set_trace() # 运行到这里会自动暂停
print 10 / n

  运行代码,程序会自动在pdb.set_trace()暂停并进入pdb调试环境,可以用命令p查看变量,或者用命令c继续运行:

  ?

1
2
3
4
5
6
7
8
9
10

$ 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才是终极武器。

时间: 2024-08-03 13:08:03

调试Python程序代码的几种方法总结的相关文章

使用 VS Code 远程调试 Python 程序

在上一篇文章 远程调试你的 Python 代码 中,我简单介绍了 Python 世界中的两种远程调试模型:PyCharm 选择的 debugger as debug server 模式和 VS Code 提供的 debugger as debug client 模式,并分享了 PyCharm 的远程调试适用于单体应用,VS Code 的远程调试适用于大规模的分布式应用的观点. 随后有同行来信咨询我具体如何使用 VS Code 来远程调试.由于 VS Code Python Plugin 的文档并

使用PDB模式调试Python程序介绍_python

以前在windows下一直用的idel带的功能调试python程序,在linux下没调试过.(很多时候只是print)就从网上查找一下~ 方法: 复制代码 代码如下: python -m pdb a.py a.py是python文件. (Pdb)模式下的常用命令: q 退出debug h 即help,打印所有可以命令 h w 打印命令 w 的含意 n 执行当前行直到到达下一行或直到它返回 s 执行当前行,一有可能就停止(比如当前行有一个函数调用).它和n(next)的区别是当前行中有函数调用时s

Python文件读取的3种方法及路径转义

  这篇文章主要介绍了Python文件读取的3种方法及路径转义,本文分别给出读取文件的代码实例,最后讲解了路径转义的相关知识.小技巧,需要的朋友可以参考下 1.文件的读取和显示 方法1: 代码如下: f=open(r'G:2.txt') print f.read() f.close() 方法2: 代码如下: try: t=open(r'G:2.txt') print t.read() finally: if t: t.close() 方法3: 代码如下: with open(r'g:2.txt'

使用pdb模块调试Python程序实例

  这篇文章主要介绍了使用pdb模块调试Python程序实例,本文着重讲解了pdb.run()函数.pdb.runeval()函数.pdb.runcall()函数.pdb.set_trace()函数的使用以及pdb调试命令等内容,需要的朋友可以参考下 在Python中,语法错误可以被Python解释器发现,但逻辑上错误或变量使用错误却不容易发现,如果结果没有符合预期,则需要调试,一个很好的调试工具:Python自带的pdb模块.pdb是Python自带的调试模块.使用pdb模块可以为脚本设置断点

Python合并字符串的3种方法

  这篇文章主要介绍了Python合并字符串的3种方法,本文讲解了使用+=操作符.使用%操作符.使用String的' '.join()方法3种方法,需要的朋友可以参考下 目的 将一些小的字符串合并成一个大字符串,更多考虑的是性能 方法 常见的方法有以下几种: 1.使用+=操作符 代码如下: BigString=small1+small2+small3+...+smalln 例如有一个片段pieces=['Today','is','really','a','good','day'],我们希望把它联

Python发送email的3种方法

  这篇文章主要介绍了Python发送email的3种方法,本文讲解了使用登录邮件服务器方法.调用sendmail命令.使用smtp服务来发送三种方法,需要的朋友可以参考下 python发送email还是比较简单的,可以通过登录邮件服务来发送,linux下也可以使用调用sendmail命令来发送,还可以使用本地或者是远程的smtp服务来发送邮件,不管是单个,群发,还是抄送都比较容易实现. 先把几个最简单的发送邮件方式记录下,像html邮件,附件等也是支持的,需要时查文档即可 1.登录邮件服务 代

写出漂亮代码的七种方法

首先我想说明我本文阐述的是纯粹从美学的角度来写出代码,而非技术.逻辑等.以下为写出漂亮代码的七种方法: 1.尽快结束 if 语句 例如下面这个JavaScript语句,看起来就很恐怖: function findShape(flags, point, attribute, list) { if(!findShapePoints(flags, point, attribute)) { if(!doFindShapePoints(flags, point, attribute)) { if(!fin

提升Python程序运行效率的6个方法_python

Python是一个很酷的语言,因为你可以在很短的时间内利用很少的代码做很多事情.不仅如此,它还能轻松地支持多任务,比如多进程等.Python批评者有时会说Python执行缓慢.本文将尝试介绍6个技巧,可加速你的Python应用程序.1.让关键代码依赖于外部包 虽然Python让许多编程任务变得容易,但它可能并不总能为紧急的任务提供最佳性能.你可以为紧急的任务使用C.C++或机器语言编写的外部包,这样可以提高应用程序的性能.这些包都是不能跨平台的,这意味着你需要根据你正在使用的平台,寻找合适的包.

用PDB库调试Python程序

用pdb调试有多种方式可选: 1. 命令行启动目标程序,加上-m参数,这样调用myscript.py的话断点就是程序的执行第一行之前  python -m pdb myscript.py 2. 在Python交互环境中启用调试  >>> import pdb  >>> import mymodule  >>> pdb.run('mymodule.test()') 在 Python 中也可以像 gcc/gdb 那样调试程序,只要在运行 Python 程序