flowbber.components.base
¶Base class for all Flowbber components.
All Flowbber components extend from the Component class.
ExecutionInfo
:
Component execution information object.Component
:
Base Component class.flowbber.components.base.
ExecutionInfo
(status, duration, pid, exitcode, data)¶Component execution information object.
succeeded
, crashed
, killed
, hanged
or
timed out
.hanged
.Inheritance
flowbber.components.base.
Component
(index, type_, id_, optional=False, timeout=None, config=None)¶Base Component class.
All Component classes (Sink, Aggregator, Source) extend from this class.
Properties:
Parameters:
Inheritance
declare_config
(config)¶Declare the configuration options of this component.
flowbber.config.Configurator
) – The configuration manager for this component.id
¶Component unique identifier.
index
¶Index of this component in the stage.
join
()¶Join the component and get its execution information.
ExecutionInfo
.optional
¶Component successful execution is optional or not.
start
(*args)¶Start the component execution.
stop
()¶Force stop this component.
Use only when the result of the source is not longer relevant.
timeout
¶Timeout for this component.
type
¶Type of this component.
TimeExceededError
:
Exception raised when a component execution time was exceeded.CrashError
:
Exception raised when a component crashed.flowbber.components.base.
TimeExceededError
(execution)¶Exception raised when a component execution time was exceeded.
Inheritance
flowbber.components.base.
CrashError
(execution)¶Exception raised when a component crashed.
Inheritance