Warning

This documentation is for an old version of IPython. You can find docs for newer versions here.

Module: core.debugger

Pdb debugger class.

Modified from the standard pdb.Pdb class to avoid including readline, so that the command line completion of other programs which include this isn’t damaged.

In the future, this class will be expanded with improvements over the standard pdb.

The code in this file is mainly lifted out of cmd.py in Python 2.2, with minor changes. Licensing should therefore be under the standard Python terms. For details on the PSF (Python Software Foundation) standard license, see:

http://www.python.org/2.2.3/license.html

2 Classes

class IPython.core.debugger.Tracer(colors=None)

Bases: object

Class for local debugging, similar to pdb.set_trace.

Instances of this class, when called, behave like pdb.set_trace, but providing IPython’s enhanced capabilities.

This is implemented as a class which must be initialized in your own code and not as a standalone function because we need to detect at runtime whether IPython is already active or not. That detection is done in the constructor, ensuring that this code plays nicely with a running IPython, while functioning acceptably (though with limitations) if outside of it.

__init__(colors=None)

Create a local debugger instance.

Parameters:

colors : str, optional

The name of the color scheme to use, it must be one of IPython’s valid color schemes. If not given, the function will default to the current IPython scheme when running inside IPython, and to ‘NoColor’ otherwise.

Examples

from IPython.core.debugger import Tracer; debug_here = Tracer()

Later in your code:

debug_here()  # -> will open up the debugger at that point.

Once the debugger activates, you can use all of its regular commands to step through code, set breakpoints, etc. See the pdb documentation from the Python standard library for usage details.

class IPython.core.debugger.Pdb(color_scheme='NoColor', completekey=None, stdin=None, stdout=None)

Bases: pdb.Pdb

Modified Pdb class, does not load readline.

__init__(color_scheme='NoColor', completekey=None, stdin=None, stdout=None)

checkline(filename, lineno)

Check whether specified line seems to be executable.

Return lineno if it is, 0 if not (e.g. a docstring, comment, blank line or EOF). Warning: testing is not comprehensive.

do_pdef(arg)

Print the call signature for any callable object.

The debugger interface to %pdef

do_pdoc(arg)

Print the docstring for an object.

The debugger interface to %pdoc.

do_pfile(arg)

Print (or run through pager) the file where an object is defined.

The debugger interface to %pfile.

do_pinfo(arg)

Provide detailed information about an object.

The debugger interface to %pinfo, i.e., obj?.

do_pinfo2(arg)

Provide extra detailed information about an object.

The debugger interface to %pinfo2, i.e., obj??.

do_psource(arg)

Print (or run through pager) the source code for an object.

list_command_pydb(arg)

List command to use if we have a newer pydb installed

new_do_restart(arg)

Restart command. In the context of ipython this is exactly the same thing as ‘quit’.

print_list_lines(filename, first, last)

The printing (as opposed to the parsing part of a ‘list’ command.

set_colors(scheme)

Shorthand access to the color table scheme selector method.

3 Functions

IPython.core.debugger.BdbQuit_excepthook(et, ev, tb, excepthook=None)

Exception hook which handles BdbQuit exceptions.

All other exceptions are processed using the excepthook parameter.

IPython.core.debugger.BdbQuit_IPython_excepthook(self, et, ev, tb, tb_offset=None)

IPython.core.debugger.decorate_fn_with_doc(new_fn, old_fn, additional_text='')

Make new_fn have old_fn’s doc string. This is particularly useful for the do_... commands that hook into the help system. Adapted from from a comp.lang.python posting by Duncan Booth.