The IPython API

Release:0.10 Date:August 04, 2009

• ColorANSI
  • Module: ColorANSI
  • Classes
    • ColorScheme
    • ColorSchemeTable
    • InputTermColors
    • TermColors
  • Function

• ConfigLoader
  • Module: ConfigLoader
  • Classes
    • ConfigLoader
    • ConfigLoaderError

• CrashHandler
  • Module: CrashHandler
    • Authors
  • Classes
    • CrashHandler
    • IPythonCrashHandler

• DPyGetOpt
  • Module: DPyGetOpt
  • Classes
    • ArgumentError
    • DPyGetOpt
    • Error
    • SpecificationError
    • TerminationError

• Debugger
  • Module: Debugger
  • Classes
    • Pdb
    • Tracer
  • Functions

• Itpl
  • Module: Itpl
  • Classes
    • Itpl
    • ItplError
    • ItplFile
    • ItplNS
  • Functions

• Logger
  • Module: Logger
  • Logger

• Magic
  • Module: Magic
  • Classes
    • Bunch
    • Magic
  • Functions

• OInspect
  • Module: OInspect
  • Classes
    • Inspector
    • myStringIO
  • Functions

• OutputTrap
  • Module: OutputTrap
  • Classes
    • OutputTrap
    • OutputTrapError

• Prompts
  • Module: Prompts
  • Classes
    • BasePrompt
    • CachedOutput
    • Prompt1
    • Prompt2
    • PromptOut
  • Functions

• PyColorize
  • Module: PyColorize
  • Parser

• Shell
  • Module: Shell
  • Classes
    • IPShell
    • IPShellEmbed
    • IPShellGTK
    • IPShellMatplotlib
    • IPShellMatplotlibGTK
    • IPShellMatplotlibQt
    • IPShellMatplotlibQt4
    • IPShellMatplotlibWX
    • IPShellQt
    • IPShellQt4
    • IPShellWX
    • IPThread
    • MTInteractiveShell
    • MatplotlibMTShell
    • MatplotlibShell
    • MatplotlibShellBase
  • Functions

• UserConfig.ipy_user_conf
  • Module: UserConfig.ipy_user_conf
  • Functions

• background_jobs
  • Module: background_jobs
  • Classes
    • BackgroundJobBase
    • BackgroundJobExpr
    • BackgroundJobFunc
    • BackgroundJobManager

• clipboard
  • Module: clipboard
  • Functions

• completer
  • Module: completer
  • Classes
    • Completer
    • IPCompleter

• config.api
  • Module: config.api
  • ConfigObjManager

• config.cutils
  • Module: config.cutils

• deep_reload
  • Module: deep_reload
  • Functions

• demo
  • Module: demo
    • Provided classes
    • Subclassing
    • Operation
    • Example
  • Classes
    • ClearDemo
    • ClearIPDemo
    • ClearMixin
    • Demo
    • DemoError
    • IPythonDemo
    • IPythonLineDemo
    • LineDemo
  • Function

• dtutils
  • Module: dtutils
  • Functions

• excolors
  • Module: excolors

• external.Itpl
  • Module: external.Itpl
  • Classes
    • Itpl
    • ItplError
    • ItplFile
    • ItplNS
  • Functions

• external.argparse
  • Module: external.argparse
  • Classes
    • Action
    • ArgumentDefaultsHelpFormatter
    • ArgumentError
    • ArgumentParser
    • FileType
    • HelpFormatter
    • Namespace
    • RawDescriptionHelpFormatter
    • RawTextHelpFormatter

• external.configobj
  • Module: external.configobj
  • Classes
    • Builder
    • ConfigObj
    • ConfigObjError
    • ConfigParserInterpolation
    • ConfigspecError
    • DuplicateError
    • InterpolationEngine
    • InterpolationError
    • InterpolationLoopError
    • MissingInterpolationOption
    • NestingError
    • ParseError
    • ReloadError
    • RepeatSectionError
    • Section
    • SimpleVal
    • TemplateInterpolation
    • UnknownType
    • UnreprError
  • Functions

• external.guid
  • Module: external.guid
  • Functions

• external.mglob
  • Module: external.mglob
  • Functions

• external.path
  • Module: external.path
  • Classes
    • TreeWalkWarning
    • path

• external.pretty
  • Module: external.pretty
    • Example Usage
    • Extending
  • Classes
    • Breakable
    • Group
    • GroupQueue
    • PrettyPrinter
    • Printable
    • RepresentationPrinter
    • Text
  • Functions

• external.simplegeneric
  • Module: external.simplegeneric
  • Functions

• external.validate
  • Module: external.validate
  • Classes
    • ValidateError
    • Validator
    • VdtMissingValue
    • VdtParamError
    • VdtTypeError
    • VdtUnknownCheckError
    • VdtValueError
    • VdtValueTooBigError
    • VdtValueTooLongError
    • VdtValueTooShortError
    • VdtValueTooSmallError
  • Functions

• frontend.asyncfrontendbase
  • Module: frontend.asyncfrontendbase
  • AsyncFrontEndBase

• frontend.frontendbase
  • Module: frontend.frontendbase
  • Classes
    • FrontEndBase
    • IFrontEnd
    • IFrontEndFactory

• frontend.linefrontendbase
  • Module: frontend.linefrontendbase
  • LineFrontEndBase

• frontend.prefilterfrontend
  • Module: frontend.prefilterfrontend
  • PrefilterFrontEnd

• frontend.process.pipedprocess
  • Module: frontend.process.pipedprocess
  • PipedProcess

• frontend.wx.console_widget
  • Module: frontend.wx.console_widget
  • ConsoleWidget

• frontend.wx.ipythonx
  • Module: frontend.wx.ipythonx
  • Classes
    • IPythonX
    • IPythonXController
  • Function

• frontend.wx.wx_frontend
  • Module: frontend.wx.wx_frontend
  • WxController

• generics
  • Module: generics
  • Functions

• genutils
  • Module: genutils
  • Classes
    • Error
    • EvalDict
    • HomeDirError
    • IOStream
    • IOTerm
    • LSString
    • NLprinter
    • NotGiven
    • SList
    • SystemExec
  • Functions

• gui.wx.ipshell_nonblocking
  • Module: gui.wx.ipshell_nonblocking
  • NonBlockingIPShell

• gui.wx.ipython_history
  • Module: gui.wx.ipython_history
  • Classes
    • IPythonHistoryPanel
    • PythonSTC

• gui.wx.ipython_view
  • Module: gui.wx.ipython_view
  • Classes
    • IPShellWidget
    • WxConsoleView
    • WxNonBlockingIPShell

• gui.wx.thread_ex
  • Module: gui.wx.thread_ex
  • ThreadEx

• gui.wx.wxIPython
  • Module: gui.wx.wxIPython
  • Classes
    • MyApp
    • MyFrame
  • Function

• history
  • Module: history
  • Class
  • ShadowHist
  • Functions

• hooks
  • Module: hooks
  • Class
  • CommandChainDispatcher
  • Functions

• ipapi
  • Module: ipapi
  • Classes
    • DebugTools
    • IPApi
    • IPyAutocall
    • IPythonNotRunning
    • TryNext
    • UsageError
  • Functions

• iplib
  • Module: iplib
  • Classes
    • Bunch
    • InputList
    • InteractiveShell
    • Quitter
    • SpaceInInput
    • SyntaxTB
    • Undefined
  • Functions

• ipmaker
  • Module: ipmaker
  • Functions

• ipstruct
  • Module: ipstruct
  • Struct

• irunner
  • Module: irunner
  • Classes
    • IPythonRunner
    • InteractiveRunner
    • PythonRunner
    • RunnerFactory
    • SAGERunner
  • Functions

• kernel.client
  • Module: kernel.client
  • Functions

• kernel.clientconnector
  • Module: kernel.clientconnector
  • ClientConnector

• kernel.clientinterfaces
  • Module: kernel.clientinterfaces
  • Classes
    • IBlockingClientAdaptor
    • IFCClientInterfaceProvider

• kernel.codeutil
  • Module: kernel.codeutil
  • Functions

• kernel.contexts
  • Module: kernel.contexts
  • Classes
    • RemoteContextBase
    • RemoteMultiEngine
  • Functions

• kernel.controllerservice
  • Module: kernel.controllerservice
  • Classes
    • ControllerAdapterBase
    • ControllerService
    • IControllerBase
    • IControllerCore

• kernel.core.display_formatter
  • Module: kernel.core.display_formatter
  • Classes
    • IDisplayFormatter
    • PPrintDisplayFormatter
    • ReprDisplayFormatter

• kernel.core.display_trap
  • Module: kernel.core.display_trap
  • DisplayTrap

• kernel.core.error
  • Module: kernel.core.error
  • Classes
    • ControllerCreationError
    • ControllerError
    • EngineCreationError
    • EngineError
    • IPythonError

• kernel.core.fd_redirector
  • Module: kernel.core.fd_redirector
  • FDRedirector

• kernel.core.file_like
  • Module: kernel.core.file_like
  • FileLike

• kernel.core.history
  • Module: kernel.core.history
  • Classes
    • FrontEndHistory
    • History
    • InterpreterHistory

• kernel.core.interpreter
  • Module: kernel.core.interpreter
  • Classes
    • Interpreter
    • NotDefined
  • Functions

• kernel.core.macro
  • Module: kernel.core.macro
  • Macro

• kernel.core.magic
  • Module: kernel.core.magic
  • Magic

• kernel.core.message_cache
  • Module: kernel.core.message_cache
  • Classes
    • IMessageCache
    • SimpleMessageCache

• kernel.core.notification
  • Module: kernel.core.notification
  • NotificationCenter

• kernel.core.output_trap
  • Module: kernel.core.output_trap
  • OutputTrap

• kernel.core.prompts
  • Module: kernel.core.prompts
    • Authors
  • Classes
    • BasePrompt
    • CachedOutput
    • Prompt1
    • Prompt2
    • PromptOut
  • Functions

• kernel.core.redirector_output_trap
  • Module: kernel.core.redirector_output_trap
  • RedirectorOutputTrap

• kernel.core.sync_traceback_trap
  • Module: kernel.core.sync_traceback_trap
  • SyncTracebackTrap

• kernel.core.traceback_formatter
  • Module: kernel.core.traceback_formatter
  • Classes
    • ITracebackFormatter
    • PlainTracebackFormatter

• kernel.core.traceback_trap
  • Module: kernel.core.traceback_trap
  • TracebackTrap

• kernel.core.util
  • Module: kernel.core.util
  • Classes
    • Bunch
    • InputList
  • Functions

• kernel.engineconnector
  • Module: kernel.engineconnector
  • EngineConnector

• kernel.enginefc
  • Module: kernel.enginefc
  • Classes
    • EngineFromReference
    • FCEngineReferenceFromService
    • FCRemoteEngineRefFromService
    • IFCControllerBase
    • IFCEngine

• kernel.engineservice
  • Module: kernel.engineservice
  • Classes
    • Command
    • EngineAPI
    • EngineService
    • IEngineBase
    • IEngineCore
    • IEngineProperties
    • IEngineQueued
    • IEngineSerialized
    • IEngineThreaded
    • QueuedEngine
    • StrictDict
    • ThreadedEngineService
  • Functions

• kernel.error
  • Module: kernel.error
  • Classes
    • AbortedPendingDeferredError
    • ClientError
    • CompositeError
    • ConnectionError
    • FileTimeoutError
    • IdInUse
    • InvalidClientID
    • InvalidDeferredID
    • InvalidEngineID
    • InvalidProperty
    • KernelError
    • MessageSizeError
    • MissingBlockArgument
    • NoEnginesRegistered
    • NotAPendingResult
    • NotDefined
    • PBMessageSizeError
    • ProtocolError
    • QueueCleared
    • ResultAlreadyRetrieved
    • ResultNotCompleted
    • SecurityError
    • SerializationError
    • StopLocalExecution
    • TaskAborted
    • TaskRejectError
    • TaskTimeout
    • UnpickleableException
  • Function

• kernel.fcutil
  • Module: kernel.fcutil
  • Functions

• kernel.magic
  • Module: kernel.magic
  • Functions

• kernel.map
  • Module: kernel.map
  • Classes
    • Map
    • RoundRobinMap

• kernel.mapper
  • Module: kernel.mapper
  • Classes
    • IMapper
    • IMultiEngineMapperFactory
    • ITaskMapperFactory
    • MultiEngineMapper
    • SynchronousTaskMapper
    • TaskMapper

• kernel.multiengine
  • Module: kernel.multiengine
  • Classes
    • IEngineMultiplexer
    • IFullMultiEngine
    • IFullSynchronousMultiEngine
    • IMultiEngine
    • IMultiEngineCoordinator
    • IMultiEngineExtras
    • ISynchronousEngineMultiplexer
    • ISynchronousMultiEngine
    • ISynchronousMultiEngineCoordinator
    • ISynchronousMultiEngineExtras
    • MultiEngine
    • SynchronousMultiEngine

• kernel.multiengineclient
  • Module: kernel.multiengineclient
  • Classes
    • FullBlockingMultiEngineClient
    • IFullBlockingMultiEngineClient
    • IPendingResult
    • InteractiveMultiEngineClient
    • PendingResult
    • QueueStatusList
    • ResultList
  • Functions

• kernel.multienginefc
  • Module: kernel.multienginefc
  • Classes
    • FCFullSynchronousMultiEngineClient
    • FCSynchronousMultiEngineFromMultiEngine
    • IFCSynchronousMultiEngine
  • Function

• kernel.newserialized
  • Module: kernel.newserialized
  • Classes
    • ISerialized
    • IUnSerialized
    • SerializeIt
    • Serialized
    • UnSerializeIt
    • UnSerialized
  • Functions

• kernel.parallelfunction
  • Module: kernel.parallelfunction
  • Classes
    • IMultiEngineParallelDecorator
    • IParallelFunction
    • ITaskParallelDecorator
    • ParallelFunction

• kernel.pbutil
  • Module: kernel.pbutil
  • Functions

• kernel.pendingdeferred
  • Module: kernel.pendingdeferred
  • PendingDeferredManager

• kernel.pickleutil
  • Module: kernel.pickleutil
  • Classes
    • CannedFunction
    • CannedObject
  • Functions

• kernel.scripts.ipcluster
  • Module: kernel.scripts.ipcluster
  • Classes
    • BatchEngineSet
    • ControllerLauncher
    • EngineLauncher
    • LauncherProcessProtocol
    • LocalEngineSet
    • PBSEngineSet
    • ProcessLauncher
    • ProcessStateError
    • SSHEngineSet
    • UnknownStatus
  • Functions

• kernel.scripts.ipcontroller
  • Module: kernel.scripts.ipcontroller
  • Functions

• kernel.scripts.ipengine
  • Module: kernel.scripts.ipengine
  • Functions

• kernel.task
  • Module: kernel.task
  • Classes
    • BaseTask
    • FIFOScheduler
    • IScheduler
    • ITask
    • ITaskController
    • IWorker
    • LIFOScheduler
    • MapTask
    • ResultNS
    • StringTask
    • TaskController
    • TaskResult
    • WorkerFromQueuedEngine

• kernel.taskclient
  • Module: kernel.taskclient
  • Classes
    • BlockingTaskClient
    • IBlockingTaskClient

• kernel.taskfc
  • Module: kernel.taskfc
  • Classes
    • FCTaskClient
    • FCTaskControllerFromTaskController
    • IFCTaskController

• kernel.twistedutil
  • Module: kernel.twistedutil
  • Classes
    • DeferredList
    • ReactorInThread
  • Functions

• kernel.util
  • Module: kernel.util
  • Functions

• macro
  • Module: macro
  • Macro

• numutils
  • Module: numutils
  • Functions

• platutils
  • Module: platutils
  • Class
  • FindCmdError
  • Functions

• platutils_dummy
  • Module: platutils_dummy
    • Authors
  • Functions

• platutils_posix
  • Module: platutils_posix
  • Functions

• platutils_win32
  • Module: platutils_win32
  • Functions

• prefilter
  • Module: prefilter
  • Class
  • LineInfo
  • Functions

• shellglobals
  • Module: shellglobals

• strdispatch
  • Module: strdispatch
  • StrDispatch

• testing.decorator_msim
  • Module: testing.decorator_msim
  • Functions

• testing.decorators
  • Module: testing.decorators
  • Functions

• testing.decorators_numpy
  • Module: testing.decorators_numpy
  • Functions

• testing.decorators_trial
  • Module: testing.decorators_trial
  • Functions

• testing.iptest
  • Module: testing.iptest
  • Class
  • IPTester
  • Functions

• testing.mkdoctests
  • Module: testing.mkdoctests
  • Classes
    • IndentOut
    • RunnerFactory
  • Function

• testing.parametric
  • Module: testing.parametric
  • Functions

• 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.tools
  • Module: testing.tools
    • Authors
  • Functions

• testing.util
  • Module: testing.util
  • DeferredTestCase

• tools.growl
  • Module: tools.growl
  • Classes
    • IPythonGrowlError
    • Notifier
  • Functions

• tools.utils
  • Module: tools.utils
  • Functions

• twshell
  • Module: twshell
  • Classes
    • IPShellTwisted
    • TwistedInteractiveShell
  • Functions

• ultraTB
  • Module: ultraTB
  • Classes
    • AutoFormattedTB
    • ColorTB
    • FormattedTB
    • ListTB
    • TBTools
    • VerboseTB
  • Functions

• upgrade_dir
  • Module: upgrade_dir
  • Functions

• wildcard
  • Module: wildcard
    • Authors
  • Class
  • NameSpace
  • Functions

• winconsole
  • Module: winconsole