pypeliner.processors.base

Base module for processors that contains base processors class and a callback based processors base class.

Classes

BaseProcessor	Base class for processors.
CallbackProcessor	Base class for processors that holds their logic in a parameterized

Module Contents

class pypeliner.processors.base.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.processors.base.CallbackProcessor(callback: Callable[[Any], Any])

Bases: BaseProcessor

Base class for processors that holds their logic in a parameterized callback.

Args:

callback: a callback with processing logic, it is mandatory for the callback to have 1 required positional arguments, for any further required positional arguments consider using a partial. init_state: processor initial state.

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.