pdbr: Pdb with Rich Library

Warnings

• gotcha When using Python's built-in `breakpoint()` function, ensure `pdbr` is imported beforehand, or set the `PYTHONBREAKPOINT` environment variable to `pdbr.set_trace` for `pdbr` to be activated. Otherwise, it will default to the standard `pdb`.
  Fix: Either `import pdbr` at the beginning of your script, or `os.environ["PYTHONBREAKPOINT"] = "pdbr.set_trace"` before calling `breakpoint()`.
• breaking Compatibility with IPython 9.x series was specifically addressed in `pdbr` version 0.9.2. Older `pdbr` versions may exhibit unexpected behavior or errors when used with IPython 9.x due to changes in IPython's internal architecture, especially regarding color and theme handling.
  Fix: Upgrade `pdbr` to version 0.9.2 or newer when using IPython 9.x or later: `pip install --upgrade pdbr[ipython]`.
• gotcha Configuration file locations and parsing for `pdbr` (e.g., for history or context settings) were adjusted in version 0.8.9 to better adhere to `XDG_CONFIG_HOME`. If you have custom configurations, they might need to be relocated or updated.
  Fix: Consult the `pdbr` documentation for the updated configuration file paths, typically moving to `~/.config/pdbr/` or similar XDG-compliant locations.
• gotcha Like its base `pdb`, `pdbr` does not inherently handle multithreaded applications gracefully. Breakpoints in one thread may interrupt all threads. For more isolated debugging in multithreaded contexts, consider using `pdb.Pdb()` to create an isolated debugger instance and then call `set_trace()` on that specific object.
  Fix: For specific thread debugging, manually instantiate `pdbr.RichPdb()` for the target thread, then call its `set_trace()` method. Example: `my_debugger = pdbr.RichPdb(); my_debugger.set_trace()`.

Install

• pip install pdbr Install base package
• pip install pdbr[ipython] Install with IPython support

Imports

• set_trace

  import pdbr; pdbr.set_trace()

  This is the primary way to initiate a debugging session with pdbr.

Quickstart

This example demonstrates how to insert a breakpoint using `pdbr.set_trace()`. When the `divide` function attempts division by zero, the debugger will be invoked, allowing interactive inspection of variables and program state.

import pdbr

def divide(a, b):
    try:
        result = a / b
    except ZeroDivisionError:
        print("Error: Division by zero detected, entering debugger...")
        pdbr.set_trace() # Program execution will pause here
        result = 0
    return result

if __name__ == "__main__":
    print(f"10 / 2 = {divide(10, 2)}")
    print(f"5 / 0 = {divide(5, 0)}") # This call will trigger the debugger