plynx.base.executor

Templates for PLynx Executors and utils.

Module Contents

class plynx.base.executor.RunningStatus

Async job running status

node_running_status :str

class plynx.base.executor.BaseExecutor(node: Optional[Node] = None)

Bases: abc.ABC

Base Executor class

IS_GRAPH :bool = False

_update_node(self, node)

run(self, preview: bool = False)

Main execution function.

• Workdir has been initialized.
• Inputs are not preprocessed.
• Outputs shoul be manually postprocessed.
• It is OK to raise an exception in this function.

Returns:

enum: plynx.constants.NodeRunningStatus

launch(self)

Launch the Node on the backend.

The difference between launch() and run() is that: - run() assumes synchronous execution. - launch() does not necessary have this assumtion. Use get_node_running_status to get the status of the execution.

Returns:

RunningStatus

get_running_status(self)

Returns the status of the execution.

Async executions should sync with the remote and return the result immediately.

kill(self)

Force to kill the process.

The reason can be the fact it was working too long or parent executor canceled it.

is_updated(self)

Function that is regularly called by a Worker.

The function is running in a separate thread and does not block execution of run().

Returns:

(bool): True if worker needs to update DB else False

classmethod get_default_node(cls, is_workflow: bool)

Generate a new default Node for this executor

init_executor(self)

Initialize environment for the executor

clean_up_executor(self)

Clean up the environment created by executor

validate(self, ignore_inputs: bool = True)

Validate Node.

Return:

(ValidationError) Validation error if found; else None

class plynx.base.executor.Dummy

Bases: plynx.base.executor.BaseExecutor

Dummy Executor. Used for static Operations

run(self, preview=False)

Not Implemented

status(self)

Not Implemented

kill(self)

Not Implemented

classmethod get_default_node(cls, is_workflow: bool)

Not Implemented