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: 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.
- __init__(app)
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.
- class IPython.terminal.ipapp.LocateIPythonApp(**kwargs: Any)
Bases:
BaseIPythonApplication
- start()
Start the app mainloop.
Override in subclasses.
- class IPython.terminal.ipapp.TerminalIPythonApp(**kwargs: Any)
Bases:
BaseIPythonApplication
,InteractiveShellApp
- crash_handler_class
alias of
IPAppCrashHandler
- display_banner
Whether to display a banner upon starting IPython.
- force_interact
If a command or file is given via the command-line, e.g. ‘ipython foo.py’, start an interactive shell after executing the file or command.
- init_banner()
optionally display the banner
- init_shell()
initialize the InteractiveShell instance
- initialize(argv=None)
Do actions after construct, but before starting the app.
- interactive_shell_class
Class to use to instantiate the TerminalInteractiveShell object. Useful for custom Frontends
- quick
Start IPython quickly by skipping the loading of config files.
- start()
Start the app mainloop.
Override in subclasses.
1 Function
- IPython.terminal.ipapp.load_default_config(ipython_dir=None)
Load the default config file from the default ipython_dir.
This is useful for embedded shells.