来不及解释快上车的 PDB 调试指南

什么是 PDB

PDB 全称 Python Debugger,专门调试 Python 程序的官方库。

有代码就有 Bug,而调试 Bug 则是程序员的必备技能。工欲善其事必先利其器,还好 Python 为我们提供了强大的 PDB。

那么,何时使用 PDB?

以日志调试为荣,以单点调试为耻告诉我们,单点(单步)调试的效率不是很高,也许打印日志是更好的解决办法,说不定利用日志调试的同事早下班了,而你还在吭哧吭哧的单步调试,画面感人。

另外,在解决一个问题的「典型步骤」中,「分析问题并作出假设」占有很大的比重,不要一上来,抓起工具就是干,这是莽撞的做法,连问题都没有定义清楚的情况下,只能是南辕北辙。

你可能在以一种错误的方式使用 PDB

使用 pdb 调试,你是不是习惯这样做?
第一步,在代码中加入这几句:

import pdb

......
pdb.set_trace()                                         # 埋断点
......

第二步,执行 python $yourFile.py, 则程序会自动停留在断点处,然后开始愉快地调试。

但是这样做的效率真的很低。首先你的断点是死的,固定的,静态的;其次是你还要修改代码文件,万一哪天忘记将文件改回原来的状态了,然后直接推向生产环境。。。

这种做法是不好的,甚至是错误的。

这不是我们想要的,也不是 pdb 想给你的。

我们需要的是,动态地,随心所欲地注入断点,并且不要去动源码文件。

哪条是正道呢?

下面就来讲讲使用 PDB 的正确思路。

第一步,直接以python -m pdb $yourFile.py运行文件,然后 pdb 会停留在文件的第一行。

第二步,随心所欲地注入断点。只需要在 pdb 交互式环境中,运行break $lineNumber即可,每运行一次,就是打了一个断点。(break 查看所有断点)

第三步,enable / disable 断点。

  • disable $breakPointNumber 暂时禁止掉该断点
  • enable $breakPointNumber 启用该断点
  • clear $breakPointNumber 彻底清除该断点

第四步,执行断点。

  • next单步走
  • step单步走,但是遇到函数调用,会陷进去
  • until从循环中脱离
  • return从被调用函数中脱离
  • list 告知自己的位置
  • quit直接退出本次调试

第五步,至此,随心所欲地调试,感受世界的善意。

尝试 PDB 的其他用法

调试的时候,我们需要频繁地查看一个变量,或者一个对象的值。

当然,你可以这样:

(Pdb)  p $variable
(Pdb)  pp $variable

# 查看某个变量的帮助
(Pdb)  !help $someInstance 
# 查看某个对象的 __dict__
(Pdb)  pp vars($someInstance)                         

每次输入这么多,次数多了,不免觉得厌烦,有没有更好的办法呢?

当然,答案就是 alias 。

(Pdb)  alias ph !help(%1)                              # %表示变量的意思
(Pdb)  alias pv pp vars(%1)
(Pdb)  alias                                           # 列举所有 alias
(Pdb) unalias $someAlias

可惜,这样还是只能临时 alias,只是帮我们省了一小部分力气,并不是我们想要的。

这时候 .pdbrc 就上场了。

1. ~ 目录下的 .pdbrc 表示全局的 pdb 配置
2. 当前目录下的  .pdbrc 表示针对某个项目的 pdb 配置
3. 非常类似 .bashrc 的配置规则

那么现在就把你所经常使用的 pdb 配置,放到 ~ 目录下或者当前目录下的 .pdbrc 中去吧,一劳永逸有木有!

总结一下

pdb 其实提供了很多很强大的功能,只是我们不会利用,或者没有正确地使用,致使我们不断在黑暗中前行,无形中让我们加了很多班。

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

推荐阅读更多精彩内容