pypeliner.runner_configuration

Runner configuration module contains runner configuration modeling.

Classes

BaseProcessor	Base class for processors.
RunnerConfiguration	A configuration class used to configure the runner behaviour.

Module Contents

class pypeliner.runner_configuration.BaseProcessor

Base class for processors.

Attributes:

PROCESSOR_NAME: verbose name for processor.

PROCESSOR_NAME = ''

__call__(state: Any) → Any

__str__() → str

Return str(self).

abstract process(state: Any) → Any

process method defines the processing operations for the current processor. it is not recommended to be called directly unless the processor is used a standalone unit.

Args:

state: processor input state.

Returns:

processed state.

class pypeliner.runner_configuration.RunnerConfiguration

A configuration class used to configure the runner behaviour.

pre_processors: A list of preprocessors that will run before each processor. post_processors: A list of preprocessors that will run after each processor. deep_copy_state: Whether to copy the state or not. Defaults to True. verbose: Whether to output running status on terminal. Defaults to False. run_timers: Whether to print the timing for each processor. Defaults to False. timers_decimal_places: when run_timers is True,

it will specify the number of decimal points for the measured time, if run_timers is False and this parameter is specified it will have no effect. Defaults to 3.

pre_processors: List[pypeliner.processors.base.BaseProcessor] | None = None

post_processors: List[pypeliner.processors.base.BaseProcessor] | None = None

deep_copy_state: bool = True

verbose: bool = False

run_timers: bool = False

timers_decimal_places: int = 3