Python 调试器 - pdb、ipdb

调试程序是工作中必不可少的一项重要技能,程序调试可以帮助我们了解程序的运行过程,定位程序Bug。然而,离开了 Pycharm 等 IDE 的图形化界面调试器,很多 Python 工程师便只会使用 print 打印变量中间值。但是,随着代码量的增加,逻辑的进一步复杂,使用 print 打印中间变量的方式,就会显得效率低下,很难快速定位到问题。

本节,为大家准备了 pdb 和 ipdb 两个 Python 调试器。具有 C 或 C++ 背景的读者,肯定了解过 gdb 啦,gdb 是由 GNU 开源组织发布的一个命令行程序调试工具。pdb 和 gdb 保持了一样的用法,如果您学习过 gdb ,那么几乎不用学习就可以直接使用 pdb。

一. 标准库提供的 pdb

常用 pdb 命令如下:

命令 缩写 解释
break b 设置断点
continue cont / c 继续执行至下一个断点
next n 执行下一行,但不会进入子程序
step s 执行下一行,下一行是子程序时,将进入子程序执行
where bt / w 打印堆栈轨迹
enable - 启用禁用的断点
disable - 禁用启用的断点
pp / p - 打印变量或表达式
list l 打印源码
up u 移动到上一层堆栈
down d 移动到下一层堆栈
restart run 重新开始调试
args a 打印函数参数
clear cl 清除所有的断点
return r 执行到当前函数结束

下面,我们启动 Python 调试器,有以下 2 种方式:

通过命令行启动

通过命令行启动 Python 调试器,只需要在命令行参数指定使用 pdb 模块启动 Python 脚本即可:

python -m pdb xxx.py

这种方式适用于程序文件较短的情景,运行上述命令,将在 Python 源码的第一行启动 Python 调试器。

在代码中添加断点

另一种方法是在 Python 代码中调用 pdb 模块的 set_trace 方法设置一个端点。当程序执行至断点时,将会暂停执行并打开 pdb 调试器。


下面,我们以一段简短的程序为例,来实践上文介绍的 pdb 命令。代码如下:

from __future__ import print_function
import pdb

def num_sum(n):
    s = 0
    for i in range(n):
        pdb.set_trace()
        s += i
        print('****** {} *****'.format(s))
        
if __name__ == '__main__':
    num_sum(10)

我们在 for 循环内部的第一行使用 pdb.set_trace() 来设置了一个断点,当程序运行至改行时将暂停执行,并运行 Python 调试器:

进入PDB调试器

使用 where / bt / w 命令来查看当前函数的调用堆栈:
where 命令查看堆栈信息

使用 list 命令可以打印源码:
list 命令打印源码

使用 pp / p 可以打印任意变量的当前取值:
p 命令打印多个变量

next 向下执行1行:w 命令告诉我们程序当前执行到 s += i,执行 n 命令,程序向下执行一行至 print 语句,此时打印 p i,s :第 0 次循环 i = 0,s = 0 + 0,如下所示:
next 命令向下执行1行

下面,我们使用命令 c 进入第二次循环,打印变量 p i, si = 1 已经进入第二次循环,s 之所以还为 0 ,是因为程序目前停在断点处,尚未执行到 s += i;继续 c 之后,我们会发现 s 才会变为 2:
continue 命令继续执行至下一个断点

二. 开源的 ipdb

ipdb 之于 pdb,就像 ipython 之于 python,实现的功能相同,但 ipdb 具有语法高亮、tab 补全、更友好的堆栈信息等优势。

注:pdb 是 Python 的标准库,无需安装直接使用,ipdb 为第三方库,需要使用 pip 安装后使用。

pip3 install -i https://pypi.doubanio.com/simple ipdb

可以发现 ipdb 的呈现也更加清晰、美观:


ipdb 的使用
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,053评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,527评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,779评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,685评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,699评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,609评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,989评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,654评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,890评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,634评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,716评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,394评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,976评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,950评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,191评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,849评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,458评论 2 342

推荐阅读更多精彩内容