API Reference

Classes

Executor

Bases: PExecutor

This is a main class for executing pipeline.

__init__(context=None, params=None, modules=None, cfg=None)

Initialize the Executor instance.

Parameters:
  • context (str, default: None ) –

    The context in which the pipeline execution occurs. This could include any relevant contextual information needed by the executor.

  • params –

    Parameters defined for specific instance of pipeline execution.

  • modules –

    Modules used during the pipeline execution process. These can be represented by names or Mod classes

Mod

Bases: PModulePy

Class for instances of modules used for pipeline execution

__init__(func_exec=None, name=None, func_init=None, func_onprocess=None)

Initialize the Module instance Args: func_exec: method called while module is executed in pipeline name: name of module func_init: method called right before module is executed func_onprocess: method called instead of func_exec for each input file. Only called when dataloop=1 is set in context or params.

PPath

Bases: PObject

Utility class for I/O operations (particuary filesystem) during pipeline execution.