IPython `pdb` 技术文档

1. 安装指南

为了使用 ipdb，您需要首先确保您的环境中已经安装了 IPython。ipdb 支持通过多种配置方式设置调试上下文。

环境配置

您可以通过以下任一方式设置调试上下文：

• 在主目录下创建一个 .ipdb 文件。
• 在项目目录下创建 setup.cfg 或 pyproject.toml 文件。
• 通过环境变量 $IPDB_CONFIG 设置配置文件路径。

配置文件中应包含如下内容：

.ipdb 或 setup.cfg:

context=5

pyproject.toml:

[tool.ipdb]
context=5

环境变量：

export IPDB_CONFIG="/path/to/config/file"

安装 ipdb

使用支持 setuptools 的工具安装 ipdb，如 pip：

pip install ipdb

对于 Python 2.7 用户，还可以使用以下命令：

python -m ipdb mymodule.py

2. 项目的使用说明

ipdb 提供了一个与 pdb 模块相同接口的 IPython 调试器，支持代码补全、语法高亮、更好的回溯和内省。

使用示例

import ipdb
ipdb.set_trace()  # 开始调试
ipdb.set_trace(context=5)  # 显示五行代码上下文
ipdb.pm()  # 相当于 %debug
ipdb.run('x[0] = 3')  # 执行表达式
result = ipdb.runcall(function, arg0, arg1, kwarg='foo')  # 调用函数
result = ipdb.runeval('f(1,2) - 3')  # 计算表达式

设置 set_trace 参数

set_trace 函数接受 context 参数来设置显示代码行数，cond 参数用于条件断点。

3. 项目API使用文档

ipdb API 主要包括以下函数：

• set_trace([context, [cond]]): 开始调试。
• pm(): 在异常点启动调试。
• run([statement]): 执行表达式。
• runcall([func,] *args, **kwargs): 调用函数。
• runeval([expression]): 计算表达式。

更多详细信息，请参考官方文档。

4. 项目安装方式

ipdb 可以通过以下方式安装：

• 使用 pip 工具：

  pip install ipdb
  

• 对于 Python 2.7 用户，可以使用以下命令：

  python -m ipdb mymodule.py
  

确保在安装前已经配置好了所需的调试上下文。

以上即是 ipdb 的技术文档，希望能帮助您更好地使用这个强大的调试工具。