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: terminal.ipapp

The Application object for the command line ipython program.

3 Classes

class IPython.terminal.ipapp.IPAppCrashHandler(app)

Bases: CrashHandler

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


Create a new crash handler

  • 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.

Return a string containing a crash report.

class IPython.terminal.ipapp.LocateIPythonApp(**kwargs: Any)

Bases: BaseIPythonApplication


Start the app mainloop.

Override in subclasses.

class IPython.terminal.ipapp.TerminalIPythonApp(**kwargs: Any)

Bases: BaseIPythonApplication, InteractiveShellApp

aliases: Dict[str, Any] = {'autocall': 'InteractiveShell.autocall', 'c': 'InteractiveShellApp.code_to_run', 'cache-size': 'InteractiveShell.cache_size', 'colors': 'InteractiveShell.colors', 'config': 'BaseIPythonApplication.extra_config_file', 'ext': 'InteractiveShellApp.extra_extensions', 'gui': 'InteractiveShellApp.gui', 'ipython-dir': 'BaseIPythonApplication.ipython_dir', 'log-level': 'Application.log_level', 'logappend': 'InteractiveShell.logappend', 'logfile': 'InteractiveShell.logfile', 'm': 'InteractiveShellApp.module_to_run', 'matplotlib': 'InteractiveShellApp.matplotlib', 'profile': 'BaseIPythonApplication.profile', 'profile-dir': 'ProfileDir.location', 'pylab': 'InteractiveShellApp.pylab'}

the alias map for configurables Keys might strings or tuples for additional options; single-letter alias accessed like -v. Values might be like “Class.trait” strings of two-tuples: (Class.trait, help-text).


alias of IPAppCrashHandler


optionally display the banner


initialize the InteractiveShell instance


Do actions after construct, but before starting the app.


Start the app mainloop.

Override in subclasses.

1 Function


Load the default config file from the default ipython_dir.

This is useful for embedded shells.