Important

This documentation covers IPython versions 6.0 and higher. Beginning with version 6.0, IPython stopped supporting compatibility with Python versions lower than 3.3 including all versions of Python 2.7.

If you are looking for an IPython version compatible with Python 2.7, please use the IPython 5.x LTS release and refer to its documentation (LTS is the long term support release).

Module: core.crashhandler

sys.excepthook for IPython itself, leaves a detailed report on disk.

Authors:

  • Fernando Perez

  • Brian E. Granger

1 Class

class IPython.core.crashhandler.CrashHandler(app, contact_name: str | None = None, contact_email: str | None = None, bug_tracker: str | None = None, show_crash_traceback: bool = True, call_pdb: bool = False)

Bases: object

Customizable crash handlers for IPython applications.

Instances of this class provide a __call__() method which can be used as a sys.excepthook. The __call__() signature is:

def __call__(self, etype, evalue, etb)
__init__(app, contact_name: str | None = None, contact_email: str | None = None, bug_tracker: str | None = None, show_crash_traceback: bool = True, call_pdb: bool = False)

Create a new crash handler

Parameters:

  • app (Application) – A running Application instance, which will be queried at crash time for internal information.

  • contact_name (str) – A string with the name of the person to contact.

  • contact_email (str) – A string with the email address of the contact.

  • bug_tracker (str) – A string with the URL for your project’s bug tracker.

  • show_crash_traceback (bool) – If false, don’t print the crash traceback on stderr, only generate the on-disk report

  • call_pdb – Whether to call pdb on crash

These instances contain some non-argument attributes which allow for
further customization of the crash handler's behavior. Please see the
source for further details.
make_report(traceback)

Return a string containing a crash report.

1 Function

IPython.core.crashhandler.crash_handler_lite(etype, evalue, tb)

a light excepthook, adding a small message to the usual traceback