Python的`调试`：如何使用`pdb`和`ipdb`进行代码调试。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

Python 代码调试利器：pdb 与 ipdb

大家好，今天我们来深入探讨 Python 代码调试的两个强大工具：pdb 和 ipdb。调试是软件开发过程中不可或缺的一环，它可以帮助我们定位并修复代码中的错误。pdb (Python Debugger) 是 Python 自带的调试器，而 ipdb 则是基于 IPython 的增强型调试器，提供了更丰富的功能和更友好的用户界面。

1. 为什么需要调试器？

在没有调试器的情况下，我们通常使用 print 语句来检查变量的值和程序的执行流程。这种方法简单直接，但当代码量增大、逻辑复杂时，效率会大大降低。调试器允许我们逐行执行代码，观察变量的变化，设置断点，甚至修改变量的值，从而更高效地定位问题。

2. pdb 的基本用法

pdb 的使用方式主要有两种：

直接在命令行启动调试器：
```
python -m pdb your_script.py
```
这将会在 your_script.py 的第一行代码处启动调试器。

在代码中插入断点：

import pdb

def my_function(x, y):
    pdb.set_trace()  # 设置断点
    result = x + y
    return result

print(my_function(2, 3))

当程序执行到 pdb.set_trace() 这一行时，会暂停执行并进入 pdb 调试环境。

3. pdb 的常用命令

进入 pdb 调试环境后，我们可以使用以下常用命令进行调试：

命令	含义
`h` 或 `help`	显示帮助信息，可以查看特定命令的用法。
`p` 或 `pp`	打印变量的值。 `p` 打印变量的字符串表示，`pp` 打印变量的更美观的表示 (pretty print)。
`n` 或 `next`	执行下一行代码。如果当前行是函数调用，则执行完整个函数。
`s` 或 `step`	执行下一行代码。如果当前行是函数调用，则进入函数内部。
`c` 或 `continue`	继续执行代码，直到遇到下一个断点或程序结束。
`q` 或 `quit`	退出调试器。
`b` 或 `break`	设置断点。可以设置在某一行代码 (`b linenumber`) 或某个函数入口 (`b function_name`)。
`cl` 或 `clear`	清除断点。可以清除所有断点 (`cl`) 或特定断点 (`cl breakpoint_number`)。断点编号可以通过 `b` 命令查看。
`l` 或 `list`	显示当前代码段。
`a` 或 `args`	打印当前函数的参数列表。
`r` 或 `return`	继续执行，直到当前函数返回。
`u` 或 `up`	在调用栈中向上移动一级。
`d` 或 `down`	在调用栈中向下移动一级。
`j` 或 `jump`	跳转到指定行号执行。
`w` 或 `where`	显示当前调用栈信息。
`disable`	禁用断点. `disable breakpoint_number`.
`enable`	启用断点. `enable breakpoint_number`.
`condition breakpoint_number condition`	给断点添加条件。当 `condition` 为真时，断点才会触发。

示例：使用 pdb 调试阶乘函数

import pdb

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

print(factorial(5))

在这个例子中，我们在 factorial 函数的入口处设置了一个断点。当我们运行这段代码时，程序会暂停在断点处，并进入 pdb 调试环境。

我们可以使用 n 命令单步执行代码，使用 p n 命令查看变量 n 的值，使用 s 命令进入递归调用，使用 c 命令继续执行直到程序结束。

4. ipdb 的优势与安装

ipdb 是基于 IPython 的调试器，它继承了 IPython 的所有优点，例如：

语法高亮： 代码更易读。
Tab 键自动补全： 快速输入命令和变量名。
历史记录： 方便重用之前的命令。
更好的表达式求值： 可以更方便地执行复杂的 Python 表达式。

要安装 ipdb，可以使用 pip：

pip install ipdb

5. ipdb 的基本用法

ipdb 的使用方式与 pdb 类似，只需将 import pdb 替换为 import ipdb 即可。

import ipdb

def my_function(x, y):
    ipdb.set_trace()  # 设置断点
    result = x + y
    return result

print(my_function(2, 3))

ipdb 的命令与 pdb 基本相同，但由于 IPython 的增强功能，一些命令的使用体验会更好。例如，p 命令的输出会更加美观，并且可以使用 Tab 键自动补全变量名。

6. 高级调试技巧

条件断点： 只有当满足特定条件时才触发的断点。例如：

import ipdb

def process_data(data):
    for i, item in enumerate(data):
        if i > 5 and item < 0:
            ipdb.set_trace()  # 当 i 大于 5 且 item 小于 0 时触发断点
        print(f"Processing item {i}: {item}")

data = [1, 2, 3, 4, 5, 6, -1, 8, 9, 10]
process_data(data)

也可以使用 condition 命令在 pdb 中设置条件断点：

(Pdb) b 7
Breakpoint 1 at test.py:7
(Pdb) condition 1 i > 5 and item < 0

事后调试 (Post-mortem Debugging)： 当程序崩溃时，自动进入调试器，方便我们分析错误原因。可以通过以下方式启用事后调试：

import pdb
import sys

def post_mortem_debugging():
    def info(type, value, tb):
        if hasattr(sys, 'ps1') or not sys.stderr.isatty():
            # we are in interactive mode or we don't have a tty-like
            # device, so we call the default hook
            sys.__excepthook__(type, value, tb)
        else:
            import traceback, pdb
            # you can call any function here to log the exception,
            # print things on stdout, etc.
            traceback.print_exception(type, value, tb)
            print
            pdb.pm()

    sys.excepthook = info

if __name__ == '__main__':
    post_mortem_debugging()
    try:
        1 / 0  # 故意引发一个错误
    except Exception as e:
        print(f"Caught exception: {e}")
        #pass #如果取消注释这一行， pdb.pm() 不会被调用。程序会正常运行到结束。

当程序抛出异常时，pdb.pm() 会启动调试器，我们可以查看调用栈，分析异常发生的原因。如果不使用 post_mortem_debugging 函数，可以在 try except 块中使用 pdb.post_mortem() 达到类似效果。

远程调试： 在远程服务器上运行的代码，可以通过远程调试的方式进行调试。这需要使用专门的远程调试工具，例如 pydevd。

使用 .pdbrc 文件自定义调试环境： 可以在用户目录下创建一个 .pdbrc 文件，用于配置 pdb 的行为。例如，可以设置自动补全、语法高亮等。

# ~/.pdbrc
import rlcompleter, readline
readline.parse_and_bind('tab: complete')

try:
    from pygments import highlight
    from pygments.lexers import PythonLexer
    from pygments.formatters import Terminal256Formatter

    def my_print(text):
        print(highlight(text, PythonLexer(), Terminal256Formatter()), end='')

    import pdb
    pdb.Pdb.print = my_print
except ImportError:
    pass

这个 .pdbrc 文件配置了 Tab 键自动补全，并使用 pygments 库实现语法高亮。

7. 实际案例分析：调试一个简单的 Web 应用

假设我们有一个简单的 Flask Web 应用，用于计算两个数的和：

from flask import Flask, request

app = Flask(__name__)

@app.route('/add')
def add():
    a = request.args.get('a', type=int)
    b = request.args.get('b', type=int)
    result = a + b
    return str(result)

if __name__ == '__main__':
    app.run(debug=True)

如果在运行这个应用时，我们发现当传入的参数不是整数时，程序会报错。我们可以使用 ipdb 来调试这个问题：

在 add 函数中设置一个断点：

from flask import Flask, request
import ipdb

app = Flask(__name__)

@app.route('/add')
def add():
    ipdb.set_trace()
    a = request.args.get('a', type=int)
    b = request.args.get('b', type=int)
    result = a + b
    return str(result)

if __name__ == '__main__':
    app.run(debug=True)

启动应用。
在浏览器中访问 http://127.0.0.1:5000/add?a=hello&b=world。
程序会暂停在断点处，进入 ipdb 调试环境。
我们可以使用 p a 和 p b 命令查看变量 a 和 b 的值，发现它们都是 None，因为 request.args.get('a', type=int) 在无法将参数转换为整数时会返回 None。

我们可以修改代码，添加错误处理机制：

from flask import Flask, request
import ipdb

app = Flask(__name__)

@app.route('/add')
def add():
    ipdb.set_trace()
    try:
        a = request.args.get('a', type=int)
        b = request.args.get('b', type=int)
        if a is None or b is None:
            return "Invalid input: a and b must be integers"
        result = a + b
        return str(result)
    except ValueError:
        return "Invalid input: a and b must be integers"

if __name__ == '__main__':
    app.run(debug=True)

现在，当传入的参数不是整数时，程序会返回一个错误提示信息。

8. pdb 和 ipdb 的选择

pdb 是 Python 自带的调试器，无需额外安装，可以在任何 Python 环境中使用。ipdb 则提供了更丰富的功能和更友好的用户界面，但需要安装。

一般来说，如果只是进行简单的调试，pdb 已经足够使用。如果需要更高级的功能，例如语法高亮、自动补全等，或者需要在 IPython 环境中使用调试器，则可以选择 ipdb。很多 IDE 都有集成的调试功能，可以根据自己的习惯选择。

9. 更多调试工具

除了 pdb 和 ipdb 之外，还有一些其他的 Python 调试工具，例如：

PyCharm Debugger： PyCharm IDE 内置的调试器，功能强大，界面友好。
VS Code Python Extension Debugger： VS Code Python 扩展提供的调试器，支持远程调试等高级功能。
Winpdb： 一个开源的 Python 调试器，支持多线程调试。
PuDB: 全屏，基于控制台的 Python 调试器。

10. 调试是一种重要的编程技能

掌握调试技巧是成为一名优秀的程序员的必要条件。熟练使用调试工具可以帮助我们更高效地定位和修复代码中的错误，提高开发效率。希望今天的分享能帮助大家更好地掌握 Python 调试技巧。

断点、单步执行、变量观察，这些调试技巧能助你快速定位问题。
熟练使用调试工具，bug不再是拦路虎。
调试是程序员必备技能，也是解决问题的关键。

Python 代码调试利器：pdb 与 ipdb

发表回复 取消回复

发表回复取消回复