`pdb` 调试器高级：条件断点、命令脚本与运行时修改

好的，各位观众老爷，欢迎来到今天的“pdb调试器高级玩法：让bug无处遁形”讲座！ 我是你们的老朋友，bug终结者，今天咱们不聊虚的，直接上干货，教大家如何把pdb这个看似平平无奇的调试器，玩出花来，让它成为你代码世界的福尔摩斯。

第一部分：条件断点，让调试更精准

首先，我们来聊聊条件断点。 啥是条件断点？ 简单来说，就是让断点只在你设定的条件下才会触发。 想象一下，你的代码在一个循环里跑啊跑，某个变量的值在第100次循环的时候才会出错，难道你要手动按100次n（next）才能找到问题所在？ 太浪费时间了！ 条件断点就是解决这个问题的神器。

1. 简单条件断点

假设我们有以下代码：

def calculate_average(numbers):
    total = 0
    for i, num in enumerate(numbers):
        total += num
        average = total / (i + 1)
        print(f"Iteration {i+1}: Current average = {average}")
    return average

data = [1, 2, 3, 4, 5, 0, 7, 8, 9, 10]
result = calculate_average(data)
print(f"Final average: {result}")

现在，我们想在average小于1的时候才进入断点。 怎么做呢？

import pdb

def calculate_average(numbers):
    total = 0
    for i, num in enumerate(numbers):
        total += num
        average = total / (i + 1)
        print(f"Iteration {i+1}: Current average = {average}")
        pdb.set_trace() if average < 1 else None  # 条件断点
    return average

data = [1, 2, 3, 4, 5, 0, 7, 8, 9, 10]
result = calculate_average(data)
print(f"Final average: {result}")

这段代码里，我们加了一行 pdb.set_trace() if average < 1 else None。 这就是条件断点！ 只有当average < 1的时候，才会触发pdb调试器。 否则，啥事儿也不会发生，代码继续跑。

2. 使用break命令设置条件断点

除了在代码里直接插入条件判断，我们还可以用pdb的break命令来设置条件断点。 这种方法更灵活，不用修改源代码。

首先，运行你的代码，在想要设置断点的地方停下来（比如手动插入一个pdb.set_trace()）。

然后，在pdb的控制台里输入：

(Pdb) break <filename>:<lineno>, <condition>

• <filename>: 你的文件名（比如my_script.py）。
• <lineno>: 你想要设置断点的行号。
• <condition>: 你的条件表达式。

比如，对于上面的代码，我们可以这样设置条件断点：

(Pdb) break your_file_name.py:7, average < 1

这样，只有当your_file_name.py的第7行，并且average < 1的时候，断点才会触发。

3. 条件断点的应用场景

条件断点在以下场景特别有用：

• 循环中的特定迭代: 只在循环的第N次迭代时进入断点。
• 特定变量值: 当某个变量的值满足特定条件时进入断点。
• 异常处理: 只在特定类型的异常发生时进入断点。

举个例子，假设你只想在i等于5的时候进入断点：

(Pdb) break your_file_name.py:5, i == 5

或者，你想在num是0的时候进入断点：

(Pdb) break your_file_name.py:5, num == 0

第二部分：命令脚本，让调试自动化

光有条件断点还不够，有时候我们希望断点触发后，自动执行一系列的命令，比如打印一些变量的值，或者执行一些计算。 这时候，命令脚本就派上用场了。

1. 什么是命令脚本？

命令脚本就是一个包含一系列pdb命令的文件。 当断点触发时，pdb会自动执行这些命令。 这可以大大提高调试效率，避免重复输入命令。

2. 创建命令脚本

创建一个文本文件，比如my_commands.txt，然后在里面写入你想要执行的pdb命令，每行一个命令。

例如，我们想在断点触发时，打印i，num，和average的值，可以这样写my_commands.txt：

p i
p num
p average
continue

• p i: 打印i的值。
• p num: 打印num的值。
• p average: 打印average的值。
• continue: 继续执行代码。 注意，一定要加上continue，否则pdb会停留在断点处，等待你手动输入命令。

3. 使用命令脚本

有两种方式可以使用命令脚本：

• 在.pdbrc文件中指定: .pdbrc文件是pdb的配置文件，每次启动pdb时都会自动加载。 你可以在.pdbrc文件中使用alias命令来定义一个别名，然后用这个别名来执行命令脚本。

  首先，在你的用户目录下（通常是~），创建一个名为.pdbrc的文件（如果不存在）。 然后，在.pdbrc文件中添加以下内容：

  alias my_debug_commands source my_commands.txt

  • alias: 定义一个别名。
  • my_debug_commands: 你定义的别名。
  • source my_commands.txt: 指定要执行的命令脚本文件。

  然后，重启你的pdb调试会话。 当断点触发时，你可以输入my_debug_commands来执行命令脚本。

• 使用commands命令: 在pdb控制台中，使用commands命令来为特定的断点指定命令。

  首先，在想要设置断点的地方停下来。 然后，输入以下命令：

  (Pdb) commands <breakpoint_number>

  • <breakpoint_number>: 断点的编号。 你可以用break命令设置断点时看到断点编号，或者用info breakpoints命令查看所有断点及其编号。

  然后，pdb会提示你输入命令，每行一个命令。 输入完成后，输入end来结束命令输入。

  例如：

  (Pdb) break your_file_name.py:7
  Breakpoint 1 at your_file_name.py:7
  (Pdb) commands 1
  (com) p i
  (com) p num
  (com) p average
  (com) continue
  (com) end
  (Pdb)

  这样，每次断点1触发时，都会自动执行p i，p num，p average，和continue命令。

4. 命令脚本的应用场景

命令脚本在以下场景特别有用：

• 重复的调试任务: 如果你需要反复查看相同的变量，可以使用命令脚本来自动化这个过程。
• 复杂的调试逻辑: 如果你的调试逻辑比较复杂，可以使用命令脚本来组织和管理你的调试命令。
• 团队协作: 你可以将命令脚本分享给团队成员，让他们更容易地复现和调试问题。

第三部分：运行时修改，让调试更强大

pdb不仅可以让你查看代码的状态，还可以让你在运行时修改代码！ 这简直是黑魔法！ 但是，请谨慎使用，因为乱改代码可能会导致意想不到的问题。

1. 修改变量的值

在pdb控制台中，你可以使用p命令查看变量的值，使用!命令来修改变量的值。

例如：

import pdb

def my_function(x):
    y = x * 2
    pdb.set_trace()
    z = y + 1
    return z

result = my_function(5)
print(result)

在pdb控制台中：

(Pdb) p x
5
(Pdb) p y
10
(Pdb) !x = 10  # 修改x的值
(Pdb) p x
10
(Pdb) p y
10   #注意：y的值并没有改变，因为y = x * 2 这行代码已经执行过了
(Pdb) n
-> z = y + 1
(Pdb) p z
11 #z的值是 10 + 1 = 11
(Pdb) c
11

在这个例子中，我们使用!x = 10命令将x的值修改为10。 *注意，y的值并没有因为x的改变而改变，因为`y = x 2`这行代码已经执行过了。 运行时修改只会影响后续的代码执行。**

2. 执行任意代码

pdb不仅可以修改变量的值，还可以执行任意的Python代码。 这意味着你可以在运行时动态地修改程序的行为。

例如：

import pdb

def my_function(x):
    y = x * 2
    pdb.set_trace()
    z = y + 1
    return z

result = my_function(5)
print(result)

在pdb控制台中：

(Pdb) p y
10
(Pdb) !y = x * 3  # 执行任意代码
(Pdb) p y
30 #y的值变成了 5 * 3 = 15
(Pdb) n
-> z = y + 1
(Pdb) p z
31 #z的值变成了 30 + 1 = 31
(Pdb) c
31

在这个例子中，我们使用!y = x * 3命令来重新计算y的值。

3. 运行时修改的应用场景

运行时修改在以下场景特别有用：

• 修复bug: 你可以通过修改变量的值或者执行代码来临时修复bug，然后继续执行程序，看看是否解决了问题。 这比重新启动程序要快得多。
• 模拟不同的场景: 你可以通过修改变量的值来模拟不同的场景，测试程序的行为。
• 探索代码: 你可以通过执行代码来探索代码的行为，更好地理解代码的逻辑。

4. 警告

运行时修改是一个强大的工具，但也需要谨慎使用。 乱改代码可能会导致意想不到的问题，甚至崩溃。 在使用运行时修改之前，一定要仔细思考，确保你知道自己在做什么。 最好先备份你的代码，以防万一。

第四部分：实战案例：调试一个复杂的函数

咱们来个实战演练，调试一个稍微复杂一点的函数，把前面讲的知识点都用上。

假设我们有以下代码，用于计算阶乘：

def factorial(n):
    if n == 0:
        return 1
    else:
        result = n * factorial(n - 1)
        return result

number = 5
result = factorial(number)
print(f"The factorial of {number} is {result}")

这段代码看起来很简单，但是如果n很大，可能会导致栈溢出。 我们来调试一下，看看怎么发现这个问题。

1. 设置条件断点

我们可以在factorial函数的开头设置一个条件断点，只有当n小于0的时候才进入断点。 这可以帮助我们发现递归调用是否出现了问题。

import pdb

def factorial(n):
    pdb.set_trace() if n < 0 else None
    if n == 0:
        return 1
    else:
        result = n * factorial(n - 1)
        return result

number = 5
result = factorial(number)
print(f"The factorial of {number} is {result}")

运行代码，你会发现，并没有进入断点，因为n一直是正数。

2. 使用命令脚本

我们可以在factorial函数的开头设置一个断点，然后使用命令脚本来打印n的值，看看递归调用是否正常。

首先，创建一个名为factorial_commands.txt的文件，内容如下：

p n
continue

然后，修改代码，在factorial函数的开头设置一个断点：

import pdb

def factorial(n):
    pdb.set_trace()
    if n == 0:
        return 1
    else:
        result = n * factorial(n - 1)
        return result

number = 5
result = factorial(number)
print(f"The factorial of {number} is {result}")

运行代码，进入pdb控制台，然后输入commands命令：

(Pdb) break your_file_name.py:4
Breakpoint 1 at your_file_name.py:4
(Pdb) commands 1
(com) source factorial_commands.txt
(com) end
(Pdb) c

你会看到，pdb会不断地打印n的值，直到递归调用结束。 这可以帮助你了解递归调用的过程。

3. 运行时修改

如果我们在递归调用过程中，发现n的值不对，可以使用运行时修改来修改n的值，看看是否能解决问题。

例如，我们可以在factorial函数的开头设置一个断点，然后使用运行时修改来将n的值设置为0，看看会发生什么。

import pdb

def factorial(n):
    pdb.set_trace()
    if n == 0:
        return 1
    else:
        result = n * factorial(n - 1)
        return result

number = 5
result = factorial(number)
print(f"The factorial of {number} is {result}")

运行代码，进入pdb控制台，然后输入!n = 0命令：

(Pdb) break your_file_name.py:4
Breakpoint 1 at your_file_name.py:4
(Pdb) !n = 0
(Pdb) c
The factorial of 5 is 1

你会发现，程序正常结束，并且结果是1。 这是因为我们将n的值修改为0，导致factorial函数直接返回1。

总结

今天我们学习了pdb调试器的高级用法，包括条件断点、命令脚本和运行时修改。 这些技巧可以帮助你更有效地调试代码，更快地找到bug。 但是，请记住，调试是一个需要耐心和技巧的过程，不要指望一下子就能掌握所有的技巧。 多练习，多思考，你一定能成为一名优秀的bug终结者！

最后，送给大家一句名言：Bug is not a bug, it’s a feature in disguise! （当然，这只是个玩笑。）

感谢大家的观看，下次再见！