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).
The IPython API¶
- Release
7.33.0.dev
- Date
April 07, 2022
IPython: tools for interactive and parallel computing in Python. |
|
System command aliases. |
|
An application for IPython. |
|
Autocall capabilities for IPython.core. |
|
A context manager for managing things injected into |
|
Compiler tools with improved interactive support. |
|
Completion for IPython. |
|
Implementations for various useful completers. |
|
sys.excepthook for IPython itself, leaves a detailed report on disk. |
|
Pdb debugger class. |
|
Global exception classes for IPython.core. |
|
Infrastructure for registering and firing callbacks on application events. |
|
Color schemes for exception handling code in IPython. |
|
A class for managing IPython extensions. |
|
Display formatters. |
|
Simple function to call to get the current InteractiveShell instance |
|
History related magics and functionality |
|
An application for managing IPython history. |
|
Hooks for IPython. |
|
DEPRECATED: Input handling and transformation machinery. |
|
DEPRECATED: Input transformer classes to support IPython special syntax. |
|
Input transformer machinery to support IPython special syntax. |
|
Main IPython class. |
|
Logger class for IPython's logging facilities. |
|
Support for interactive macros in IPython |
|
Magic functions for InteractiveShell. |
|
A decorator-based method of constructing IPython magics with |
|
Tools for inspecting Python objects. |
|
Paging capabilities for IPython.core |
|
Payload system for IPython. |
|
A payload based version of page. |
|
Prefiltering components. |
|
An application for managing IPython profiles. |
|
An object for managing IPython profile directories. |
|
Being removed |
|
Pylab (matplotlib) support utilities. |
|
A mixin for |
|
Simple utility for splitting user input. |
|
Verbose and colourful traceback formatting. |
|
Public API for display tools in IPython. |
|
Manage background (threaded) jobs conveniently from an interactive shell. |
|
Utilities for accessing the platform's clipboard. |
|
Provides a reload() function that acts recursively. |
|
Module for interactive demos using IPython. |
|
'editor' hooks for common editors that work well with ipython |
|
Support for creating GUI apps and starting event loops. |
|
Deprecated since IPython 5.0 |
|
Tools for handling LaTeX. |
|
Defines a variety of Pygments lexers for highlighting IPython code. |
|
Python advanced pretty printer. |
|
Password generation for the IPython notebook. |
|
Find files and directories which IPython uses. |
|
An embedded IPython shell. |
|
IPython terminal interface using prompt_toolkit |
|
The |
|
Extra magics for terminal use. |
|
Terminal input and output prompts. |
|
Module to define and register Terminal IPython shortcuts with |
|
Testing support (tools to test IPython itself). |
|
Decorators for labeling test objects. |
|
Global IPython app to support test running. |
|
IPython Test Suite Runner. |
|
IPython Test Process Controller |
|
Experimental code for cleaner support of IPython syntax with unittest. |
|
Decorators marks that a doctest should be skipped. |
|
Generic testing tools. |
|
Class and program to colorize python source code for ANSI terminals. |
|
IO capturing utilities. |
|
Color managing related utilities |
|
Tools for coloring text in ANSI terminals. |
|
Miscellaneous context managers. |
|
Utilities for working with data structures like lists, dicts and tuples. |
|
Decorators that don't go anywhere else. |
|
A fancy version of Python's builtin |
|
Utilities for dealing with text encodings |
|
Utilities for working with stack frames. |
|
Generic functions for extending IPython. |
|
A simple utility to import something by its string name. |
|
IO related utilities. |
|
A dict subclass that supports attribute style access. |
|
Utility functions for finding modules |
|
Tools to open .py files as Unicode, using the encoding specified within the file, as per PEP 263. |
|
Utilities for path handling. |
|
Utilities for working with external processes. |
|
Sentinel class for constants with useful reprs |
|
A shim module for deprecated imports |
|
String dispatch class to match regexps and dispatch commands. |
|
Utilities for getting information about IPython and the system it's running in. |
|
Context managers for adding things to sys.path temporarily. |
|
This module contains classes - NamedFileInTemporaryDirectory, TemporaryWorkingDirectory. |
|
Utilities for working with terminals. |
|
Utilities for working with strings and text. |
|
Utilities for timing code execution. |
|
Token-related utilities |
|
Timezone utilities |
|
This module has been deprecated since IPython 6.0. |
|
Utilities for version comparison |
|
Support for wildcard pattern matching in object inspection. |