如何用 IDE 的 Debug 功能排查程序错误？

小象实战讲义 · Python 编程从入门到实践

在编写 Python 程序时，代码的实际运行结果有时会与预期不符。当遇到这种情况，我们需要一种方法来定位问题所在。本节将介绍如何使用集成开发环境（IDE）的 Debug（调试）功能，通过设置断点、单步执行和观察变量来排查代码中的逻辑错误。这是继学习控制流和数据结构后，提升代码排查能力的重要实践技能。

💡 核心导读

• Debug 是什么：一种通过控制程序执行流程、观察运行状态来定位错误的方法。
• 断点的作用：让程序在指定位置暂停，以便检查当时的变量值和执行路径。
• 条件断点：当满足特定条件（如某个变量等于特定值）时，程序才会在断点处暂停。
• 单步执行与变量观察：在程序暂停后，可以逐行执行代码，并实时查看变量值的变化。
• Debug 的基本流程：设置断点 → 启动调试 → 触发暂停 → 观察分析 → 修复问题。

Debug 的基本概念与流程

当程序运行结果不符合预期时，我们通常需要检查代码在执行过程中是否按我们设想的逻辑运行。Debug（调试）就是帮助我们完成这个检查的工具。

在 IDE 中进行 Debug 的核心是 设置断点（Breakpoint）。断点是代码中的一个标记，程序运行到此处时会自动暂停，等待开发者检查。

一个典型的 Debug 流程包含以下几步：

1. 设置断点：在怀疑有问题的代码行左侧双击（或在相应菜单中操作），通常会显示一个红点。
2. 启动调试：在 IDE 中选择“Debug”或“调试”模式运行程序，而不是普通的“Run”。
3. 程序暂停：当程序执行到断点所在行时，会自动暂停，此时该行代码尚未执行。
4. 观察与分析：在程序暂停的状态下，你可以：
   • 查看所有变量的当前值。
   • 使用“单步执行”（Step）按钮，让程序一次只执行一行代码，观察执行流程。
   • 检查控制台输出，判断程序逻辑。
5. 发现问题并修复：通过对比观察到的变量值和预期值，定位逻辑错误，然后修改代码。

一个 Debug 实战：排查杨辉三角程序错误

我们通过一个具体的例子来演示 Debug 过程。以下是一个绘制杨辉三角的程序，但在高度为 4 时，最后一行输出错误（正确应为 1 3 3 1，程序输出为 1 2 4 1）。

# 有错误的杨辉三角生成程序（用于演示Debug）
n = 4  # 原程序使用 input() 输入三角形高度，此处为演示固定为4
print("高度为 {} 的杨辉三角（当前有错误）：".format(n))

layer = 1
values = [1]  # 存储当前行的值

while layer <= n:
    # 打印当前行
    for num in values:
        print(num, end=' ')
    print()

    # 计算下一行
    next_values = [1]  # 下一行第一个元素总是1
    index = 0
    while index < len(values) - 1:
        # 计算下一行中间的元素：应为当前行相邻两元素之和
        next_element = values[index] + values[index]  # 这里有错误！
        next_values.append(next_element)
        index += 1
    next_values.append(1)  # 下一行最后一个元素总是1

    # 为下一轮循环准备
    values = next_values
    layer += 1

高度为 4 的杨辉三角（当前有错误）：
1 
1 1 
1 2 1 
1 2 4 1 

可以看到，第四行输出是 1 2 4 1，这显然不是杨辉三角（第四行应为 1 3 3 1）。问题出在计算下一行元素的逻辑上。

设置并利用条件断点

我们怀疑问题出现在计算第三行（layer = 3）并推导第四行数值的时候。我们可以在外层 while 循环开始处设置一个条件断点，让它只在 layer == 3 时暂停。

在 Spyder 中的操作通常如下：

1. 在代码行 while layer <= n: 左侧双击，设置一个普通断点（红点）。
2. 在 Debug 菜单中找到“断点列表”或类似功能。
3. 找到该断点，并设置条件（Condition）为 layer == 3。
4. 以 Debug 模式运行程序。

程序会在准备开始绘制第三行时暂停。此时，我们可以打开“变量查看器”（Variable Explorer）看到当前 layer 的值为 3，values 是 [1, 2, 1]（即第三行的正确值）。

单步执行与观察变量

程序暂停后，我们使用“单步执行”（Step Into/Over）功能，逐行运行代码。

1. 第一次单步，会进入 while layer <= n: 循环体。
2. 继续单步，会执行打印当前行（第三行）的循环，控制台输出 1 2 1。
3. 关键步骤：当执行到计算 next_element 的行时，观察右侧变量或表达式求值窗口。
   • 此时 index 为 0。
   • values[index] 是 1。
   • 错误的代码是 values[index] + values[index]，结果计算为 1 + 1 = 2。
   • 而正确的逻辑应该是 values[index] + values[index + 1]，即 1 + 2 = 3。

通过单步执行和观察，我们精准地定位了错误：在计算下一行元素时，错误地将同一个元素相加，而不是相邻的两个元素相加。

修复错误并验证

找到错误后，停止 Debug 进程，修改代码：

# 错误代码：
next_element = values[index] + values[index]  # 这里有错误！

# 正确代码：
next_element = values[index] + values[index + 1]  # 应取相邻两元素之和

修改后，重新运行程序：

# 修复错误后的杨辉三角生成程序
n = 4
print("高度为 {} 的杨辉三角（已修复）：".format(n))

layer = 1
values = [1]

while layer <= n:
    for num in values:
        print(num, end=' ')
    print()

    next_values = [1]
    index = 0
    while index < len(values) - 1:  # 保证 index+1 不越界
        next_element = values[index] + values[index + 1]  # 已修复
        next_values.append(next_element)
        index += 1
    next_values.append(1)

    values = next_values
    layer += 1

高度为 4 的杨辉三角（已修复）：
1 
1 1 
1 2 1 
1 3 3 1 

程序输出了正确的结果。修复时只改了 next_element 的计算：把 values[index] + values[index] 改成 values[index] + values[index + 1]，取当前行相邻的两个元素相加。

📝 动手练一练

1. 把本节修复后的杨辉三角程序复制到 IDE：在 next_values.append(next_element) 这一行设置断点，以 Debug 模式运行；当 layer == 3 时逐行单步执行，观察 values 和 next_element 的变化，并回答：第 4 行（1 3 3 1）的中间两个 3 分别由哪两个数相加得到？

常见错误

小结

1. Debug 是定位和修复代码逻辑错误的核心技能，通过控制执行流程和观察程序状态来实现。
2. 断点是 Debug 的基石，程序执行到断点处会暂停。条件断点可以只在特定场景下触发，提高调试效率。
3. 程序暂停后，利用单步执行可以精确控制代码运行，结合变量查看器可以实时观察数据变化，从而判断逻辑是否正确。
4. Debug 的一般流程是：复现问题 → 根据逻辑推测可疑代码段 → 设置断点（尤其是条件断点） → 启动调试 → 单步执行并观察 → 定位问题 → 修复代码 → 重新验证。
5. 发现并修复问题后，需要停止当前调试会话，再重新运行程序以验证修复是否成功。

📋 行动清单

• 在 IDE 中打开一个已有的 Python 文件，尝试在任意一行设置一个普通断点，并分别用“Run”和“Debug”模式运行，观察区别。
• 找一个包含循环的小程序，在循环体内设置一个条件断点（例如 i == 5），启动调试并观察程序是否在满足条件时才暂停。
• 使用单步执行功能，逐行运行一个简单的函数，同时在变量窗口中观察主要变量的值是如何随着每一行代码的执行而变化的。

—— 小象教研组