python实现断点调试的方法

下面我会详细讲解python实现断点调试方法的完整攻略。

什么是断点调试

在编写程序时，我们常常需要查看程序的执行情况，以便找出代码的错误。调试是一个解决这个问题的方法。其中一种调试方法是断点调试。

断点调试是指程序在执行到设定的断点时会停止，我们可以在停止状态下进行各种调试操作，比如查看变量的值，单步执行程序，等等。

如何在Python中实现断点调试

在Python中，我们可以通过在代码中插入pdb调试模块的方法来实现断点调试。

具体步骤如下：

1. 导入pdb模块

在Python中需要先导入pdb模块，输入以下代码：

import pdb

2. 在代码中设置断点

在程序中，我们可以在需要调试的地方使用pdb.set_trace()函数，即可设置断点。例如：

import pdb

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

print(func(4))

上面的代码展示了一个简单的函数，pdb在函数内设置了断点。当程序执行到pdb.set_trace()时就会停止，等待用户输入调试命令。

3. 使用pdb调试器

当程序执行到设定的断点时，程序会停止，pdb会以调试器的形式出现。我们可以在这个调试器中进行各种调试操作，来查找程序的错误。

以下是一些常用的pdb调试命令：

命令	描述
h 或 help	输出所有调试命令
c 或 cont	继续执行程序
n 或 next	执行下一条语句
s 或 step	进入到函数调用里面的下一行语句
r 或 return	把控制权交给调用该函数的环境，返回到调用函数的下一条语句
q 或 quit	中止程序运行

4. 退出pdb调试器

当程序调试结束时，我们可以输入命令q来退出pdb调试器。

示例1

请看以下这个例子：

import pdb

def func(x,y):
    pdb.set_trace()
    z = x * y
    return z

print(func(2,3))

运行以上代码，会看到输出如下：

> [file_name].py(4)func()
      2 def func(x,y):
      3     pdb.set_trace()
----> 4     z = x * y
      5     return z

(Pdb) 

可以看到，我们已经停在了pdb.set_trace()处，接下来可以使用各种 pdb 调试命令来查看值或者操作等等。

示例2

让我们接着看一个更真实的例子，来感受Python中断点调试的魅力。

import pdb

def get_max_num(nums):
    max_num = nums[0]
    pdb.set_trace()
    for i in range(len(nums)):
        if nums[i] > max_num:
            max_num = nums[i]
    return max_num

nums = [5,9,4,7,0,11,3,1]
print(get_max_num(nums))

这个例子请我们求出给定列表中的最大值。我们在函数体中设定了断点，并在接下来的循环中，打开pdb调试器解决了程序发生的bug。

在pdb调试器中，我们首先可以使用n命令执行下一条语句。在经过一些浏览后，我们可以发现代码在执行if nums[i] > max_num的时候产生了错误，代码没有取到最大值。

我们再使用ll命令查看这个地方的变量值：

(Pdb) ll
      6         pdb.set_trace()
      7         for i in range(len(nums)):
      8             if nums[i] > max_num:
      9  ->             max_num = nums[i]
     10         return max_num

其中变量max_num被初始化为了nums的第一个值。但是我们根据示例得知答案为11，而我们的预料中却不是这个结果。所以我们可以查看一下变量max_num的值：

(Pdb) p max_num
5

这里可以看到max_num的值是5，而不是11。通过仔细寻找，我们发现在运行到这里时，max_num已经变成了4，而不是5，最大值没有被正确计算。

于是我们可以更正代码如下：

import pdb

def get_max_num(nums):
    max_num = nums[0]
    pdb.set_trace()
    for i in range(len(nums)):
        if nums[i] > max_num:
            max_num = nums[i]
    return max_num

nums = [5,9,4,7,0,11,3,1]
print(get_max_num(nums))

最终答案出现在了pdb命令行之上：11。表示我们更正的代码正确无误，我们可以退出pdb调试器，程序也正常的输出了答案。