ror.stages package#

Subpackages#

Submodules#

ror.stages.i_forward_stage module#

class ror.stages.i_forward_stage.IForwardStage[source]#

Bases: IBaseStage[I, O], Generic[I, O, N]

Interface for the forward stage, defines an input datatype, an output datatype and a dependency for the next stage. Which will be returened as an instance with the stage output in the get_output method.

Examples

>>> from pypipeline.stages import IForwardStage

This will define a new stage with an input, ouput schema and a ref.

>>> class ForwardStage(IForwardStage[InputSchema, OutputSchema, NextStage]): ...
discover() → N[source]#

Returns a class object for the next stage in linked from this stage.

Returns:

Class reference to next stage

Return type:

N

get_output() → Tuple[N, O][source]#

Returns the output dataclass as type O defined in the construction.

Returns:

Output dataclass defined for this stage.

Return type:

O

input_schema() → I[source]#

Returns the input schema defined for this stage

Returns:

Reference to dataclass schema

Return type:

I

output_schema() → O[source]#

Returns the output schema defined for this stage

Returns:

Reference to dataclass schema

Return type:

O

ror.stages.i_init_stage module#

class ror.stages.i_init_stage.IInitStage[source]#

Bases: IBaseStage[I, O], Generic[I, O, N]

Interface for the IInit stage, defines an input datatype, an output datatype and a dependency for the next stage. Which will be returened as an instance with the stage output in the get_output method.

Examples

>>> from pypipeline.stages import IInitStage

This will define a new stage with an input, ouput schema and a ref.

>>> class InitStage(IInitStage[InputSchema, OutputSchema, NextStage]): ...
discover() → N[source]#

Returns a class object for the next stage in linked from this stage.

Returns:

Class reference to next stage

Return type:

N

get_output() → Tuple[N, O][source]#

Returns the output dataclass as type O defined in the construction.

Returns:

Output dataclass defined for this stage.

Return type:

O

input_schema() → I[source]#

Returns the input schema defined for this stage

Returns:

Reference to dataclass schema

Return type:

I

output_schema() → O[source]#

Returns the output schema defined for this stage

Returns:

Reference to dataclass schema

Return type:

O

ror.stages.i_terminal_stage module#

class ror.stages.i_terminal_stage.ITerminalStage[source]#

Bases: IBaseStage[I, O]

Interface for the ITerminal stage, defines an input datatype, an output datatype. There is no next stage ref since this is the final stage of any pipeline.

Examples

>>> from pypipeline.stages import ITerminalStage

This will define a new stage with an input, ouput schema and a ref.

>>> class TerminalStage(ITerminalStage[InputSchema, OutputSchema]): ...
discover() → None[source]#

As this is the final stage then it will return None to indicate that this is the final stage.

Returns:

Class reference to next stage

Return type:

None

input_schema() → I[source]#

Returns the input schema defined for this stage

Returns:

Reference to dataclass schema

Return type:

I

output_schema() → O[source]#

Returns the output schema defined for this stage

Returns:

Reference to dataclass schema

Return type:

O

Module contents#