Note

This documentation is for a development version of IPython. There may be significant differences from the latest stable release (0.13.2).

The IPython API

Release:1.2.0 Date:February 05, 2014

• IPython
  • 3 Functions
• Module: config.application
  • 3 Classes
  • 2 Functions
• Module: config.configurable
  • 5 Classes
• Module: config.loader
  • Authors
  • 13 Classes
  • 1 Function
• Module: consoleapp
  • 1 Class
• Module: core.alias
  • 3 Classes
  • 1 Function
• Module: core.application
  • 1 Class
• Module: core.autocall
  • Notes
  • 3 Classes
• Module: core.builtin_trap
  • 1 Class
• Module: core.compilerop
  • Authors
  • 1 Class
  • 2 Functions
• Module: core.completer
  • 4 Classes
  • 5 Functions
• Module: core.completerlib
  • 10 Functions
• Module: core.crashhandler
  • 1 Class
  • 1 Function
• Module: core.debugger
  • 2 Classes
  • 3 Functions
• Module: core.display
  • 9 Classes
  • 10 Functions
• Module: core.display_trap
  • 1 Class
• Module: core.displayhook
  • 1 Class
• Module: core.displaypub
  • 1 Class
  • 1 Function
• Module: core.error
  • Notes
  • 4 Classes
• Module: core.excolors
  • 1 Function
• Module: core.extensions
  • 1 Class
• Module: core.formatters
  • 11 Classes
  • 1 Function
• Module: core.getipython
  • 1 Function
• Module: core.history
  • 5 Classes
  • 3 Functions
• Module: core.historyapp
  • 2 Classes
• Module: core.hooks
  • 1 Class
  • 10 Functions
• Module: core.inputsplitter
  • Syntax Transformations
  • ToDo
  • Authors
  • 2 Classes
  • 5 Functions
• Module: core.inputtransformer
  • 5 Classes
  • 12 Functions
• Module: core.interactiveshell
  • 5 Classes
  • 1 Function
• Module: core.logger
  • 1 Class
• Module: core.macro
  • 1 Class
• Module: core.magic
  • 4 Classes
  • 6 Functions
• Module: core.magic_arguments
  • 9 Classes
  • 3 Functions
• Module: core.magics
  • 1 Class
• Module: core.magics.auto
  • 1 Class
• Module: core.magics.basic
  • 2 Classes
• Module: core.magics.code
  • 3 Classes
• Module: core.magics.config
  • 1 Class
• Module: core.magics.deprecated
  • 1 Class
• Module: core.magics.display
  • 1 Class
• Module: core.magics.execution
  • 1 Class
  • 1 Function
• Module: core.magics.extension
  • 1 Class
• Module: core.magics.history
  • 1 Class
• Module: core.magics.logging
  • 1 Class
• Module: core.magics.namespace
  • 1 Class
• Module: core.magics.osm
  • 1 Class
• Module: core.magics.pylab
  • 1 Class
• Module: core.magics.script
  • 1 Class
  • 1 Function
• Module: core.oinspect
  • 1 Class
  • 10 Functions
• Module: core.page
  • Notes
  • 7 Functions
• Module: core.payload
  • 1 Class
• Module: core.payloadpage
  • 2 Functions
• Module: core.prefilter
  • 18 Classes
  • 1 Function
• Module: core.profileapp
  • 4 Classes
  • 2 Functions
• Module: core.profiledir
  • 2 Classes
• Module: core.prompts
  • 3 Classes
  • 3 Functions
• Module: core.pylabtools
  • Authors
  • 10 Functions
• Module: core.shellapp
  • Authors
  • 1 Class
• Module: core.splitinput
  • 1 Class
  • 1 Function
• Module: core.ultratb
  • 7 Classes
  • 6 Functions
• Module: core.usage
  • 1 Function
• Module: html.auth.login
  • 1 Class
• Module: html.auth.logout
  • 1 Class
• Module: html.base.handlers
  • 5 Classes
• Module: html.base.zmqhandlers
  • 2 Classes
• Module: html.fabfile
  • 1 Function
• Module: html.notebook.handlers
  • 4 Classes
• Module: html.notebookapp
  • 2 Classes
  • 2 Functions
• Module: html.services.clusters.clustermanager
  • 2 Classes
• Module: html.services.clusters.handlers
  • 3 Classes
• Module: html.services.notebooks.azurenbmanager
  • 1 Class
• Module: html.services.notebooks.filenbmanager
  • 1 Class
• Module: html.services.notebooks.handlers
  • 4 Classes
• Module: html.services.notebooks.nbmanager
  • 1 Class
• Module: html.tree.handlers
  • 1 Class
• Module: html.utils
  • 1 Function
• Module: lib.backgroundjobs
  • 4 Classes
• Module: lib.clipboard
  • 3 Functions
• Module: lib.deepreload
  • 9 Functions
• Module: lib.demo
  • Provided classes
  • Subclassing
  • Operation
  • Example
  • 8 Classes
  • 1 Function
• Module: lib.display
  • 6 Classes
• Module: lib.editorhooks
  • 11 Functions
• Module: lib.guisupport
  • 6 Functions
• Module: lib.inputhook
  • 1 Class
  • 1 Function
• Module: lib.inputhookglut
  • 6 Functions
• Module: lib.inputhookpyglet
  • 3 Functions
• Module: lib.inputhookqt4
  • 1 Function
• Module: lib.irunner
  • Notes
  • 5 Classes
  • 2 Functions
• Module: lib.latextools
  • 1 Class
  • 7 Functions
• Module: lib.pretty
  • Example Usage
  • Extending
  • 8 Classes
  • 4 Functions
• Module: lib.security
  • 2 Functions
• Module: nbconvert.exporters.export
  • 1 Class
  • 4 Functions
• Module: nbconvert.exporters.exporter
  • 2 Classes
• Module: nbconvert.exporters.html
  • 1 Class
• Module: nbconvert.exporters.latex
  • 1 Class
• Module: nbconvert.exporters.markdown
  • 1 Class
• Module: nbconvert.exporters.python
  • 1 Class
• Module: nbconvert.exporters.slides
  • 1 Class
• Module: nbconvert.filters.ansi
  • 4 Functions
• Module: nbconvert.filters.datatypefilter
  • 1 Class
• Module: nbconvert.filters.highlight
  • 2 Functions
• Module: nbconvert.filters.latex
  • 2 Functions
• Module: nbconvert.filters.markdown
  • 3 Functions
• Module: nbconvert.filters.strings
  • 10 Functions
• Module: nbconvert.nbconvertapp
  • 2 Classes
• Module: nbconvert.post_processors.base
  • 1 Class
• Module: nbconvert.post_processors.pdf
  • 1 Class
• Module: nbconvert.post_processors.serve
  • 1 Class
• Module: nbconvert.transformers.base
  • 1 Class
• Module: nbconvert.transformers.coalescestreams
  • 2 Functions
• Module: nbconvert.transformers.convertfigures
  • 1 Class
• Module: nbconvert.transformers.csshtmlheader
  • 1 Class
• Module: nbconvert.transformers.extractoutput
  • 1 Class
• Module: nbconvert.transformers.latex
  • 1 Class
• Module: nbconvert.transformers.revealhelp
  • 1 Class
• Module: nbconvert.transformers.sphinx
  • 1 Class
• Module: nbconvert.transformers.svg2pdf
  • 1 Class
• Module: nbconvert.utils.base
  • 1 Class
• Module: nbconvert.utils.console
  • 3 Functions
• Module: nbconvert.utils.exceptions
  • 1 Class
• Module: nbconvert.utils.lexers
  • 1 Class
• Module: nbconvert.utils.pandoc
  • 1 Class
  • 1 Function
• Module: nbconvert.writers.base
  • 1 Class
• Module: nbconvert.writers.debug
  • 1 Class
• Module: nbconvert.writers.files
  • 1 Class
• Module: nbconvert.writers.stdout
  • 1 Class
• Module: nbformat.current
  • 2 Classes
  • 10 Functions
• Module: nbformat.v1.convert
  • 1 Function
• Module: nbformat.v1.nbbase
  • 1 Class
  • 4 Functions
• Module: nbformat.v1.nbjson
  • 2 Classes
• Module: nbformat.v1.rwbase
  • 2 Classes
• Module: nbformat.v2
  • 1 Function
• Module: nbformat.v2.convert
  • 1 Function
• Module: nbformat.v2.nbbase
  • 1 Class
  • 8 Functions
• Module: nbformat.v2.nbjson
  • 3 Classes
• Module: nbformat.v2.nbpy
  • 3 Classes
• Module: nbformat.v2.nbxml
  • 1 Class
  • 1 Function
• Module: nbformat.v2.rwbase
  • 2 Classes
  • 5 Functions
• Module: nbformat.v3
  • 1 Function
• Module: nbformat.v3.convert
  • 1 Function
• Module: nbformat.v3.nbbase
  • 1 Class
  • 9 Functions
• Module: nbformat.v3.nbjson
  • 3 Classes
• Module: nbformat.v3.nbpy
  • 3 Classes
• Module: nbformat.v3.rwbase
  • 2 Classes
  • 5 Functions
• Module: nbformat.v3.validator
  • 3 Functions
• Module: parallel
  • 1 Function
• Module: parallel.apps.baseapp
  • 3 Classes
• Module: parallel.apps.ipclusterapp
  • 4 Classes
  • 1 Function
• Module: parallel.apps.ipcontrollerapp
  • 1 Class
  • 1 Function
• Module: parallel.apps.ipengineapp
  • 2 Classes
• Module: parallel.apps.iploggerapp
  • 1 Class
• Module: parallel.apps.launcher
  • 42 Classes
  • 2 Functions
• Module: parallel.apps.logwatcher
  • 1 Class
• Module: parallel.apps.win32support
  • 1 Class
  • 1 Function
• Module: parallel.apps.winhpcjob
  • 6 Classes
  • 3 Functions
• Module: parallel.client.asyncresult
  • 3 Classes
  • 1 Function
• Module: parallel.client.client
  • 3 Classes
  • 1 Function
• Module: parallel.client.magics
  • Usage
    • Examples
  • 1 Class
  • 2 Functions
• Module: parallel.client.map
  • 2 Classes
  • 1 Function
• Module: parallel.client.remotefunction
  • 2 Classes
  • 4 Functions
• Module: parallel.client.view
  • 3 Classes
  • 3 Functions
• Module: parallel.controller.dependency
  • 3 Classes
  • 1 Function
• Module: parallel.controller.dictdb
  • 4 Classes
• Module: parallel.controller.heartmonitor
  • 2 Classes
• Module: parallel.controller.hub
  • 3 Classes
  • 2 Functions
• Module: parallel.controller.scheduler
  • 2 Classes
  • 7 Functions
• Module: parallel.controller.sqlitedb
  • 1 Class
• Module: parallel.engine.engine
  • 1 Class
• Module: parallel.error
  • 14 Classes
  • 3 Functions
• Module: parallel.factory
  • 1 Class
• Module: parallel.util
  • 2 Classes
  • 16 Functions
• Module: qt.base_frontend_mixin
  • 1 Class
• Module: qt.client
  • 5 Classes
• Module: qt.console.ansi_code_processor
  • 2 Classes
• Module: qt.console.bracket_matcher
  • 1 Class
• Module: qt.console.call_tip_widget
  • 1 Class
• Module: qt.console.completion_html
  • 2 Classes
  • 1 Function
• Module: qt.console.completion_lexer
  • 1 Class
• Module: qt.console.completion_plain
  • 1 Class
• Module: qt.console.completion_widget
  • 1 Class
• Module: qt.console.console_widget
  • 1 Class
  • 2 Functions
• Module: qt.console.history_console_widget
  • 1 Class
• Module: qt.console.ipython_widget
  • 1 Class
• Module: qt.console.kill_ring
  • 2 Classes
• Module: qt.console.mainwindow
  • 1 Class
  • 1 Function
• Module: qt.console.pygments_highlighter
  • 2 Classes
  • 1 Function
• Module: qt.console.qtconsoleapp
  • 1 Class
  • 2 Functions
• Module: qt.console.rich_ipython_widget
  • 1 Class
• Module: qt.console.styles
  • 5 Functions
• Module: qt.inprocess
  • 6 Classes
• Module: qt.kernel_mixins
  • 8 Classes
• Module: qt.manager
  • 2 Classes
• Module: qt.rich_text
  • 1 Class
  • 4 Functions
• Module: qt.svg
  • 3 Functions
• Module: qt.util
  • 2 Classes
  • 1 Function
• Module: sphinxext.ipython_console_highlighting
  • 1 Class
  • 1 Function
• Module: sphinxext.ipython_directive
  • ToDo
  • Authors
  • 2 Classes
  • 3 Functions
• Module: terminal.console.app
  • 1 Class
• Module: terminal.console.completer
  • 1 Class
• Module: terminal.console.interactiveshell
  • 1 Class
• Module: terminal.embed
  • Notes
  • 2 Classes
  • 1 Function
• Module: terminal.interactiveshell
  • 2 Classes
  • 2 Functions
• Module: terminal.ipapp
  • Authors
  • 3 Classes
  • 1 Function
• Module: testing
  • 1 Function
• Module: testing.decorators
  • Authors
  • 8 Functions
• Module: testing.globalipapp
  • 2 Classes
  • 3 Functions
• Module: testing.ipunittest
  • Authors
  • 2 Classes
  • 2 Functions
• Module: testing.mkdoctests
  • 2 Classes
  • 1 Function
• Module: testing.nose_assert_methods
  • 4 Functions
• Module: testing.nosepatch
  • 1 Function
• Module: testing.plugin.dtexample
  • 6 Functions
• Module: testing.plugin.show_refs
  • 1 Class
• Module: testing.plugin.simple
  • 2 Functions
• Module: testing.plugin.test_ipdoctest
  • 4 Functions
• Module: testing.plugin.test_refs
  • 5 Functions
• Module: testing.skipdoctest
  • 2 Functions
• Module: testing.tools
  • Authors
  • 4 Classes
  • 13 Functions
• Module: utils.PyColorize
  • 1 Class
  • 1 Function
• Module: utils.attic
  • 2 Classes
  • 8 Functions
• Module: utils.codeutil
  • 2 Functions
• Module: utils.coloransi
  • 5 Classes
  • 1 Function
• Module: utils.contexts
  • 1 Class
• Module: utils.daemonize
  • 1 Function
• Module: utils.data
  • 3 Functions
• Module: utils.decorators
  • 2 Functions
• Module: utils.dir2
  • 2 Functions
• Module: utils.doctestreload
  • 2 Functions
• Module: utils.encoding
  • 2 Functions
• Module: utils.frame
  • 4 Functions
• Module: utils.generics
  • 2 Functions
• Module: utils.importstring
  • 1 Function
• Module: utils.io
  • 5 Classes
  • 5 Functions
• Module: utils.ipstruct
  • 1 Class
• Module: utils.jsonutil
  • 6 Functions
• Module: utils.module_paths
  • 3 Functions
• Module: utils.nested_context
  • 1 Function
• Module: utils.openpy
  • 8 Functions
• Module: utils.path
  • 1 Class
  • 22 Functions
• Module: utils.pickleshare
  • 2 Classes
  • 4 Functions
• Module: utils.pickleutil
  • 6 Classes
  • 10 Functions
• Module: utils.process
  • 1 Class
  • 4 Functions
• Module: utils.py3compat
  • 1 Class
  • 11 Functions
• Module: utils.rlineimpl
  • 1 Function
• Module: utils.strdispatch
  • 1 Class
• Module: utils.submodule
  • 5 Functions
• Module: utils.sysinfo
  • 4 Functions
• Module: utils.syspathcontext
  • 2 Classes
• Module: utils.tempdir
  • 3 Classes
• Module: utils.terminal
  • 5 Functions
• Module: utils.text
  • 5 Classes
  • 11 Functions
• Module: utils.timing
  • 7 Functions
• Module: utils.traitlets
  • 38 Classes
  • 6 Functions
• Module: utils.tz
  • 1 Class
  • 1 Function
• Module: utils.ulinecache
  • 2 Functions
• Module: utils.version
  • 1 Function
• Module: utils.warn
  • 4 Functions
• Module: utils.wildcard
  • Authors
  • 6 Functions
• Module: utils.zmqrelated
  • 2 Functions