spinetoolbox.spine_engine_manager

Contains SpineEngineManagerBase.

Module Contents

Classes

SpineEngineManagerBase
LocalSpineEngineManager
RemoteSpineEngineManager	Responsible for remote project execution.

Functions

make_engine_manager([remote_execution_enabled, job_id])

Returns either a Local or a remote Spine Engine Manager based on settings.

class spinetoolbox.spine_engine_manager.SpineEngineManagerBase

abstract run_engine(engine_data)

Runs an engine with given data.

Parameters

engine_data (dict) – The engine data.

abstract get_engine_event()

Gets next event from a running engine.

Returns

two element tuple: event type identifier string, and event data dictionary

Return type

tuple(str,dict)

abstract stop_engine()

Stops a running engine.

abstract answer_prompt(prompter_id, answer)

Answers prompt.

Parameters

• prompter_id (int) – The id of the prompter

• answer – The user’s decision.

abstract restart_kernel(connection_file)

Restarts the jupyter kernel associated to given connection file.

Parameters

connection_file (str) – path of connection file

abstract shutdown_kernel(connection_file)

Shuts down the jupyter kernel associated to given connection file.

Parameters

connection_file (str) – path of connection file

abstract issue_persistent_command(persistent_key, command)

Issues a command to a persistent process.

Parameters

• persistent_key (tuple) – persistent identifier

• command (str) – command to issue

Returns

stdin, stdout, and stderr messages (dictionaries with two keys: type, and data)

Return type

generator

abstract is_persistent_command_complete(persistent_key, command)

Checks whether a command is complete.

Parameters

• key (tuple) – persistent identifier

• cmd (str) – command to issue

Returns

bool

abstract restart_persistent(persistent_key)

Restarts a persistent process.

Parameters

persistent_key (tuple) – persistent identifier

Returns

stdout and stderr messages (dictionaries with two keys: type, and data)

Return type

generator

abstract interrupt_persistent(persistent_key)

Interrupts a persistent process.

Parameters

persistent_key (tuple) – persistent identifier

abstract kill_persistent(persistent_key)

Kills a persistent process.

Parameters

persistent_key (tuple) – persistent identifier

abstract get_persistent_completions(persistent_key, text)

Returns a list of auto-completion options from given text.

Parameters

• persistent_key (tuple) – persistent identifier

• text (str) – text to complete

Returns

list of str

abstract get_persistent_history_item(persistent_key, text, prefix, backwards)

Returns an item from persistent history.

Parameters

persistent_key (tuple) – persistent identifier

Returns

history item or empty string if none

Return type

str

class spinetoolbox.spine_engine_manager.LocalSpineEngineManager

Bases: SpineEngineManagerBase

run_engine(engine_data)

Runs an engine with given data.

Parameters

engine_data (dict) – The engine data.

get_engine_event()

Gets next event from a running engine.

Returns

two element tuple: event type identifier string, and event data dictionary

Return type

tuple(str,dict)

stop_engine()

Stops a running engine.

answer_prompt(prompter_id, answer)

Answers prompt.

Parameters

• prompter_id (int) – The id of the prompter

• answer – The user’s decision.

restart_kernel(connection_file)

Restarts the jupyter kernel associated to given connection file.

Parameters

connection_file (str) – path of connection file

shutdown_kernel(connection_file)

Shuts down the jupyter kernel associated to given connection file.

Parameters

connection_file (str) – path of connection file

kernel_managers()

issue_persistent_command(persistent_key, command)

Issues a command to a persistent process.

Parameters

• persistent_key (tuple) – persistent identifier

• command (str) – command to issue

Returns

stdin, stdout, and stderr messages (dictionaries with two keys: type, and data)

Return type

generator

is_persistent_command_complete(persistent_key, command)

Checks whether a command is complete.

Parameters

• key (tuple) – persistent identifier

• cmd (str) – command to issue

Returns

bool

restart_persistent(persistent_key)

Restarts a persistent process.

Parameters

persistent_key (tuple) – persistent identifier

Returns

stdout and stderr messages (dictionaries with two keys: type, and data)

Return type

generator

interrupt_persistent(persistent_key)

Interrupts a persistent process.

Parameters

persistent_key (tuple) – persistent identifier

kill_persistent(persistent_key)

Kills a persistent process.

Parameters

persistent_key (tuple) – persistent identifier

get_persistent_completions(persistent_key, text)

Returns a list of auto-completion options from given text.

Parameters

• persistent_key (tuple) – persistent identifier

• text (str) – text to complete

Returns

list of str

get_persistent_history_item(persistent_key, text, prefix, backwards)

Returns an item from persistent history.

Parameters

persistent_key (tuple) – persistent identifier

Returns

history item or empty string if none

Return type

str

class spinetoolbox.spine_engine_manager.RemoteSpineEngineManager(job_id='')

Bases: SpineEngineManagerBase

Responsible for remote project execution.

Initializer.

make_engine_client(host, port, security, sec_folder, ping=True)

Creates a client for connecting to Spine Engine Server.

run_engine(engine_data)

Makes an engine client for communicating with the engine server. Starts a thread for monitoring the DAG execution on server.

Parameters

engine_data (dict) – The engine data.

get_engine_event()

Returns the next engine execution event.

clean_up()

Closes EngineClient and joins _runner thread if still active.

stop_engine()

Sends a request to stop execution on Server then waits for _runner thread to end.

_run()

Sends a start execution request to server with the job Id. Sets up a subscribe socket according to the publish port received from server. Passes received events to SpineEngineWorker for processing. After execution has finished, downloads new files from server.

answer_prompt(prompter_id, answer)

See base class.

restart_kernel(connection_file)

See base class.

shutdown_kernel(connection_file)

See base class.

is_persistent_command_complete(persistent_key, command)

Checks whether a command is complete.

Parameters

• key (tuple) – persistent identifier

• cmd (str) – command to issue

Returns

bool

issue_persistent_command(persistent_key, command)

Issues a command to a persistent process.

Parameters

• persistent_key (tuple) – persistent identifier

• command (str) – command to issue

Returns

stdin, stdout, and stderr messages (dictionaries with two keys: type, and data)

Return type

generator

restart_persistent(persistent_key)

See base class.

interrupt_persistent(persistent_key)

See base class.

kill_persistent(persistent_key)

See base class.

get_persistent_completions(persistent_key, text)

See base class.

get_persistent_history_item(persistent_key, text, prefix, backwards)

Returns an item from persistent history.

Parameters

persistent_key (tuple) – persistent identifier

Returns

history item or empty string if none

Return type

str

spinetoolbox.spine_engine_manager.make_engine_manager(remote_execution_enabled=False, job_id='')

Returns either a Local or a remote Spine Engine Manager based on settings.

Parameters

• remote_execution_enabled (bool) – True returns a local Spine Engine Manager instance,

• instance (False returns a remote Spine Engine Manager) –

• job_id (str) – Server execution job Id