spinetoolbox.execution_managers

Classes to manage tool instance execution in various forms.

author

16. Savolainen (VTT)

date

1.2.2018

Module Contents

Classes

ExecutionManager	Base class for all tool instance execution managers.
QProcessExecutionManager	Class to manage tool instance execution using a PySide2 QProcess.

class spinetoolbox.execution_managers.ExecutionManager(logger)

Bases: PySide2.QtCore.QObject

Base class for all tool instance execution managers.

Class constructor.

Parameters

logger (LoggerInterface) – a logger instance

execution_finished

abstract start_execution(self, workdir=None)

Starts the execution.

Parameters

workdir (str) – Work directory

abstract stop_execution(self)

Stops the execution.

class spinetoolbox.execution_managers.QProcessExecutionManager(logger, program='', args=None, silent=False, semisilent=False)

Bases: ExecutionManager

Class to manage tool instance execution using a PySide2 QProcess.

Class constructor.

Parameters

• logger (LoggerInterface) – a logger instance

• program (str) – Path to program to run in the subprocess (e.g. julia.exe)

• args (list, optional) – List of argument for the program (e.g. path to script file)

• silent (bool) – Whether or not to emit logger msg signals

• semisilent (bool) – If True, show Process Log messages

program(self)

Program getter method.

args(self)

Program argument getter method.

start_execution(self, workdir=None)

Starts the execution of a command in a QProcess.

Parameters

workdir (str, optional) – Work directory

wait_for_process_finished(self, msecs=30000)

Wait for subprocess to finish.

Parameters

msecs (int) – Timeout in milliseconds

Returns

True if process finished successfully, False otherwise

process_started(self)

Run when subprocess has started.

on_state_changed(self, new_state)

Runs when QProcess state changes.

Parameters

new_state (int) – Process state number (QProcess::ProcessState)

on_process_error(self, process_error)

Runs if there is an error in the running QProcess.

Parameters

process_error (int) – Process error number (QProcess::ProcessError)

teardown_process(self)

Tears down the QProcess in case a QProcess.ProcessError occurred. Emits execution_finished signal.

stop_execution(self)

See base class.

on_process_finished(self, exit_code, exit_status)

Runs when subprocess has finished.

Parameters

• exit_code (int) – Return code from external program (only valid for normal exits)

• exit_status (int) – Crash or normal exit (QProcess::ExitStatus)

on_ready_stdout(self)

Emit data from stdout.

on_ready_stderr(self)

Emit data from stderr.