Skip to content

kiara.pipeline.values

PipelineInputRef pydantic-model

An input to a pipeline.

connected_inputs: List[kiara.pipeline.StepValueAddress] pydantic-field

The step inputs that are connected to this pipeline input

PipelineOutputRef pydantic-model

An output to a pipeline.

connected_output: StepValueAddress pydantic-field required

Connected step outputs.

StepInputRef pydantic-model

An input to a step.

This object can either have a 'connected_outputs' set, or a 'connected_pipeline_input', not both.

connected_outputs: List[kiara.pipeline.StepValueAddress] pydantic-field

A potential connected list of one or several module outputs.

connected_pipeline_input: str pydantic-field

A potential pipeline input.

step_id: str pydantic-field required

The step id.

StepOutputRef pydantic-model

An output to a step.

connected_inputs: List[kiara.pipeline.StepValueAddress] pydantic-field

The step inputs that are connected to this step output

pipeline_output: str pydantic-field

The connected pipeline output.

step_id: str pydantic-field required

The step id.

ValueRef pydantic-model

An object that holds information about the location of a value within a pipeline (or other structure).

Basically, a ValueRef helps the containing object where in its structure the value belongs (for example so it can update dependent other values). A ValueRef object (obviously) does not contain the value itself.

There are four different ValueRef type that are relevant for pipelines:

Several ValueRef objects can target the same value, for example a step output and a connected step input would reference the same Value (in most cases)..

__eq__(self, other) special

Return self==value.

Source code in kiara/pipeline/values.py 
def __eq__(self, other):

    if not isinstance(other, self.__class__):
        return False

    return self._id == other._id

__hash__(self) special

Return hash(self).

Source code in kiara/pipeline/values.py 
def __hash__(self):
    return hash(self._id)

__repr__(self) special

Return repr(self).

Source code in kiara/pipeline/values.py 
def __repr__(self):
    step_id = ""
    if hasattr(self, "step_id"):
        step_id = f" step_id='{self.step_id}'"
    return f"{self.__class__.__name__}(value_name='{self.value_name}' {step_id})"

__str__(self) special

Return str(self).

Source code in kiara/pipeline/values.py 
def __str__(self):
    name = camel_case_to_snake_case(self.__class__.__name__[0:-5], repl=" ")
    return f"{name}: {self.value_name} ({self.value_schema.type})"