从 pdb 到 ipdb：升级你的 Python 调试工具箱

在 Python 开发中，除了 pdb（Python Debugger），还有多种调试工具和方法可以帮助你调试代码
ipdb 是一个基于 pdb（Python Debugger）的增强型调试器，它提供了一个更友好的界面和一些额外的功能，使得调试 Python 代码更加方便。以下是如何在 Python 项目中使用 ipdb 的基本步骤：

安装 ipdb

首先，你需要安装 ipdb。你可以通过 pip 来安装它：

pip install ipdb

使用 ipdb 设置断点

在你的代码中，你可以使用 ipdb.set_trace() 来设置断点。当程序执行到这一行时，它将进入调试模式。

import ipdb

def my_function():
    ipdb.set_trace()  # 设置断点
    print("Hello, world!")

my_function()

启动程序

运行你的程序，当程序执行到 ipdb.set_trace() 这一行时，它将暂停执行，并进入调试模式。

调试命令

在调试模式下，你可以使用以下命令：

• n 或 next：执行下一行代码，但不进入函数内部。
• s 或 step：执行下一行代码，如果遇到函数调用，则进入函数内部。
• c 或 continue：继续执行，直到遇到下一个断点或程序结束。
• p 或 print：打印变量的值。例如，p my_variable。
• l 或 list：显示当前的代码上下文。
• b 或 break：设置断点。例如，b my_function。
• bt 或 backtrace：显示当前的调用堆栈。
• q 或 quit：退出调试器。

高级用法

• 条件断点：你可以为断点设置条件，只有当条件为真时，程序才会暂停。例如：

  ipdb.set_trace()  # 这行代码将被执行
  ipdb.set_trace(condition='my_variable > 10')
  

• 断点管理：你可以列出、清除或禁用断点。

  # 列出所有断点
  ipdb.breakpoint()
  
  # 清除特定断点
  ipdb.clear(行号)
  
  # 禁用所有断点
  ipdb.disable()
  

• 自动启动调试器：你可以在程序启动时自动进入调试模式，而不需要在代码中显式设置断点。

  import ipdb; ipdb.set_trace()
  

• 与 IDE 集成：许多 IDE（如 PyCharm、VS Code）支持 ipdb，你可以在 IDE 中直接使用 ipdb 的功能。

示例

假设你有一个简单的 FastAPI 应用，你想要在处理请求时调试它：

from fastapi import FastAPI
import ipdb

app = FastAPI()

@app.get("/items/{item_id}")
def read_item(item_id: int):
    ipdb.set_trace()  # 设置断点
    return {"item_id": item_id}

# 运行 uvicorn main:app --reload

当你发送请求到 /items/1 时，程序将在 ipdb.set_trace() 处暂停，允许你检查变量和执行流程。

使用 ipdb 可以大大简化调试过程，特别是在处理复杂的逻辑和调试远程代码时。