pdb++ (pdbpp)

0.12.1 · active · verified Sat Apr 11

pdb++ (pdbpp) is a robust, drop-in replacement for the standard Python debugger, `pdb`. It enhances the debugging experience with features like colorful TAB completion (via fancycompleter), optional syntax highlighting (via Pygments), a persistent 'sticky' mode that always shows the current code context, and smart command parsing. It aims for full compatibility with `pdb` while adding significant quality-of-life improvements. The current version is 0.12.1, with ongoing maintenance and updates.

Warnings

gotcha Leaving `pdb.set_trace()` calls in production code will halt program execution unexpectedly. Always remove or comment out breakpoints before deploying.
Fix: Manually remove `pdb.set_trace()` calls or use conditional breakpoints. Many teams search for 'pdb.' before commits.
gotcha pdb++'s 'smart command parsing' prioritizes local variables over debugger commands if they share the same name (e.g., a variable `c` vs. the `continue` command).
Fix: To force a command when ambiguity exists, prefix it with `!!` (e.g., `!!c` to execute `continue`).
breaking Older versions of `pdbpp` experienced compatibility issues with `python -m pdb` when running on Python 3.11 and newer versions.
Fix: Upgrade `pdbpp` to version 0.12.1 or higher to ensure full compatibility with Python 3.11+ for `python -m pdb` usage.
gotcha When `pdbpp` is used in remote debugging setups (e.g., with `remote-pdb`), advanced features like 'sticky mode' and TAB completion may not function correctly due to terminal environment differences.
Fix: Be aware of potential feature limitations in non-local terminal environments. Direct terminal interaction offers the best experience.
gotcha Some online resources might suggest that `pdbpp` is unmaintained. This is often a misunderstanding; while `pdbp` (a separate project) builds upon `pdbpp` and offers its own enhancements, `pdbpp` itself continues to be actively maintained with recent releases and GitHub activity.
Fix: Refer to the official PyPI page and GitHub repository for the latest maintenance status and release information.

Install

pip install pdbpp PyPI
conda install -c conda-forge pdbpp Conda

Imports

set_trace
```
import pdb; pdb.set_trace()
```
pdbpp is designed as a drop-in replacement for the standard `pdb` module. Once installed, `import pdb` will automatically leverage pdbpp's enhanced features.

Quickstart

Install `pdbpp`, then simply use `import pdb; pdb.set_trace()` anywhere in your code. When execution reaches this line, a `Pdb++` interactive prompt will appear, offering advanced debugging features. You can then use commands like `n` (next), `s` (step), `c` (continue), `l` (list), and `sticky`.

import pdb

def my_function(a, b):
    result = a + b
    pdb.set_trace()  # Execution will pause here
    return result

if __name__ == '__main__':
    print(my_function(5, 3))

view raw JSON →