The IPython API

Release:0.13 Date:June 30, 2012

• IPython
  • IPython
• config.application
  • Module: config.application
  • Classes
    • Application
    • ApplicationError
  • Functions
• config.configurable
  • Module: config.configurable
  • Classes
    • Configurable
    • ConfigurableError
    • LoggingConfigurable
    • MultipleInstanceError
    • SingletonConfigurable
• config.loader
  • Module: config.loader
    • Authors
  • Classes
    • ArgParseConfigLoader
    • ArgumentError
    • ArgumentParser
    • CommandLineConfigLoader
    • Config
    • ConfigError
    • ConfigFileNotFound
    • ConfigLoader
    • ConfigLoaderError
    • FileConfigLoader
    • KVArgParseConfigLoader
    • KeyValueConfigLoader
    • PyFileConfigLoader
  • Function
• core.alias
  • Module: core.alias
  • Classes
    • AliasError
    • AliasManager
    • InvalidAliasError
  • Function
• core.application
  • Module: core.application
  • BaseIPythonApplication
• core.autocall
  • Module: core.autocall
    • Notes
  • Classes
    • ExitAutocall
    • IPyAutocall
    • ZMQExitAutocall
• core.builtin_trap
  • Module: core.builtin_trap
  • BuiltinTrap
• core.compilerop
  • Module: core.compilerop
    • Authors
  • CachingCompiler
• core.completer
  • Module: core.completer
  • Classes
    • Bunch
    • Completer
    • CompletionSplitter
    • IPCompleter
  • Functions
• core.completerlib
  • Module: core.completerlib
  • Functions
• core.crashhandler
  • Module: core.crashhandler
  • CrashHandler
• core.debugger
  • Module: core.debugger
  • Classes
    • Pdb
    • Tracer
  • Functions
• core.display
  • Module: core.display
  • Classes
    • DisplayObject
    • HTML
    • Image
    • JSON
    • Javascript
    • Latex
    • Math
    • Pretty
    • SVG
  • Functions
• core.display_trap
  • Module: core.display_trap
  • DisplayTrap
• core.displayhook
  • Module: core.displayhook
  • DisplayHook
• core.displaypub
  • Module: core.displaypub
  • Class
  • DisplayPublisher
  • Functions
• core.error
  • Module: core.error
    • Notes
  • Classes
    • IPythonCoreError
    • StdinNotImplementedError
    • TryNext
    • UsageError
• core.excolors
  • Module: core.excolors
• core.extensions
  • Module: core.extensions
  • ExtensionManager
• core.formatters
  • Module: core.formatters
  • Classes
    • BaseFormatter
    • DisplayFormatter
    • FormatterABC
    • HTMLFormatter
    • JPEGFormatter
    • JSONFormatter
    • JavascriptFormatter
    • LatexFormatter
    • PNGFormatter
    • PlainTextFormatter
    • SVGFormatter
  • Function
• core.history
  • Module: core.history
  • Classes
    • DummyDB
    • HistoryAccessor
    • HistoryManager
    • HistorySavingThread
  • Functions
• core.hooks
  • Module: core.hooks
  • Class
  • CommandChainDispatcher
  • Functions
• core.inputsplitter
  • Module: core.inputsplitter
    • Syntax Transformations
    • ToDo
    • Authors
  • Classes
    • EscapedTransformer
    • IPythonInputSplitter
    • InputSplitter
  • Functions
• core.interactiveshell
  • Module: core.interactiveshell
  • Classes
    • Bunch
    • InteractiveShell
    • InteractiveShellABC
    • NoOpContext
    • ReadlineNoRecord
    • RemoteError
    • SeparateUnicode
    • SpaceInInput
  • Functions
• core.ipapi
  • Module: core.ipapi
• core.logger
  • Module: core.logger
  • Logger
• core.macro
  • Module: core.macro
  • Macro
• core.magic
  • Module: core.magic
  • Classes
    • Bunch
    • Magics
    • MagicsManager
  • Functions
• core.magic_arguments
  • Module: core.magic_arguments
  • Classes
    • ArgDecorator
    • MagicArgumentParser
    • MagicHelpFormatter
    • argument
    • argument_group
    • kwds
    • magic_arguments
  • Functions
• core.magics
  • Module: core.magics
  • UserMagics
• core.magics.auto
  • Module: core.magics.auto
  • AutoMagics
• core.magics.basic
  • Module: core.magics.basic
  • BasicMagics
• core.magics.code
  • Module: core.magics.code
  • Classes
    • CodeMagics
    • MacroToEdit
• core.magics.config
  • Module: core.magics.config
  • ConfigMagics
• core.magics.deprecated
  • Module: core.magics.deprecated
  • DeprecatedMagics
• core.magics.execution
  • Module: core.magics.execution
  • ExecutionMagics
• core.magics.extension
  • Module: core.magics.extension
  • ExtensionMagics
• core.magics.history
  • Module: core.magics.history
  • HistoryMagics
• core.magics.logging
  • Module: core.magics.logging
  • LoggingMagics
• core.magics.namespace
  • Module: core.magics.namespace
  • NamespaceMagics
• core.magics.osm
  • Module: core.magics.osm
  • OSMagics
• core.magics.pylab
  • Module: core.magics.pylab
  • PylabMagics
• core.magics.script
  • Module: core.magics.script
  • ScriptMagics
• core.oinspect
  • Module: core.oinspect
  • Class
  • Inspector
  • Functions
• core.page
  • Module: core.page
    • Notes
  • Functions
• core.payload
  • Module: core.payload
  • PayloadManager
• core.payloadpage
  • Module: core.payloadpage
  • Functions
• core.plugin
  • Module: core.plugin
  • Classes
    • Plugin
    • PluginManager
• core.prefilter
  • Module: core.prefilter
  • Classes
    • AliasChecker
    • AliasHandler
    • AssignMagicTransformer
    • AssignSystemTransformer
    • AssignmentChecker
    • AutoHandler
    • AutoMagicChecker
    • AutocallChecker
    • EmacsChecker
    • EmacsHandler
    • EscCharsChecker
    • HelpHandler
    • IPyAutocallChecker
    • IPyPromptTransformer
    • MacroChecker
    • MacroHandler
    • MagicHandler
    • MultiLineMagicChecker
    • PrefilterChecker
    • PrefilterError
    • PrefilterHandler
    • PrefilterManager
    • PrefilterTransformer
    • PyPromptTransformer
    • PythonOpsChecker
    • ShellEscapeChecker
    • ShellEscapeHandler
  • Function
• core.profileapp
  • Module: core.profileapp
  • Classes
    • ProfileApp
    • ProfileCreate
    • ProfileList
    • ProfileLocate
  • Functions
• core.profiledir
  • Module: core.profiledir
  • Classes
    • ProfileDir
    • ProfileDirError
• core.prompts
  • Module: core.prompts
  • Classes
    • LazyEvaluate
    • PromptManager
    • UserNSFormatter
  • Functions
• core.pylabtools
  • Module: core.pylabtools
    • Authors
  • Functions
• core.shellapp
  • Module: core.shellapp
    • Authors
  • InteractiveShellApp
• core.splitinput
  • Module: core.splitinput
  • LineInfo
• core.ultratb
  • Module: core.ultratb
  • Classes
    • AutoFormattedTB
    • ColorTB
    • FormattedTB
    • ListTB
    • SyntaxTB
    • TBTools
    • VerboseTB
  • Functions
• core.usage
  • Module: core.usage
• lib.backgroundjobs
  • Module: lib.backgroundjobs
  • Classes
    • BackgroundJobBase
    • BackgroundJobExpr
    • BackgroundJobFunc
    • BackgroundJobManager
• lib.clipboard
  • Module: lib.clipboard
  • Functions
• lib.deepreload
  • Module: lib.deepreload
  • Functions
• lib.demo
  • Module: lib.demo
    • Provided classes
    • Subclassing
    • Operation
    • Example
  • Classes
    • ClearDemo
    • ClearIPDemo
    • ClearMixin
    • Demo
    • DemoError
    • IPythonDemo
    • IPythonLineDemo
    • LineDemo
  • Function
• lib.display
  • Module: lib.display
  • YouTubeVideo
• lib.guisupport
  • Module: lib.guisupport
  • Functions
• lib.inputhook
  • Module: lib.inputhook
  • InputHookManager
• lib.inputhookglut
  • Module: lib.inputhookglut
  • Functions
• lib.inputhookpyglet
  • Module: lib.inputhookpyglet
• lib.inputhookqt4
  • Module: lib.inputhookqt4
• lib.irunner
  • Module: lib.irunner
  • Classes
    • IPythonRunner
    • InteractiveRunner
    • PythonRunner
    • RunnerFactory
    • SAGERunner
  • Functions
• lib.kernel
  • Module: lib.kernel
  • Functions
• lib.latextools
  • Module: lib.latextools
  • Functions
• lib.pretty
  • Module: lib.pretty
    • Example Usage
    • Extending
  • Classes
    • Breakable
    • Group
    • GroupQueue
    • PrettyPrinter
    • Printable
    • RepresentationPrinter
    • Text
  • Functions
• lib.security
  • Module: lib.security
  • Functions
• nbformat.current
  • Module: nbformat.current
  • Class
  • NBFormatError
  • Functions
• nbformat.v1.convert
  • Module: nbformat.v1.convert
• nbformat.v1.nbbase
  • Module: nbformat.v1.nbbase
  • Class
  • NotebookNode
  • Functions
• nbformat.v1.nbjson
  • Module: nbformat.v1.nbjson
  • Classes
    • JSONReader
    • JSONWriter
• nbformat.v1.rwbase
  • Module: nbformat.v1.rwbase
  • Classes
    • NotebookReader
    • NotebookWriter
• nbformat.v2
  • Module: nbformat.v2
• nbformat.v2.convert
  • Module: nbformat.v2.convert
• nbformat.v2.nbbase
  • Module: nbformat.v2.nbbase
  • Class
  • NotebookNode
  • Functions
• nbformat.v2.nbjson
  • Module: nbformat.v2.nbjson
  • Classes
    • BytesEncoder
    • JSONReader
    • JSONWriter
• nbformat.v2.nbpy
  • Module: nbformat.v2.nbpy
  • Classes
    • PyReader
    • PyReaderError
    • PyWriter
• nbformat.v2.nbxml
  • Module: nbformat.v2.nbxml
  • XMLReader
• nbformat.v2.rwbase
  • Module: nbformat.v2.rwbase
  • Classes
    • NotebookReader
    • NotebookWriter
  • Functions
• nbformat.v3
  • Module: nbformat.v3
• nbformat.v3.convert
  • Module: nbformat.v3.convert
• nbformat.v3.nbbase
  • Module: nbformat.v3.nbbase
  • Class
  • NotebookNode
  • Functions
• nbformat.v3.nbjson
  • Module: nbformat.v3.nbjson
  • Classes
    • BytesEncoder
    • JSONReader
    • JSONWriter
• nbformat.v3.nbpy
  • Module: nbformat.v3.nbpy
  • Classes
    • PyReader
    • PyReaderError
    • PyWriter
• nbformat.v3.rwbase
  • Module: nbformat.v3.rwbase
  • Classes
    • NotebookReader
    • NotebookWriter
  • Functions
• parallel
  • Module: parallel
• parallel.apps.baseapp
  • Module: parallel.apps.baseapp
  • Classes
    • BaseParallelApplication
    • PIDFileError
    • ParallelCrashHandler
• parallel.apps.ipclusterapp
  • Module: parallel.apps.ipclusterapp
  • Classes
    • IPClusterApp
    • IPClusterEngines
    • IPClusterStart
    • IPClusterStop
  • Functions
• parallel.apps.ipcontrollerapp
  • Module: parallel.apps.ipcontrollerapp
  • IPControllerApp
• parallel.apps.ipengineapp
  • Module: parallel.apps.ipengineapp
  • Classes
    • IPEngineApp
    • MPI
    • SimpleStruct
  • Function
• parallel.apps.iploggerapp
  • Module: parallel.apps.iploggerapp
  • IPLoggerApp
• parallel.apps.launcher
  • Module: parallel.apps.launcher
  • Classes
    • BaseLauncher
    • BatchClusterAppMixin
    • BatchSystemLauncher
    • ClusterAppMixin
    • ControllerMixin
    • DeprecatedMPILauncher
    • EngineMixin
    • IPClusterLauncher
    • LSFControllerLauncher
    • LSFEngineSetLauncher
    • LSFLauncher
    • LauncherError
    • LocalControllerLauncher
    • LocalEngineLauncher
    • LocalEngineSetLauncher
    • LocalProcessLauncher
    • MPIControllerLauncher
    • MPIEngineSetLauncher
    • MPIExecControllerLauncher
    • MPIExecEngineSetLauncher
    • MPIExecLauncher
    • MPILauncher
    • PBSControllerLauncher
    • PBSEngineSetLauncher
    • PBSLauncher
    • ProcessStateError
    • SGEControllerLauncher
    • SGEEngineSetLauncher
    • SGELauncher
    • SSHClusterLauncher
    • SSHControllerLauncher
    • SSHEngineLauncher
    • SSHEngineSetLauncher
    • SSHLauncher
    • SSHProxyEngineSetLauncher
    • UnknownStatus
    • WindowsHPCControllerLauncher
    • WindowsHPCEngineSetLauncher
    • WindowsHPCLauncher
  • Function
• parallel.apps.logwatcher
  • Module: parallel.apps.logwatcher
  • LogWatcher
• parallel.apps.win32support
  • Module: parallel.apps.win32support
  • ForwarderThread
• parallel.apps.winhpcjob
  • Module: parallel.apps.winhpcjob
  • Classes
    • IPControllerJob
    • IPControllerTask
    • IPEngineSetJob
    • IPEngineTask
    • WinHPCJob
    • WinHPCTask
  • Functions
• parallel.client.asyncresult
  • Module: parallel.client.asyncresult
  • Classes
    • AsyncHubResult
    • AsyncMapResult
    • AsyncResult
  • Function
• parallel.client.client
  • Module: parallel.client.client
  • Classes
    • Client
    • ExecuteReply
    • Metadata
  • Function
• parallel.client.magics
  • Module: parallel.client.magics
    • Usage
      • Examples
  • Class
  • ParallelMagics
  • Functions
• parallel.client.map
  • Module: parallel.client.map
  • Classes
    • Map
    • RoundRobinMap
  • Function
• parallel.client.remotefunction
  • Module: parallel.client.remotefunction
  • Classes
    • ParallelFunction
    • RemoteFunction
  • Functions
• parallel.client.view
  • Module: parallel.client.view
  • Classes
    • DirectView
    • LoadBalancedView
    • View
  • Functions
• parallel.controller.dependency
  • Module: parallel.controller.dependency
  • Classes
    • Dependency
    • depend
    • dependent
  • Function
• parallel.controller.dictdb
  • Module: parallel.controller.dictdb
  • Classes
    • BaseDB
    • CompositeFilter
    • DictDB
    • NoDB
• parallel.controller.heartmonitor
  • Module: parallel.controller.heartmonitor
  • Classes
    • Heart
    • HeartMonitor
• parallel.controller.hub
  • Module: parallel.controller.hub
  • Classes
    • EngineConnector
    • Hub
    • HubFactory
  • Functions
• parallel.controller.scheduler
  • Module: parallel.controller.scheduler
  • Classes
    • Job
    • TaskScheduler
  • Functions
• parallel.controller.sqlitedb
  • Module: parallel.controller.sqlitedb
  • SQLiteDB
• parallel.engine.engine
  • Module: parallel.engine.engine
  • EngineFactory
• parallel.error
  • Module: parallel.error
  • Classes
    • AbortedPendingDeferredError
    • ClientError
    • CompositeError
    • ConnectionError
    • ControllerCreationError
    • ControllerError
    • DependencyTimeout
    • EngineCreationError
    • EngineError
    • FileTimeoutError
    • IPythonError
    • IdInUse
    • ImpossibleDependency
    • InvalidClientID
    • InvalidDeferredID
    • InvalidDependency
    • InvalidEngineID
    • InvalidProperty
    • KernelError
    • MessageSizeError
    • MissingBlockArgument
    • NoEnginesRegistered
    • NotAPendingResult
    • NotDefined
    • PBMessageSizeError
    • ProtocolError
    • QueueCleared
    • RemoteError
    • ResultAlreadyRetrieved
    • ResultNotCompleted
    • SecurityError
    • SerializationError
    • StopLocalExecution
    • TaskAborted
    • TaskRejectError
    • TaskTimeout
    • TimeoutError
    • UnmetDependency
    • UnpickleableException
  • Functions
• parallel.factory
  • Module: parallel.factory
  • RegistrationFactory
• parallel.util
  • Module: parallel.util
  • Classes
    • Namespace
    • ReverseDict
  • Functions
• testing
  • Module: testing
• testing.decorators
  • Module: testing.decorators
    • Authors
  • Functions
• testing.globalipapp
  • Module: testing.globalipapp
  • Classes
    • StreamProxy
    • py_file_finder
  • Functions
• testing.ipunittest
  • Module: testing.ipunittest
    • Authors
  • Classes
    • Doc2UnitTester
    • IPython2PythonConverter
  • Functions
• testing.mkdoctests
  • Module: testing.mkdoctests
  • Classes
    • IndentOut
    • RunnerFactory
  • Function
• testing.nose_assert_methods
  • Module: testing.nose_assert_methods
  • Functions
• testing.nosepatch
  • Module: testing.nosepatch
• testing.plugin.dtexample
  • Module: testing.plugin.dtexample
  • Functions
• testing.plugin.show_refs
  • Module: testing.plugin.show_refs
  • C
• testing.plugin.simple
  • Module: testing.plugin.simple
  • Functions
• testing.plugin.test_ipdoctest
  • Module: testing.plugin.test_ipdoctest
  • Functions
• testing.plugin.test_refs
  • Module: testing.plugin.test_refs
  • Functions
• testing.skipdoctest
  • Module: testing.skipdoctest
  • Functions
• testing.tools
  • Module: testing.tools
    • Authors
  • Classes
    • AssertNotPrints
    • AssertPrints
    • TempFileMixin
  • Functions
• utils.PyColorize
  • Module: utils.PyColorize
  • Parser
• utils.attic
  • Module: utils.attic
  • Classes
    • EvalDict
    • NotGiven
  • Functions
• utils.autoattr
  • Module: utils.autoattr
    • References
    • Notes
    • Authors
  • Classes
    • OneTimeProperty
    • ResetMixin
  • Function
• utils.codeutil
  • Module: utils.codeutil
  • Functions
• utils.coloransi
  • Module: utils.coloransi
  • Classes
    • ColorScheme
    • ColorSchemeTable
    • InputTermColors
    • NoColors
    • TermColors
  • Function
• utils.daemonize
  • Module: utils.daemonize
• utils.data
  • Module: utils.data
  • Functions
• utils.decorators
  • Module: utils.decorators
• utils.dir2
  • Module: utils.dir2
  • Functions
• utils.doctestreload
  • Module: utils.doctestreload
  • Functions
• utils.encoding
  • Module: utils.encoding
  • Functions
• utils.frame
  • Module: utils.frame
  • Functions
• utils.generics
  • Module: utils.generics
  • Functions
• utils.growl
  • Module: utils.growl
  • Classes
    • IPythonGrowlError
    • Notifier
  • Functions
• utils.importstring
  • Module: utils.importstring
• utils.io
  • Module: utils.io
  • Classes
    • CapturedIO
    • IOStream
    • IOTerm
    • NLprinter
    • Tee
    • capture_output
  • Functions
• utils.ipstruct
  • Module: utils.ipstruct
  • Struct
• utils.jsonutil
  • Module: utils.jsonutil
  • Functions
• utils.module_paths
  • Module: utils.module_paths
  • Functions
• utils.nested_context
  • Module: utils.nested_context
• utils.newserialized
  • Module: utils.newserialized
  • Classes
    • ISerialized
    • IUnSerialized
    • SerializationError
    • SerializeIt
    • Serialized
    • UnSerializeIt
    • UnSerialized
  • Functions
• utils.notification
  • Module: utils.notification
  • Classes
    • NotificationCenter
    • NotificationError
• utils.openpy
  • Module: utils.openpy
  • Functions
• utils.path
  • Module: utils.path
  • Class
  • HomeDirError
  • Functions
• utils.pickleshare
  • Module: utils.pickleshare
  • Classes
    • PickleShareDB
    • PickleShareLink
  • Functions
• utils.pickleutil
  • Module: utils.pickleutil
  • Classes
    • CannedFunction
    • CannedObject
    • Reference
  • Functions
• utils.process
  • Module: utils.process
  • Class
  • FindCmdError
  • Functions
• utils.py3compat
  • Module: utils.py3compat
  • Functions
• utils.strdispatch
  • Module: utils.strdispatch
  • StrDispatch
• utils.sysinfo
  • Module: utils.sysinfo
  • Functions
• utils.syspathcontext
  • Module: utils.syspathcontext
  • Classes
    • appended_to_syspath
    • prepended_to_syspath
• utils.terminal
  • Module: utils.terminal
  • Functions
• utils.text
  • Module: utils.text
  • Classes
    • DollarFormatter
    • EvalFormatter
    • FullEvalFormatter
    • LSString
    • SList
  • Functions
• utils.timing
  • Module: utils.timing
  • Functions
• utils.traitlets
  • Module: utils.traitlets
  • Classes
    • Any
    • Bool
    • Bytes
    • CBool
    • CBytes
    • CComplex
    • CFloat
    • CInt
    • CRegExp
    • CUnicode
    • CaselessStrEnum
    • ClassBasedTraitType
    • Complex
    • Container
    • DefaultValueGenerator
    • Dict
    • DottedObjectName
    • Enum
    • Float
    • HasTraits
    • Instance
    • Int
    • List
    • MetaHasTraits
    • NoDefaultSpecified
    • ObjectName
    • Set
    • TCPAddress
    • This
    • TraitError
    • TraitType
    • Tuple
    • Type
    • Undefined
    • Unicode
  • Functions
• utils.upgradedir
  • Module: utils.upgradedir
  • Functions
• utils.warn
  • Module: utils.warn
  • Functions
• utils.wildcard
  • Module: utils.wildcard
    • Authors
  • Functions