Warning

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

The IPython API

Release:2.4.2 Date:September 25, 2015

IPython	IPython: tools for interactive and parallel computing in Python.
IPython.config.application	A base class for a configurable application.
IPython.config.configurable	A base class for objects that are configurable.
IPython.config.loader	A simple configuration system.
IPython.consoleapp	A minimal application base mixin for all ZMQ based IPython frontends.
IPython.core.alias	System command aliases.
IPython.core.application	An application for IPython.
IPython.core.autocall	Autocall capabilities for IPython.core.
IPython.core.builtin_trap	A context manager for managing things injected into __builtin__.
IPython.core.compilerop	Compiler tools with improved interactive support.
IPython.core.completer	Word completion for IPython.
IPython.core.completerlib	Implementations for various useful completers.
IPython.core.crashhandler	sys.excepthook for IPython itself, leaves a detailed report on disk.
IPython.core.debugger	Pdb debugger class.
IPython.core.display	Top-level display functions for displaying object in different formats.
IPython.core.display_trap	A context manager for handling sys.displayhook.
IPython.core.displayhook	Displayhook for IPython.
IPython.core.displaypub	An interface for publishing rich data to frontends.
IPython.core.error	Global exception classes for IPython.core.
IPython.core.events	Infrastructure for registering and firing callbacks on application events.
IPython.core.excolors	Color schemes for exception handling code in IPython.
IPython.core.extensions	A class for managing IPython extensions.
IPython.core.formatters	Display formatters.
IPython.core.getipython	Simple function to call to get the current InteractiveShell instance
IPython.core.history	History related magics and functionality
IPython.core.historyapp	An application for managing IPython history.
IPython.core.hooks	Hooks for IPython.
IPython.core.inputsplitter	Input handling and transformation machinery.
IPython.core.inputtransformer	Input transformer classes to support IPython special syntax.
IPython.core.interactiveshell	Main IPython class.
IPython.core.logger	Logger class for IPython’s logging facilities.
IPython.core.macro	Support for interactive macros in IPython
IPython.core.magic	Magic functions for InteractiveShell.
IPython.core.magic_arguments	A decorator-based method of constructing IPython magics with argparse option handling.
IPython.core.magics	Implementation of all the magic functions built into IPython.
IPython.core.magics.auto	Implementation of magic functions that control various automatic behaviors.
IPython.core.magics.basic	Implementation of basic magic functions.
IPython.core.magics.code	Implementation of code management magic functions.
IPython.core.magics.config	Implementation of configuration-related magic functions.
IPython.core.magics.deprecated	Deprecated Magic functions.
IPython.core.magics.display	Simple magics for display formats
IPython.core.magics.execution	Implementation of execution-related magic functions.
IPython.core.magics.extension	Implementation of magic functions for the extension machinery.
IPython.core.magics.history	Implementation of magic functions related to History.
IPython.core.magics.logging	Implementation of magic functions for IPython’s own logging.
IPython.core.magics.namespace	Implementation of namespace-related magic functions.
IPython.core.magics.osm	Implementation of magic functions for interaction with the OS.
IPython.core.magics.pylab	Implementation of magic functions for matplotlib/pylab support.
IPython.core.magics.script	Magic functions for running cells in various scripts.
IPython.core.oinspect	Tools for inspecting Python objects.
IPython.core.page	Paging capabilities for IPython.core
IPython.core.payload	Payload system for IPython.
IPython.core.payloadpage	A payload based version of page.
IPython.core.prefilter	Prefiltering components.
IPython.core.profileapp	An application for managing IPython profiles.
IPython.core.profiledir	An object for managing IPython profile directories.
IPython.core.prompts	Classes for handling input/output prompts.
IPython.core.pylabtools	Pylab (matplotlib) support utilities.
IPython.core.shellapp	A mixin for Application classes that launch InteractiveShell instances, load extensions, etc.
IPython.core.splitinput	Simple utility for splitting user input.
IPython.core.ultratb	Verbose and colourful traceback formatting.
IPython.core.usage	Usage information for the main IPython applications.
IPython.html.auth.login	Tornado handlers logging into the notebook.
IPython.html.auth.logout	Tornado handlers for logging out of the notebook.
IPython.html.base.handlers	Base Tornado handlers for the notebook.
IPython.html.base.zmqhandlers	Tornado handlers for WebSocket <-> ZMQ sockets.
IPython.html.fabfile	fabfile to prepare the notebook
IPython.html.log
IPython.html.nbconvert.handlers
IPython.html.nbextensions	Utilities for installing Javascript extensions for the notebook
IPython.html.notebook.handlers	Tornado handlers for the live notebook view.
IPython.html.notebookapp	A tornado based IPython notebook server.
IPython.html.services.clusters.clustermanager	Manage IPython.parallel clusters in the notebook.
IPython.html.services.clusters.handlers	Tornado handlers for cluster web service.
IPython.html.services.kernels.handlers	Tornado handlers for the notebook.
IPython.html.services.kernels.kernelmanager	A kernel manager relating notebooks and kernels
IPython.html.services.nbconvert.handlers
IPython.html.services.notebooks.filenbmanager	A notebook manager that uses the local file system for storage.
IPython.html.services.notebooks.handlers	Tornado handlers for the notebooks web service.
IPython.html.services.notebooks.nbmanager	A base class notebook manager.
IPython.html.services.sessions.handlers	Tornado handlers for the sessions web service.
IPython.html.services.sessions.sessionmanager	A base class session manager.
IPython.html.tree.handlers	Tornado handlers for the tree view.
IPython.html.utils	Notebook related utilities
IPython.html.widgets.interaction	Interact with functions using widgets.
IPython.html.widgets.widget	Base Widget class.
IPython.html.widgets.widget_bool	BoolWidget class.
IPython.html.widgets.widget_button	ButtonWidget class.
IPython.html.widgets.widget_container	ContainerWidget class.
IPython.html.widgets.widget_float	FloatWidget class.
IPython.html.widgets.widget_image	ImageWidget class.
IPython.html.widgets.widget_int	IntWidget class.
IPython.html.widgets.widget_selection	SelectionWidget classes.
IPython.html.widgets.widget_selectioncontainer	SelectionContainerWidget class.
IPython.html.widgets.widget_string	StringWidget class.
IPython.kernel.blocking.channels	Blocking channels
IPython.kernel.blocking.client	Implements a fully blocking kernel client.
IPython.kernel.channels	Base classes to manage a Client’s interaction with a running kernel
IPython.kernel.channelsabc	Abstract base classes for kernel client channels
IPython.kernel.client	Base class to manage the interaction with a running kernel
IPython.kernel.clientabc	Abstract base class for kernel clients
IPython.kernel.comm.comm	Base class for a Comm
IPython.kernel.comm.manager	Base class to manage comms
IPython.kernel.connect	Utilities for connecting to kernels
IPython.kernel.inprocess.blocking	Implements a fully blocking kernel client.
IPython.kernel.inprocess.channels	A kernel client for in-process kernels.
IPython.kernel.inprocess.client	A client for in-process kernels.
IPython.kernel.inprocess.ipkernel	An in-process kernel
IPython.kernel.inprocess.manager	A kernel manager for in-process kernels.
IPython.kernel.inprocess.socket	Defines a dummy socket implementing (part of) the zmq.Socket interface.
IPython.kernel.ioloop.manager	A kernel manager with a tornado IOLoop
IPython.kernel.ioloop.restarter	A basic in process kernel monitor with autorestarting.
IPython.kernel.launcher	Utilities for launching kernels
IPython.kernel.manager	Base class to manage a running kernel
IPython.kernel.managerabc	Abstract base class for kernel managers.
IPython.kernel.multikernelmanager	A kernel manager for multiple kernels
IPython.kernel.restarter	A basic kernel monitor with autorestarting.
IPython.kernel.zmq.datapub	Publishing native (typically pickled) objects.
IPython.kernel.zmq.displayhook	Replacements for sys.displayhook that publish over ZMQ.
IPython.kernel.zmq.embed	Simple function for embedding an IPython kernel
IPython.kernel.zmq.eventloops	Event loop integration for the ZeroMQ-based kernels.
IPython.kernel.zmq.gui.gtkembed
IPython.kernel.zmq.heartbeat	The client and server for a basic ping-pong style heartbeat.
IPython.kernel.zmq.iostream	Wrappers for forwarding stdout/stderr over zmq
IPython.kernel.zmq.ipkernel	An interactive kernel that talks to frontends over 0MQ.
IPython.kernel.zmq.kernelapp	An Application for launching a kernel
IPython.kernel.zmq.log
IPython.kernel.zmq.parentpoller
IPython.kernel.zmq.pylab.backend_inline	A matplotlib backend for publishing figures via display_data
IPython.kernel.zmq.pylab.config	Configurable for configuring the IPython inline backend
IPython.kernel.zmq.serialize	serialization utilities for apply messages
IPython.kernel.zmq.session	Session object for building, serializing, sending, and receiving messages in IPython.
IPython.kernel.zmq.zmqshell	A ZMQ-based subclass of InteractiveShell.
IPython.lib.backgroundjobs	Manage background (threaded) jobs conveniently from an interactive shell.
IPython.lib.clipboard	Utilities for accessing the platform’s clipboard.
IPython.lib.deepreload	Provides a reload() function that acts recursively.
IPython.lib.demo	Module for interactive demos using IPython.
IPython.lib.display	Various display related classes.
IPython.lib.editorhooks	‘editor’ hooks for common editors that work well with ipython
IPython.lib.guisupport	Support for creating GUI apps and starting event loops.
IPython.lib.inputhook	Inputhook management for GUI event loop integration.
IPython.lib.latextools	Tools for handling LaTeX.
IPython.lib.pretty	Python advanced pretty printer.
IPython.lib.security	Password generation for the IPython notebook.
IPython.nbconvert.exporters.exporter	This module defines a base Exporter class.
IPython.nbconvert.exporters.html	HTML Exporter class
IPython.nbconvert.exporters.latex	LaTeX Exporter class
IPython.nbconvert.exporters.markdown	Markdown Exporter class
IPython.nbconvert.exporters.python	Python script Exporter class
IPython.nbconvert.exporters.rst	restructuredText Exporter class
IPython.nbconvert.exporters.slides	HTML slide show Exporter class
IPython.nbconvert.exporters.templateexporter	This module defines TemplateExporter, a highly configurable converter that uses Jinja2 to export notebook files into different formats.
IPython.nbconvert.filters.ansi	Filters for processing ANSI colors within Jinja templates.
IPython.nbconvert.filters.citation	Citation handling for LaTeX output.
IPython.nbconvert.filters.datatypefilter	Filter used to select the first preferred output format available.
IPython.nbconvert.filters.highlight	Module containing filter functions that allow code to be highlighted from within Jinja templates.
IPython.nbconvert.filters.latex	Latex filters.
IPython.nbconvert.filters.markdown	Markdown filters This file contains a collection of utility filters for dealing with markdown within Jinja templates.
IPython.nbconvert.filters.strings	String filters.
IPython.nbconvert.nbconvertapp	NBConvert is a utility for conversion of .ipynb files.
IPython.nbconvert.postprocessors.base	Basic post processor
IPython.nbconvert.postprocessors.pdf	Contains writer for writing nbconvert output to PDF.
IPython.nbconvert.postprocessors.serve	PostProcessor for serving reveal.js HTML slideshows.
IPython.nbconvert.preprocessors.base	Base class for preprocessors
IPython.nbconvert.preprocessors.coalescestreams	Preprocessor for merging consecutive stream outputs for easier handling.
IPython.nbconvert.preprocessors.convertfigures	Module containing a preprocessor that converts outputs in the notebook from one format to another.
IPython.nbconvert.preprocessors.csshtmlheader	Module that pre-processes the notebook for export to HTML.
IPython.nbconvert.preprocessors.extractoutput	Module containing a preprocessor that extracts all of the outputs from the notebook file.
IPython.nbconvert.preprocessors.highlightmagics	This preprocessor detect cells using a different language through magic extensions such as %%R or %%octave.
IPython.nbconvert.preprocessors.latex	Module that allows latex output notebooks to be conditioned before they are converted.
IPython.nbconvert.preprocessors.revealhelp	Module that pre-processes the notebook for export via Reveal.
IPython.nbconvert.preprocessors.svg2pdf	Module containing a preprocessor that converts outputs in the notebook from one format to another.
IPython.nbconvert.utils.base	Global configuration class.
IPython.nbconvert.utils.exceptions	NbConvert specific exceptions
IPython.nbconvert.utils.lexers	Defines a variety of Pygments lexers for highlighting IPython code.
IPython.nbconvert.utils.pandoc	Utility for calling pandoc
IPython.nbconvert.writers.base	Contains writer base class.
IPython.nbconvert.writers.debug	Contains debug writer.
IPython.nbconvert.writers.files	Contains writer for writing nbconvert output to filesystem.
IPython.nbconvert.writers.stdout	Contains Stdout writer
IPython.nbformat.convert	API for converting notebooks between versions.
IPython.nbformat.current	The official API for working with notebooks in the current format version.
IPython.nbformat.notebooknode	NotebookNode - adding attribute access to dicts
IPython.nbformat.reader	API for reading notebooks.
IPython.nbformat.sign	Functions for signing notebooks
IPython.nbformat.v1.convert	Convert notebook to the v1 format.
IPython.nbformat.v1.nbbase	The basic dict based notebook format.
IPython.nbformat.v1.nbjson	Read and write notebooks in JSON format.
IPython.nbformat.v1.rwbase	Base classes and function for readers and writers.
IPython.nbformat.v2	The main API for the v2 notebook format.
IPython.nbformat.v2.convert	Code for converting notebooks to and from the v2 format.
IPython.nbformat.v2.nbbase	The basic dict based notebook format.
IPython.nbformat.v2.nbjson	Read and write notebooks in JSON format.
IPython.nbformat.v2.nbpy	Read and write notebooks as regular .py files.
IPython.nbformat.v2.nbxml	Read and write notebook files as XML.
IPython.nbformat.v2.rwbase	Base classes and utilities for readers and writers.
IPython.nbformat.v3	The main API for the v3 notebook format.
IPython.nbformat.v3.convert	Code for converting notebooks to and from the v2 format.
IPython.nbformat.v3.nbbase	The basic dict based notebook format.
IPython.nbformat.v3.nbjson	Read and write notebooks in JSON format.
IPython.nbformat.v3.nbpy	Read and write notebooks as regular .py files.
IPython.nbformat.v3.rwbase	Base classes and utilities for readers and writers.
IPython.nbformat.v3.validator
IPython.nbformat.v4.convert	Code for converting notebooks to and from v3.
IPython.nbformat.v4.nbbase	Python API for composing notebook elements
IPython.nbformat.v4.nbjson	Read and write notebooks in JSON format.
IPython.nbformat.v4.rwbase	Base classes and utilities for readers and writers.
IPython.parallel	The IPython ZMQ-based parallel computing interface.
IPython.parallel.apps.baseapp	The Base Application class for IPython.parallel apps
IPython.parallel.apps.ipclusterapp	The ipcluster application.
IPython.parallel.apps.ipcontrollerapp	The IPython controller application.
IPython.parallel.apps.ipengineapp	The IPython engine application
IPython.parallel.apps.iploggerapp	A simple IPython logger application
IPython.parallel.apps.launcher	Facilities for launching IPython processes asynchronously.
IPython.parallel.apps.logwatcher	A simple logger object that consolidates messages incoming from ipcluster processes.
IPython.parallel.apps.win32support	Utility for forwarding file read events over a zmq socket.
IPython.parallel.apps.winhpcjob	Job and task components for writing .xml files that the Windows HPC Server 2008 can use to start jobs.
IPython.parallel.client.asyncresult	AsyncResult objects for the client
IPython.parallel.client.client	A semi-synchronous Client for the ZMQ cluster
IPython.parallel.client.magics	Magic command interface for interactive parallel work.
IPython.parallel.client.map	Classes used in scattering and gathering sequences.
IPython.parallel.client.remotefunction	Remote Functions and decorators for Views.
IPython.parallel.client.view	Views of remote engines.
IPython.parallel.controller.dependency	Dependency utilities
IPython.parallel.controller.dictdb	A Task logger that presents our DB interface, but exists entirely in memory and implemented with dicts.
IPython.parallel.controller.heartmonitor	A multi-heart Heartbeat system using PUB and ROUTER sockets.
IPython.parallel.controller.hub	The IPython Controller Hub with 0MQ This is the master object that handles connections from engines and clients, and monitors traffic through the various queues.
IPython.parallel.controller.mongodb	A TaskRecord backend using mongodb
IPython.parallel.controller.scheduler	The Python scheduler for rich scheduling.
IPython.parallel.controller.sqlitedb	A TaskRecord backend using sqlite3
IPython.parallel.engine.engine	A simple engine that talks to a controller over 0MQ.
IPython.parallel.error	Classes and functions for kernel related errors and exceptions.
IPython.parallel.factory	Base config factories.
IPython.parallel.util	Some generic utilities for dealing with classes, urls, and serialization.
IPython.qt.base_frontend_mixin	Defines a convenient mix-in class for implementing Qt frontends.
IPython.qt.client	Defines a KernelClient that provides signals and slots.
IPython.qt.console.ansi_code_processor	Utilities for processing ANSI escape codes and special ASCII characters.
IPython.qt.console.bracket_matcher	Provides bracket matching for Q[Plain]TextEdit widgets.
IPython.qt.console.call_tip_widget
IPython.qt.console.completion_html	A navigable completer for the qtconsole
IPython.qt.console.completion_lexer
IPython.qt.console.completion_plain	A simple completer for the qtconsole
IPython.qt.console.completion_widget	A dropdown completer widget for the qtconsole.
IPython.qt.console.console_widget	An abstract base class for console-type widgets.
IPython.qt.console.frontend_widget
IPython.qt.console.history_console_widget
IPython.qt.console.ipython_widget	A FrontendWidget that emulates the interface of the console IPython.
IPython.qt.console.kill_ring	A generic Emacs-style kill ring, as well as a Qt-specific version.
IPython.qt.console.mainwindow	The Qt MainWindow for the QtConsole
IPython.qt.console.pygments_highlighter
IPython.qt.console.qtconsoleapp	A minimal application using the Qt console-style IPython frontend.
IPython.qt.console.rich_ipython_widget
IPython.qt.console.styles	Style utilities, templates, and defaults for syntax highlighting widgets.
IPython.qt.inprocess	Defines an in-process KernelManager with signals and slots.
IPython.qt.kernel_mixins	Defines a KernelManager that provides signals and slots.
IPython.qt.manager	Defines a KernelClient that provides signals and slots.
IPython.qt.rich_text	Defines classes and functions for working with Qt’s rich text system.
IPython.qt.svg	Defines utility functions for working with SVG documents in Qt.
IPython.qt.util	Defines miscellaneous Qt-related helper classes and functions.
IPython.sphinxext.custom_doctests	Handlers for IPythonDirective’s @doctest pseudo-decorator.
IPython.sphinxext.ipython_console_highlighting	reST directive for syntax-highlighting ipython interactive sessions.
IPython.sphinxext.ipython_directive	Sphinx directive to support embedded IPython code.
IPython.terminal.console.app	A minimal application using the ZMQ-based terminal IPython frontend.
IPython.terminal.console.completer	Adapt readline completer interface to make ZMQ request.
IPython.terminal.console.interactiveshell	terminal client to the IPython kernel
IPython.terminal.embed	An embedded IPython shell.
IPython.terminal.interactiveshell	Subclass of InteractiveShell for terminal based frontends.
IPython.terminal.ipapp	The Application object for the command line ipython program.
IPython.testing	Testing support (tools to test IPython itself).
IPython.testing.decorators	Decorators for labeling test objects.
IPython.testing.globalipapp	Global IPython app to support test running.
IPython.testing.iptest	IPython Test Suite Runner.
IPython.testing.iptestcontroller	IPython Test Process Controller
IPython.testing.ipunittest	Experimental code for cleaner support of IPython syntax with unittest.
IPython.testing.skipdoctest	Decorators marks that a doctest should be skipped, for both python 2 and 3.
IPython.testing.tools	Generic testing tools.
IPython.utils.PyColorize	Class and program to colorize python source code for ANSI terminals.
IPython.utils.capture	IO capturing utilities.
IPython.utils.codeutil	Utilities to enable code objects to be pickled.
IPython.utils.coloransi	Tools for coloring text in ANSI terminals.
IPython.utils.contexts	Context managers for temporarily updating dictionaries.
IPython.utils.daemonize	daemonize function from twisted.scripts._twistd_unix.
IPython.utils.data	Utilities for working with data structures like lists, dicts and tuples.
IPython.utils.decorators	Decorators that don’t go anywhere else.
IPython.utils.dir2	A fancy version of Python’s builtin dir() function.
IPython.utils.doctestreload	A utility for handling the reloading of doctest.
IPython.utils.encoding	Utilities for dealing with text encodings
IPython.utils.frame	Utilities for working with stack frames.
IPython.utils.generics	Generic functions for extending IPython.
IPython.utils.importstring	A simple utility to import something by its string name.
IPython.utils.io	IO related utilities.
IPython.utils.ipstruct	A dict subclass that supports attribute style access.
IPython.utils.jsonutil	Utilities to manipulate JSON objects.
IPython.utils.localinterfaces	Simple utility for building a list of local IPs using the socket module.
IPython.utils.module_paths	Utility functions for finding modules
IPython.utils.openpy	Tools to open .py files as Unicode, using the encoding specified within the file, as per PEP 263.
IPython.utils.path	Utilities for path handling.
IPython.utils.pickleshare	PickleShare - a small ‘shelve’ like datastore with concurrency support
IPython.utils.pickleutil	Pickle related utilities.
IPython.utils.process	Utilities for working with external processes.
IPython.utils.rlineimpl	Imports and provides the ‘correct’ version of readline for the platform.
IPython.utils.signatures	Function signature objects for callables.
IPython.utils.strdispatch	String dispatch class to match regexps and dispatch commands.
IPython.utils.submodule	utilities for checking submodule status
IPython.utils.sysinfo	Utilities for getting information about IPython and the system it’s running in.
IPython.utils.syspathcontext	Context managers for adding things to sys.path temporarily.
IPython.utils.tempdir	TemporaryDirectory class, copied from Python 3.2.
IPython.utils.terminal	Utilities for working with terminals.
IPython.utils.text	Utilities for working with strings and text.
IPython.utils.timing	Utilities for timing code execution.
IPython.utils.traitlets	A lightweight Traits like module.
IPython.utils.tz	Timezone utilities
IPython.utils.ulinecache	Wrapper around linecache which decodes files to unicode according to PEP 263.
IPython.utils.version	Utilities for version comparison
IPython.utils.warn	Utilities for warnings.
IPython.utils.wildcard	Support for wildcard pattern matching in object inspection.
IPython.utils.zmqrelated	Utilities for checking zmq versions.