### Navigation

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

# parallel.engine.engine

## Module: `parallel.engine.engine`

Inheritance diagram for `IPython.parallel.engine.engine`:

A simple engine that talks to a controller over 0MQ. it handles registration, etc. and launches a kernel connected to the Controller’s Schedulers.

Authors:

- Min RK

## `EngineFactory`

class `IPython.parallel.engine.engine.``EngineFactory`(**kwargs)

  Bases: `IPython.parallel.factory.RegistrationFactory`

  IPython engine

  `__init__`(**kwargs)
  `abort`()
  `bident`

    A casting version of the string trait.

  classmethod `class_config_section`()

    Get the config class config section

  classmethod `class_get_help`()

    Get the help string for this class in ReST format.

  classmethod `class_get_trait_help`(trait)

    Get the help string for a single trait.

  classmethod `class_print_help`()

    Get the help string for a single trait and print it.

  classmethod `class_trait_names`(**metadata)

    Get a list of all the names of this classes traits.

    This method is just like the `trait_names()` method, but is unbound.

  classmethod `class_traits`(**metadata)

    Get a list of all the traits of this class.

    This method is just like the `traits()` method, but is unbound.

    The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

    This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

  `complete_registration`(msg)
  `config`

    A trait whose value must be an instance of a specified class.

    The value can also be an instance of a subclass of the specified class.

  `context`

    A trait whose value must be an instance of a specified class.

    The value can also be an instance of a subclass of the specified class.

  `created` = None
  `display_hook_factory`

    A trait whose value must be a subclass of a specified class.

  `id`

    A integer trait.

  `ident`

    A trait for unicode strings.

  `ip`

    A trait for unicode strings.

  `kernel`

    A trait whose value must be an instance of a specified class.

    The value can also be an instance of a subclass of the specified class.

  `location`

    A trait for unicode strings.

  `log`

    A trait whose value must be an instance of a specified class.

    The value can also be an instance of a subclass of the specified class.

  `logname`

    A trait for unicode strings.

  `loop`

    A trait whose value must be an instance of a specified class.

    The value can also be an instance of a subclass of the specified class.

  `on_trait_change`(handler, name=None, remove=False)

    Setup a handler to be called when a trait changes.

    This is used to setup dynamic notifications of trait changes.

    Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

    Parameters : | handler : callable A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new). name : list, str, None If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name. remove : bool If False (the default), then install the handler. If True then unintall it.

  `out_stream_factory`

    A trait whose value must be a subclass of a specified class.

  `register`()

    send the registration_request

  `registrar`

    A trait whose value must be an instance of a specified class.

    The value can also be an instance of a subclass of the specified class.

  `regport`

    A integer trait.

  `session`

    A trait whose value must be an instance of a specified class.

    The value can also be an instance of a subclass of the specified class.

  `start`()
  `timeout`

    A casting version of the float trait.

  `trait_metadata`(traitname, key)

    Get metadata values for trait by key.

  `trait_names`(**metadata)

    Get a list of all the names of this classes traits.

  `traits`(**metadata)

    Get a list of all the traits of this class.

    The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

    This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

  `transport`

    A trait for unicode strings.

  `url`

    A trait for unicode strings.

  `user_ns`

    An instance of a Python dict.

### Navigation

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