ipdab 25.8.3

The Debug Adapter Protocol (DAP) implementation for the ipdb debugger.

ipdab

A Debug Adapter Protocol (DAP) for the Python pdb and ipdb debuggers. Debugpy is the reference implementation of a DAP for Python. The DAP allow your IDE to communicate with the debugger in a standardised way.

The good, old Python debuggers pdb and ipdb debugger were considered incompatible with the DAP as you control the debugger from the terminal, and not from your IDE. The aim of ipdab is to implement the DAP to these debuggers to the extent possible, and get create a debugging experience that some would consider to have the best of both world:

• You control the debugger from the terminal
• Your IDE is able to track the debugger, e.g., by indicating the current line with an arrow.

How it works

In addition to starting the pdb or ipdb debugger, ipdab starts server whenever you use set_trace. Any IDE that supports the DAP can connect to this server to track progress of the debugger, retrieve variable values, retrieve the stack trace etc.

Note that it's not possible to control the debugger from your IDE. This is a technical limitation of the pdb and ipdb debugger. They give control to the user every time you see a command prompt. At such a point, the DAP server cannot inject any commands as it doesn't control the terminal in which the debugger runs. Controlling the debugger should be done from the terminal itself.

Installation

pip install ipdab

Or, clone the repository and install with:

pip install -e .

Usage

Just like ipdb, use ipdab in the code you want to debug:

print("Hello, world!")
print("Starting ipdab...")

import ipdab

ipdab.set_trace()

print("This will be debugged.")

Now, connect your IDE to the DAP server started by ipdab.

Neovim

In Neovim, this could work by adding an extry entry to your dap.adapters and dap.configurations:

local dap = require "dap"

-- Custom DAP adapter for ipdb
dap.adapters.ipdb = {
  type = "server",
  host = "127.0.0.1",
  port = 9000,
}

-- Attach config — does not launch, just connects
dap.configurations.python = dap.configurations.python or {}
table.insert(dap.configurations.python, {
  name = "Attach to ipdb",
  type = "ipdb",
  request = "launch", -- <-- important to say launch here!
  program = "${file}",
  justMyCode = false,
  cwd = vim.fn.getcwd(),
})

Then, start your Python script any way you want, e,g., with python your_script.py or ipython -i your_script.py. When the execution hits the ipdab.set_trace() line, the DAP server will start and you can connect to it from Neovim with :lua require'dap'.continue().

VS Code

Should work similar to Neovim, not tested yet.

TODO

• Test on slower hardware

  • It seems that dapuit is timing out
  • Try to start it with fewer windows

• Cleanup the repo

• Create a Neovim plugin

• Write a blog post about debugging

• Fix compatiblity with ipython 9.1.0 and higher, entering the debugger seems to break

• Check how ipdab works with module reloads

• Consider post mortem support