Skip to content

kiara.pipeline.module

PipelineModule

A KiaraModule that contains a collection of interconnected other modules.

structure: PipelineStructure property readonly

The PipelineStructure of this module.

create_input_schema(self)

Abstract method to implement by child classes, returns a description of the input schema of this module.

If returning a dictionary of dictionaries, the format of the return value is as follows (items with '*' are optional):

{ "[input_field_name]: { "type": "[value_type]", "doc*": "[a description of this input]", "optional*': [boolean whether this input is optional or required (defaults to 'False')] "[other_input_field_name]: { "type: ... ... }

Source code in kiara/pipeline/module.py 
def create_input_schema(self) -> typing.Mapping[str, ValueSchema]:
    return self.structure.pipeline_input_schema

create_output_schema(self)

Abstract method to implement by child classes, returns a description of the output schema of this module.

If returning a dictionary of dictionaries, the format of the return value is as follows (items with '*' are optional):

{ "[output_field_name]: { "type": "[value_type]", "doc*": "[a description of this output]" "[other_input_field_name]: { "type: ... ... }

Source code in kiara/pipeline/module.py 
def create_output_schema(self) -> typing.Mapping[str, ValueSchema]:
    return self.structure.pipeline_output_schema

is_pipeline() classmethod

Check whether this module type is a pipeline, or not.

Source code in kiara/pipeline/module.py 
@classmethod
def is_pipeline(cls) -> bool:
    return True