Package elisa :: Package core :: Module component :: Class Component

Class Component

source code

Instance Methods

twisted.internet.defer.Deferred

initialize(self, **kwargs)
Initialize the component.

source code

twisted.internet.defer.Deferred

clean(self)
Clean the component.

source code

name__get(self)

source code

name__set(self, value)

source code

Inherited from extern.log.log.Loggable: debug, doLog, error, info, log, logFunction, logObjectName, warning, warningFailure

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Inherited from log.Loggable

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

source code

Class Methods

elisa.core.component.Component or a subclass

create(cls, config_section=None, **kwargs)
Create and initialize the component.

source code

Class Variables
	default_config = `{}`
	config_doc = `{}`
	path = `PathDescriptor()`
	name = `property(fget= name__get, fset= name__set)`
Inherited from `extern.log.log.Loggable`: `logCategory`

Properties
Inherited from `object`: `__class__`

Method Details

create(cls, config_section=None, **kwargs)
Class Method

source code

Create and initialize the component.

A component should always be created by calling Component.create and not by instantiating the component class directly.

Parameters:

config_section (elisa.core.config.Config) - the configuration section to set for the component

Returns: elisa.core.component.Component or a subclass

an instance of the component

initialize(self, **kwargs)

source code

Initialize the component.

This method is called by Component.create to finish the initialization of a component.

Returns: twisted.internet.defer.Deferred: a deferred called when a component is fully initialized

clean(self)

source code

Clean the component.

This method is called when a component is not needed anymore to clean its state.

Returns: twisted.internet.defer.Deferred: a deferred called when the component has finished cleaning its state

Class Component

create(cls, config_section=None, **kwargs) Class Method

initialize(self, **kwargs)

clean(self)

create(cls, config_section=None, **kwargs)
Class Method