如何在 Python 中使用 Spyder 进行高效调试？
Posted
技术标签:
【中文标题】如何在 Python 中使用 Spyder 进行高效调试？【英文标题】：How do I debug efficiently with Spyder in Python? 【发布时间】：2015-04-01 13:12:59 【问题描述】：我喜欢 Python，也喜欢 Spyder，但我发现使用 Spyder 进行调试很糟糕！
每次放一个断点，我需要按两个按钮：第一个 调试然后继续按钮（它在第一行暂停 自动）这很烦人。 此外，我有一个糟糕的 ipdb>> 控制台，而不是具有自动完成功能的标准 iPython 控制台。 最糟糕的是，即使我写打印或简单的评估来试图找出错误是什么，这个控制台也经常死机。这比 MATLAB 差很多。 最后但同样重要的是，如果我从 ipdb>> 控制台，并在其中放置一个断点，它不会停在那里。 似乎我必须在开始之前将断点放在那里 调试 (Ctrl+F5)。您有解决方案吗，或者您能告诉我您是如何调试 Python 脚本和函数的吗？
我在 Windows 8.1 64 位上使用全新安装的 Anaconda。
【问题讨论】：
与复杂的调试无关，但我经常需要在脚本中间停下来使用特定的变量集在控制台中进行进一步的开发。我通常只是暂时输入sys.exit()，但如果我有断点选项会更方便。
【参考方案1】：
(这里是 Spyder 维护者) 在我们 2020 年 11 月发布的 4.2.0 版本之后，在 Spyder 中的调试体验相当不错。我们现在提供的是来自 Matlab 的人们对调试器的期望，即像 IPython 一样工作的东西，可以让您在当前断点或帧处检查和绘制变量。
现在谈谈你的观点：
如果您尝试调试的文件中存在断点，则 Spyder 将进入调试模式并继续运行，直到遇到第一个断点。如果它存在于另一个文件中，那么您仍然需要先按Debug，然后再按Continue。
IPdb 是 IPython 调试器控制台。在 Spyder 4.2.0 或更高版本中，它带有代码完成、语法突出显示、使用向上/向下箭头的命令历史浏览（与 IPython 历史不同）、代码的多行评估，以及使用 Matplotlib 的内联和交互式绘图。
现在已修复。此外，为了避免 Python 代码和 Pdb 命令之间的冲突，如果（例如）有一个名为 n 的变量并在提示符中写入 n 以查看其值，我们将显示它而不是运行 n Pdb命令。要改为运行该命令，您必须在其前面加上一个感叹号，如下所示：!n
这也是固定的。您可以在IPdb 中设置断点，它们将在您当前的会话中被考虑在内。
【讨论】：
我想指出另一个我认为很重要的功能。目前，只能通过“调试文件”进行调试，该文件在单独的会话中从头到尾运行文件，忘记了我可能在控制台中定义的所有变量。能够在传递我工作区中已经定义的变量的同时开始调试特定函数会很棒（重新计算有时会很昂贵） @neuronet，这已经可以工作了，但前提是您按下调试按钮（即蓝色播放/暂停按钮）。 @CarlosCordoba 我的意思是类似于 Matlab 的东西。我在第 10 行的函数 x 中放置了一个断点。当我运行我的代码时，我最终进入了该函数的工作区，能够查看定义了哪些变量等等。我只是尝试了一下，没有得到类似的东西（Spyder 3.3.1)。我使用了按钮。也就是说，Spyder 3.3.1 很棒：比 3.2 有了巨大的改进。对于调试，我只使用 python 的logging 模块和%debug，并忽略 Spyder 断点，它们从不做我想让他们做的事情。 :(
@neuronet，请打开一个issue 以更好地了解您的情况。
@CarlosCordoba 好的，我会花时间尽量不做任何愚蠢的事情。 :)【参考方案2】：
关于第 3 点的一点补充：
在我看来，调试控制台经常冻结，进行打印、评估等，但按下停止（退出调试）按钮通常会将其返回到调用堆栈的底部，然后我可以返回 (' u') 到我正在调试的框架。值得一试。这可能适用于更高版本的 Spyder (2.3.5.2)
【讨论】：
【参考方案3】：这是我在 Spyder 中调试以避免冻结 IDE 的方法。如果我在调试模式下更改脚本，我会这样做。
-
我关闭了当前的 IPython（调试）控制台 [x]
打开一个新的[菜单栏->控制台->打开一个IPython控制台]
再次进入调试模式[蓝色播放暂停按钮]。
仍然有点烦人，但它具有清除（重置）变量列表的额外好处。
【讨论】：
【参考方案4】：pdb 调试器与常规 python 一起工作得很好。所以在 Spyder 中，只要我想交互式调试，我就切换到 python 控制台。
import pdb
def yourfunction():
# Interesting stuff done here
pdb.set_trace()
使用 pdb https://pythonconquerstheuniverse.wordpress.com/category/python-debugger/ 进行调试的精彩介绍
【讨论】：
不幸的是：NOTE: The Python console is going to be REMOVED in Spyder 3.2. Please start to migrate your work to the IPython console instead.【参考方案5】：
调试工作流程
您必须了解，实际上您正在使用Python debugger pdb 和ipdb 的不同集成（使用pdb 并且可以使用模块ipdb 访问）。我希望这个简单的例子能帮助你更好地使用它。
假设你想调试这段代码：
def Waiting_fun(): #1 line number one
for i in range(100): #2
pass #3
#4
def New_sum(lista, to_s = False): #5
result = 0 #6
print 1 #7
for i in lista: #8
print "summed" #9
result +=i #10
Waiting_fun() #11
if to_s: #12
result = str(result)
return result
a = New_sum([1,4,5,7,8])
b = New_sum([1,4],1)
c = 456
d = New_sum([6,8,9],1)
final_result = a*b*c*d
Out: Type error
使用 iPython %debug 进行快速首次调试
%debug
我做的第一件事是使用魔法命令%debug 从 iPython 调用 pdb，您可以使用 %pdb 将其设置为默认机制。
%debug
> /home/opdate/Desktop/test.py(23)<module>()
19 a = New_sum([1,4,5,7,8])
20 b = New_sum([1,4],1)
21 c = 456
22 d = New_sum([6,8,9],1)
---> 23 final_result = a*b*c*d
一旦你吃过午饭pdb。您可以在official docs 中找到所有命令，也可以使用命令h 显示它们。在这个阶段，我使用的唯一命令是：
p ：打印您指定的变量
pp : 漂亮的照片
args: 如果你在函数内部，它会打印参数
pp locals() ：可用于打印所有变量，但大多数
时代一团糟！
! 如果您想避免与h 中列出的命令冲突，请使用它
whatis variable_name：相当于类型（variable_name）
u ：将当前帧在堆栈跟踪中上移一级（移至较旧的帧）。
d ：将当前帧在堆栈跟踪中向下移动一级（到较新的帧）。
q : 完成后可以使用 q 退出
在我们的例子中：
ipdb> pp a,b,c,d
(25, '5', 456, '23')
或ipdb> !a,b,c,d（在感叹号和第一个值之间没有空格）。
很明显 b 和 d 是字符串，以防我们可以使用：
ipdb> whatis b
<type 'str'>
使用断点更深入
70% 的时间%debug 将您指向解决方案。当您需要更多功能（例如 breakpoints）时，就该使用 Spyder。在这种情况下，我们想了解为什么b 是一个字符串，我们在它旁边放了一个断点（在编辑器窗口中双击行号旁边）。我发现更好使用标准 Python 控制台而不是 IPython 控制台进行调试，因此在开始调试之前选择控制台：
然后打开variable explorer如果有任何变量删除它们。我使用 Ctrl+F5 开始调试，您可以使用顶部的按钮，但我更喜欢使用如下所示的快捷方式：
(Pdb) c # we go to the breakpoint
(Pdb) s # we step into the function
(Pdb) args # we see what parameters are inserted
(Pdb) s # going step-by-step
(Pdb) ⏎ # series of Enters go line by line quicker
#Here I'll use whatis command but in fact I just look to
# the type in variable explorer of spyder.
(Pdb) whatis result #check if result is still int
(Pdb) unt #or until -useful to exiting from loops see doc.
(Pdb) n # we don't enter to the Waiting_fun function
(Pdb) s # going step-by-step
(Pdb) whatis result #we find that there the int is converted
(Pdb) j 6 # for double checking we jump back to 6 were the result is assigned
# We may be tempted to j(ump) to line 12 but doing so we would skip all the code
#for avoiding a series of `s`,`unt` and `n` we can use this solution:
(Pdb) tbreak 12 #set a new temporary breakpoint. Also `b` it's ok most of the time
(Pdb) c # go to it
(Pdb) j 6 # we jump to 6 the code we jump is NOT executed
(Pdb) whatis result# we find that if we jump 12-13 result is still int
现在我们找到了错误。我们还可以测试解决方案我们重复该步骤直到 12 并且我们设置 to_s = False
(Pdb) to_s = False #!to_s = False to be on the safe side
它有效。在 Python 控制台 中使用标准 pdb 的一项重要功能是，您可以进行自动竞争，并且可以使用变量资源管理器来代替 whatis 和 pp：
使用变量浏览器，您还可以更改变量的值，从而使事情变得更快。
条件断点
另一个更聪明的定位错误的方法是使用条件断点 (Shift+F12) Spyder 的一个很大的优势是调试和使用列表断点。当条件为True 时，条件断点被激活。在我们的例子中，我们想要定位b 变为字符串的位置，因此条件为：type(b) == str。我通常会放置很多条件断点，看看哪些符合条件。为此，请勿使用 Shift+F12 而是在该行旁边双击普通断点并转到 Debug->List breakpoints 并复制并粘贴条件表到每个断点如下图所示。
从这里使用的命令是：
(Pdb) c # go to the first
(Pdb) u # it helps to understand when it happened
(Pdb) d # come back to the breakpoint
【讨论】：
这是一些很好的信息。不幸的是，Spyder 不会停在我的断点处。我已经在 VSCode、PyCharm 和 PyScripter 中成功使用了断点。我希望我能弄清楚我在 Spyder 中缺少什么……这并不明显。 感谢@WesleyKitlasten，关于您的问题，您可能需要考虑在 spyder github 存储库中打开一个问题，对我来说效果很好。【参考方案6】：您可以使用调试快捷键，例如： 跨过 F10 步入 F11 在工具>首选项>键盘快捷键
【讨论】：
【参考方案7】：显然之前没有人提到过这两个：
在使用 Python 之前，我使用的是 VBA。虽然它是一种相对较旧的语言，不定期更新，但我喜欢 VBA 的一件事是调试功能。我遇到的最接近VBA或者也可以称为“可视化调试”的2个调试功能是：
1-PyCharm 调试器
This 6 分钟视频演示 PyCharm 调试器。
2-PixieDebugger - 你一直想要的 Jupyter Notebooks 的可视化 Python 调试器
由于许多编码人员倾向于使用 JupyterNotebook，所以这个调试器会派上用场。 PixieDebugger 与 PyCharm 调试器几乎相同。此处不再赘述。
不过可以参考这个link
【讨论】：
问题是关于Spyder的，你提到的调试器都不能在Spyder中使用。 我知道这一点。我只是强调了不同类型的可视化 python 调试器。不一定适用于 spyder。以上是关于如何在 Python 中使用 Spyder 进行高效调试？的主要内容，如果未能解决你的问题，请参考以下文章