Skip to content

kiara.pipeline

PipelineValueInfo pydantic-model

Convenience wrapper to make the [PipelineState][kiara.pipeline.pipeline.PipelineState] json/dict export prettier.

id: str pydantic-field required

A unique id for this value.

is_set: bool pydantic-field required

Whether the value is set.

is_valid: bool pydantic-field

Whether the value is set and valid.

metadata: Dict[str, Any] pydantic-field

Metadata relating to the actual data (size, no. of rows, etc. -- depending on data type).

status: str pydantic-field required

The value status string

value_schema: ValueSchema pydantic-field required

The schema of this value.

PipelineValuesInfo pydantic-model

Convenience wrapper to make the [PipelineState][kiara.pipeline.pipeline.PipelineState] json/dict export prettier.

This is basically just a simplified version of the [ValueSet][kiara.data.values.ValueSet] class that is using pydantic, in order to make it easy to export to json.

values: Dict[str, kiara.pipeline.__init__.PipelineValueInfo] pydantic-field required

Field names are keys, and the data as values.

StepStatus

Enum to describe the state of a workflow.

StepValueAddress pydantic-model

Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure.

alias property readonly

An alias string for this address (in the form [step_id].[value_name]).

step_id: str pydantic-field required

The id of a step within a pipeline.

sub_value: Dict[str, Any] pydantic-field

A reference to a subitem of a value (e.g. column, list item)

value_name: str pydantic-field required

The name of the value (output name or pipeline input name).

__eq__(self, other) special

Return self==value.

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

    if not isinstance(other, StepValueAddress):
        return False

    return (self.step_id, self.value_name, self.sub_value) == (
        other.step_id,
        other.value_name,
        other.sub_value,
    )

__hash__(self) special

Return hash(self).

Source code in kiara/pipeline/__init__.py 
def __hash__(self):

    return hash((self.step_id, self.value_name, self.sub_value))

__repr__(self) special

Return repr(self).

Source code in kiara/pipeline/__init__.py 
def __repr__(self):

    if self.sub_value:
        sub_value = f" sub_value={self.sub_value}"
    else:
        sub_value = ""
    return f"StepValueAddres(step_id={self.step_id}, value_name={self.value_name}{sub_value})"

__str__(self) special

Return str(self).

Source code in kiara/pipeline/__init__.py 
def __str__(self):
    return self.__repr__()