好的，我们开始今天的讲座，主题是 Python 调试，重点介绍 pdb、ipdb 和 PyCharm 的调试技巧。调试是软件开发中不可或缺的一部分，掌握高效的调试方法能够显著提高开发效率，降低维护成本。
一、调试的重要性
在编写代码的过程中，bug 是不可避免的。调试的目的就是找到并修复这些 bug。一个好的调试器可以帮助我们：
- 理解代码执行流程： 逐步执行代码，观察变量的变化，更好地理解程序的运行机制。
- 定位错误： 快速找到错误发生的具体位置。
- 验证假设： 验证代码是否按照预期工作。
二、Python 内置调试器 pdb
pdb 是 Python 自带的调试器，无需额外安装即可使用。它提供了一组基本的调试命令，可以满足简单的调试需求。
1. 启动 pdb 的方法
-
直接在代码中插入断点：
import pdb def my_function(x, y): pdb.set_trace() # 设置断点 result = x + y return result my_function(1, 2)运行这段代码，程序会在
pdb.set_trace()处暂停，进入pdb调试模式。 -
从命令行启动：
python -m pdb my_script.py这会启动
pdb并加载my_script.py文件。程序会在文件开头暂停。 -
捕获异常后进入调试模式：
import pdb def my_function(x, y): try: result = x / y return result except ZeroDivisionError: pdb.post_mortem() # 捕获异常后进入调试模式 return None my_function(1, 0)pdb.post_mortem()会在异常发生后启动pdb，你可以查看异常发生时的堆栈信息。
2. pdb 常用命令
| 命令 | 描述 |
|---|---|
help |
显示帮助信息。可以输入 help command 来查看特定命令的帮助。 |
p expression |
打印表达式的值。例如，p x 会打印变量 x 的值。 |
pp expression |
使用 pprint 模块打印表达式的值，格式更美观。 |
n |
执行下一行代码（next）。如果当前行是一个函数调用，n 会执行完整个函数，然后停在函数返回后的下一行。 |
s |
进入函数调用（step）。如果当前行是一个函数调用，s 会进入该函数内部。 |
c |
继续执行，直到遇到下一个断点或程序结束（continue）。 |
b line_number |
在指定行号设置断点（break）。例如，b 10 会在第 10 行设置断点。 |
b function_name |
在指定函数入口设置断点。例如，b my_function 会在 my_function 函数入口设置断点。 |
cl line_number |
清除指定行号的断点（clear）。例如，cl 10 会清除第 10 行的断点。 |
cl |
清除所有断点。 |
disable line_number |
禁用指定行号的断点。 |
enable line_number |
启用指定行号的断点。 |
l |
显示当前代码段（list）。 |
a |
显示当前函数的参数列表（arguments）。 |
q |
退出调试器（quit）。 |
r |
继续执行，直到函数返回（return）。 |
bt |
显示当前堆栈信息（backtrace）。 |
w |
显示当前代码段的上下文（where）。 |
alias name command |
创建一个命令别名。例如，alias ps p self 创建了一个别名 ps，执行 ps 相当于执行 p self。 |
unalias name |
删除一个命令别名。 |
condition breakpoint condition |
为断点添加条件。例如，condition 10 x > 5 表示只有当 x > 5 时，第 10 行的断点才会被触发。 |
ignore breakpoint count |
忽略断点 count 次。例如，ignore 1 10 表示忽略第一个断点 10 次。 |
3. pdb 示例
import pdb
def factorial(n):
pdb.set_trace()
if n == 0:
return 1
else:
return n * factorial(n-1)
print(factorial(5))运行这段代码，程序会在 pdb.set_trace() 处暂停。你可以使用 n 命令单步执行，使用 p n 查看变量 n 的值，使用 bt 查看堆栈信息，使用 c 继续执行直到程序结束。
三、增强型调试器 ipdb
ipdb 是一个基于 IPython 的调试器，它提供了比 pdb 更强大的功能，例如：
- 代码自动补全： 在调试模式下，可以使用 Tab 键进行代码自动补全。
- 语法高亮： 代码显示更加清晰易读。
- 更强大的表达式求值： 可以使用 IPython 的所有功能，例如 magic commands。
1. 安装 ipdb
pip install ipdb2. 使用 ipdb
ipdb 的使用方法与 pdb 类似，只需将 import pdb 替换为 import ipdb 即可。
import ipdb
def my_function(x, y):
ipdb.set_trace() # 设置断点
result = x + y
return result
my_function(1, 2)3. ipdb 的优势
- 更好的交互体验： IPython 提供了更友好的交互界面，调试过程更加高效。
- 更强大的功能： 可以使用 IPython 的所有功能，例如
%timeit测量代码执行时间，%debug在异常发生后进入调试模式。 - 更易于定制： 可以通过配置文件定制
ipdb的行为。
四、PyCharm 调试技巧
PyCharm 是一款强大的 Python IDE，它集成了功能完善的调试器，提供了图形化的调试界面，使得调试过程更加直观和便捷。
1. 设置断点
在 PyCharm 中，只需在代码行号旁边的空白区域单击，即可设置断点。断点会以红色圆圈表示。
2. 启动调试
- 点击 Run -> Debug ‘your_script’ (或者使用快捷键，通常是
Shift + F9)
3. 调试界面
PyCharm 的调试界面通常分为以下几个区域：
- 代码编辑区： 显示代码，断点会以红色圆圈表示。
- 调试工具窗口： 包含以下选项卡：
- Debugger： 显示当前线程的堆栈信息，变量的值，以及调试控制按钮。
- Console： 显示程序的输出。
- Variables： 显示当前作用域内的变量及其值。 可以在此处修改变量的值。
- Watches： 允许你添加表达式，在调试过程中观察其值。
- Threads: 显示所有线程的状态，方便多线程调试。
- 调试控制按钮： 包含以下按钮：
- Step Over (F8): 执行下一行代码。如果当前行是一个函数调用，会执行完整个函数，然后停在函数返回后的下一行。
- Step Into (F7): 进入函数调用。如果当前行是一个函数调用，会进入该函数内部。
- Step Out (Shift + F8): 跳出当前函数。
- Run to Cursor (Ctrl + F9): 执行到光标所在行。
- Resume Program (F9): 继续执行，直到遇到下一个断点或程序结束。
- Pause Program: 暂停程序执行。
- Stop (Ctrl + F2): 停止调试。
- View Breakpoints (Ctrl + Shift + F8): 查看和管理断点。
- Evaluate Expression: 允许你输入 Python 表达式，并立即求值。
4. PyCharm 调试技巧
- 条件断点： 在断点上右键单击，选择 "Edit Breakpoint"，可以设置断点条件。只有当条件满足时，断点才会被触发。
- 异常断点： 在 "View Breakpoints" 窗口中，可以添加异常断点。当程序抛出指定的异常时，调试器会自动暂停。
- 远程调试： PyCharm 支持远程调试，可以在本地调试远程服务器上的代码。
- Attach to Process: 可以将调试器附加到正在运行的 Python 进程。
- Evaluate Expression: 在调试过程中，可以使用 "Evaluate Expression" 功能来计算表达式的值，或者执行一些简单的代码片段。 这对于理解代码的运行状态非常有帮助。
- Watches: 监视变量的值，在调试过程中，可以通过 "Watches" 窗口来监视变量的值。 这样可以方便地观察变量的变化，从而更好地理解程序的运行状态。可以通过右键单击变量，选择 "Add to Watches" 来添加变量。
- Frame 的切换: 在 Debugger 窗口的 Frames 面板中，可以切换不同的函数调用栈帧。这可以让你在不同的函数之间跳转，从而更好地理解代码的执行流程。
5. PyCharm 调试示例
def calculate_sum(numbers):
total = 0
for number in numbers:
total += number
return total
def main():
data = [1, 2, 3, 4, 5]
result = calculate_sum(data)
print(f"The sum is: {result}")
if __name__ == "__main__":
main()在 calculate_sum 函数的 total += number 行设置断点，然后启动调试。你可以使用 "Step Over" 按钮单步执行，使用 "Variables" 窗口查看变量 total 和 number 的值，使用 "Resume Program" 按钮继续执行直到程序结束。
五、选择合适的调试工具
| 工具 | 优点 | 缺点 | 适用场景 |
|---|---|---|---|
pdb |
Python 自带，无需额外安装；简单易用。 | 功能相对简单，交互体验较差。 | 快速调试小型脚本，或者在没有 IDE 的情况下进行调试。 |
ipdb |
基于 IPython，提供代码自动补全、语法高亮等功能；交互体验更好；可以使用 IPython 的所有功能。 | 需要额外安装。 | 需要更强大的交互功能，或者需要使用 IPython 的功能进行调试。 |
| PyCharm | 功能完善，提供图形化的调试界面；支持条件断点、异常断点、远程调试等高级功能。 | 需要购买 license（社区版免费，但功能有限）；资源占用较多。 | 大型项目，需要使用高级调试功能，或者需要图形化的调试界面。 |
六、调试的最佳实践
- 理解代码逻辑： 在调试之前，先仔细阅读代码，理解代码的逻辑，可以帮助你更快地找到错误。
- 编写单元测试： 单元测试可以帮助你尽早发现 bug，并确保代码的正确性。
- 使用日志： 在关键代码处添加日志，可以帮助你了解程序的运行状态。
- 逐步调试： 不要试图一次性解决所有问题，逐步调试，每次只关注一个问题。
- 善用搜索引擎： 遇到问题时，善用搜索引擎，可以找到很多有用的资料。
- 提问的智慧： 在向他人提问时，尽量提供足够的信息，例如代码、错误信息、调试步骤等，可以帮助他人更快地理解你的问题。
七、掌握调试方法，提升开发效率
掌握 pdb、ipdb 和 PyCharm 的调试技巧，可以帮助你更高效地调试 Python 代码，降低开发成本，提高代码质量。选择合适的调试工具，结合最佳实践，可以让你成为一名优秀的 Python 开发者。
八、熟练运用各种工具，让调试过程更加高效
今天我们讨论了 Python 的几种主要调试工具，从内置的 pdb 到增强的 ipdb，再到功能强大的 PyCharm 调试器。 掌握这些工具的使用方法，并结合一些调试的最佳实践，能够显著提高我们的开发效率，使我们能更轻松地解决代码中的问题。