kiara.pipeline.listeners

PipelineListener

pipeline_inputs_changed(self, event)

Method to override if the implementing controller needs to react to events where one or several pipeline inputs have changed.

Note

Whenever pipeline inputs change, the connected step inputs also change and an (extra) event will be fired for those. Which means you can choose to only implement the step_inputs_changed method if you want to. This behaviour might change in the future.

Parameters:

Name	Type	Description	Default
event	PipelineInputEvent	the pipeline input event	required

Source code in kiara/pipeline/listeners.py

def pipeline_inputs_changed(self, event: PipelineInputEvent):
    """Method to override if the implementing controller needs to react to events where one or several pipeline inputs have changed.

    !!! note
    Whenever pipeline inputs change, the connected step inputs also change and an (extra) event will be fired for those. Which means
    you can choose to only implement the ``step_inputs_changed`` method if you want to. This behaviour might change in the future.

    Arguments:
        event: the pipeline input event
    """

pipeline_outputs_changed(self, event)

Method to override if the implementing controller needs to react to events where one or several pipeline outputs have changed.

Parameters:

Name	Type	Description	Default
event	PipelineOutputEvent	the pipeline output event	required

Source code in kiara/pipeline/listeners.py

def pipeline_outputs_changed(self, event: PipelineOutputEvent):
    """Method to override if the implementing controller needs to react to events where one or several pipeline outputs have changed.

    Arguments:
        event: the pipeline output event
    """

step_inputs_changed(self, event)

Method to override if the implementing controller needs to react to events where one or several step inputs have changed.

Parameters:

Name	Type	Description	Default
event	StepInputEvent	the step input event	required

Source code in kiara/pipeline/listeners.py

def step_inputs_changed(self, event: StepInputEvent):
    """Method to override if the implementing controller needs to react to events where one or several step inputs have changed.

    Arguments:
        event: the step input event
    """

step_outputs_changed(self, event)

Method to override if the implementing controller needs to react to events where one or several step outputs have changed.

Parameters:

Name	Type	Description	Default
event	StepOutputEvent	the step output event	required

Source code in kiara/pipeline/listeners.py

def step_outputs_changed(self, event: StepOutputEvent):
    """Method to override if the implementing controller needs to react to events where one or several step outputs have changed.

    Arguments:
        event: the step output event
    """