### Navigation

- index
- modules |
- next |
- previous |
- home|
- search|
- documentation »
- The IPython API »

# parallel.error

## Module: `parallel.error`

Inheritance diagram for `IPython.parallel.error`:

Classes and functions for kernel related errors and exceptions.

Authors:

- Brian Granger
- Min RK

## Classes

### `AbortedPendingDeferredError`

class `IPython.parallel.error.``AbortedPendingDeferredError`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `ClientError`

class `IPython.parallel.error.``ClientError`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `CompositeError`

class `IPython.parallel.error.``CompositeError`(message, elist)

  Bases: `IPython.parallel.error.RemoteError`

  Error for representing possibly multiple errors on engines

  `__init__`(message, elist)
  `args`
  `ename` = None
  `engine_info` = None
  `evalue` = None
  `message`
  `print_tracebacks`(excid=None)
  `raise_exception`(excid=0)
  `traceback` = None

### `ConnectionError`

class `IPython.parallel.error.``ConnectionError`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `ControllerCreationError`

class `IPython.parallel.error.``ControllerCreationError`

  Bases: `IPython.parallel.error.ControllerError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `ControllerError`

class `IPython.parallel.error.``ControllerError`

  Bases: `IPython.parallel.error.IPythonError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `DependencyTimeout`

class `IPython.parallel.error.``DependencyTimeout`

  Bases: `IPython.parallel.error.ImpossibleDependency`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `EngineCreationError`

class `IPython.parallel.error.``EngineCreationError`

  Bases: `IPython.parallel.error.EngineError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `EngineError`

class `IPython.parallel.error.``EngineError`

  Bases: `IPython.parallel.error.IPythonError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `FileTimeoutError`

class `IPython.parallel.error.``FileTimeoutError`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `IPythonError`

class `IPython.parallel.error.``IPythonError`

  Bases: `exceptions.Exception`

  Base exception that all of our exceptions inherit from.

  This can be raised by code that doesn’t have any more specific information.

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `IdInUse`

class `IPython.parallel.error.``IdInUse`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `ImpossibleDependency`

class `IPython.parallel.error.``ImpossibleDependency`

  Bases: `IPython.parallel.error.UnmetDependency`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `InvalidClientID`

class `IPython.parallel.error.``InvalidClientID`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `InvalidDeferredID`

class `IPython.parallel.error.``InvalidDeferredID`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `InvalidDependency`

class `IPython.parallel.error.``InvalidDependency`

  Bases: `IPython.parallel.error.ImpossibleDependency`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `InvalidEngineID`

class `IPython.parallel.error.``InvalidEngineID`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `InvalidProperty`

class `IPython.parallel.error.``InvalidProperty`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `KernelError`

class `IPython.parallel.error.``KernelError`

  Bases: `IPython.parallel.error.IPythonError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `MessageSizeError`

class `IPython.parallel.error.``MessageSizeError`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `MissingBlockArgument`

class `IPython.parallel.error.``MissingBlockArgument`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `NoEnginesRegistered`

class `IPython.parallel.error.``NoEnginesRegistered`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `NotAPendingResult`

class `IPython.parallel.error.``NotAPendingResult`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `NotDefined`

class `IPython.parallel.error.``NotDefined`(name)

  Bases: `IPython.parallel.error.KernelError`

  `__init__`(name)
  `args`
  `message`

### `PBMessageSizeError`

class `IPython.parallel.error.``PBMessageSizeError`

  Bases: `IPython.parallel.error.MessageSizeError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `ProtocolError`

class `IPython.parallel.error.``ProtocolError`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `QueueCleared`

class `IPython.parallel.error.``QueueCleared`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `RemoteError`

class `IPython.parallel.error.``RemoteError`(ename, evalue, traceback, engine_info=None)

  Bases: `IPython.parallel.error.KernelError`

  Error raised elsewhere

  `__init__`(ename, evalue, traceback, engine_info=None)
  `args`
  `ename` = None
  `engine_info` = None
  `evalue` = None
  `message`
  `traceback` = None

### `ResultAlreadyRetrieved`

class `IPython.parallel.error.``ResultAlreadyRetrieved`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `ResultNotCompleted`

class `IPython.parallel.error.``ResultNotCompleted`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `SecurityError`

class `IPython.parallel.error.``SecurityError`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `SerializationError`

class `IPython.parallel.error.``SerializationError`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `StopLocalExecution`

class `IPython.parallel.error.``StopLocalExecution`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `TaskAborted`

class `IPython.parallel.error.``TaskAborted`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `TaskRejectError`

class `IPython.parallel.error.``TaskRejectError`

  Bases: `IPython.parallel.error.KernelError`

  Exception to raise when a task should be rejected by an engine.

  This exception can be used to allow a task running on an engine to test if the engine (or the user’s namespace on the engine) has the needed task dependencies. If not, the task should raise this exception. For the task to be retried on another engine, the task should be created with the retries argument > 1.

  The advantage of this approach over our older properties system is that tasks have full access to the user’s namespace on the engines and the properties don’t have to be managed or tested by the controller.

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `TaskTimeout`

class `IPython.parallel.error.``TaskTimeout`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `TimeoutError`

class `IPython.parallel.error.``TimeoutError`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `UnmetDependency`

class `IPython.parallel.error.``UnmetDependency`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

### `UnpickleableException`

class `IPython.parallel.error.``UnpickleableException`

  Bases: `IPython.parallel.error.KernelError`

  `__init__`()

    x.__init__(...) initializes x; see x.__class__.__doc__ for signature

  `args`
  `message`

## Functions

`IPython.parallel.error.``collect_exceptions`(rdict_or_list, method='unspecified')

  check a result dict for errors, and raise CompositeError if any exist. Passthrough otherwise.

`IPython.parallel.error.``unwrap_exception`(content)

`IPython.parallel.error.``wrap_exception`(engine_info={})

### Navigation

- index
- modules |
- next |
- previous |
- home|
- search|
- documentation »
- The IPython API »