51Degrees Pipeline Python  4.1

51Degrees Pipeline for Python
  • pipeline-python
  • fiftyone_pipeline_core
  • fiftyone_pipeline_core
  • pipeline
  • Pipeline

pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.pipeline.Pipeline Class Reference

Detailed Description

Pipeline holding a list of FlowElements for processing, can create FlowData that will be passed through these, collecting ElementData Should be constructed through the PipelineBuilder class.

Public Member Functions

def  __init__ (self, flow_elements, logger=Logger())
Pipeline constructor. More...
def  create_flowdata (self)
Create a FlowData based on what's in the pipeline. More...
def  log (self, level, message)
Log a message using the Logger.log of the pipeline's Logger. More...
def  get_element (self, key)
Get a flowElement by its name. More...
def  get_properties (self)
Get all properties of all flowElements in the pipeline. More...

Public Attributes

 flow_elements
 logger
 flow_elements_list

Constructor & Destructor Documentation

◆ __init__()

def pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.pipeline.Pipeline.__init__ (   self,
  flow_elements,
  logger = Logger()  
)

Pipeline constructor.

@type flow_elements: list[FlowElement]

Parameters
flow_elements - A list of flowElements

@type logger: Logger

Parameters
logger - A logger to attach to the pipeline

@rtype: Pipeline

Returns
: Returns a Pipeline

Member Function Documentation

◆ create_flowdata()

def pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.pipeline.Pipeline.create_flowdata (   self )

Create a FlowData based on what's in the pipeline.

@rtype: FlowData

Returns
: Return a FlowData

◆ get_element()

def pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.pipeline.Pipeline.get_element (   self,
  key  
)

Get a flowElement by its name.

@type key: string

Parameters
key - name of flowElement

@rtype: FlowElement

Returns
: Returns the FlowElement indicated

◆ get_properties()

def pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.pipeline.Pipeline.get_properties (   self )

Get all properties of all flowElements in the pipeline.

@rtype: dict of {string : DataPropertyDictionary}

Returns
: Returns dictionary of all properties in a pipeline keyed by each flowElement's FlowElement.datakey.

◆ log()

def pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.pipeline.Pipeline.log (   self,
  level,
  message  
)

Log a message using the Logger.log of the pipeline's Logger.

@type level: string

Parameters
level - level of log message

@type message: string

Parameters
message - Returns content of log message