Module: terminal.debugger

1 Class

class IPython.terminal.debugger.TerminalPdb(*args, pt_session_options=None, **kwargs)

Bases: Pdb

Standalone IPython debugger.

__init__(*args, pt_session_options=None, **kwargs)

Create a new IPython debugger.

Parameters:

  • completekey (default None) – Passed to pdb.Pdb.

  • stdin (default None) – Passed to pdb.Pdb.

  • stdout (default None) – Passed to pdb.Pdb.

  • context (int) – Number of lines of source code context to show when displaying stacktrace information.

  • mode (str, optional) – How the debugger was invoked, one of 'inline' (used by the breakpoint() builtin), 'cli' (used by the command line invocation) or None (backwards compatible behaviour). This argument was added to stdlib’s pdb.Pdb in Python 3.14; it is accepted on every supported Python version here but only forwarded to the underlying pdb.Pdb when it is actually supported.

  • **kwargs – Passed to pdb.Pdb.

Notes

The possibilities are python version dependent, see the python docs for more info.

cmdloop(intro=None)

Repeatedly issue a prompt, accept input, parse an initial prefix off the received input, and dispatch to action methods, passing them the remainder of the line as argument.

override the same methods from cmd.Cmd to provide prompt toolkit replacement.

do_interact(arg)

interact

Start an interactive interpreter whose global namespace contains all the (global and local) names found in the current scope.

pt_init(pt_session_options=None)

Initialize the prompt session and the prompt loop and store them in self.pt_app and self.pt_loop.

Additional keyword arguments for the PromptSession class can be specified in pt_session_options.

1 Function

IPython.terminal.debugger.set_trace(frame=None)

Start debugging from frame.

If frame is not specified, debugging starts from caller’s frame.