spinetoolbox.tool_instance

Contains ToolInstance class.

authors:

16. Savolainen (VTT), E. Rinne (VTT)

date:

1.2.2018

Module Contents

class spinetoolbox.tool_instance.ToolInstance(tool_specification, basedir, settings, logger)

Bases: PySide2.QtCore.QObject

Tool instance base class.

Parameters:

• tool_specification (ToolSpecification) – the tool specification for this instance
• basedir (str) – the path to the directory where this instance should run
• settings (QSettings) – Toolbox settings
• logger (LoggerInterface) – a logger instance

instance_finished

Signal to emit when a Tool instance has finished processing

is_running(self)

terminate_instance(self)

Terminates Tool instance execution.

remove(self)

[Obsolete] Removes Tool instance files from work directory.

prepare(self, optional_input_files, input_database_urls, output_database_urls, tool_args)

Prepares this instance for execution.

Implement in subclasses to perform specific initialization.

Parameters:

• optional_input_files (list) – list of tool’s optional input files
• input_database_urls (dict) – a mapping from upstream Data Store name to database URL
• output_database_urls (dict) – a mapping from downstream Data Store name to database URL
• tool_args (list) – Tool cmd line args

execute(self, **kwargs)

Executes a prepared instance. Implement in subclasses.

handle_execution_finished(self, ret)

Handles execution finished.

Parameters:ret (int) –

append_cmdline_args(self, optional_input_files, input_database_urls, output_database_urls, tool_args)

Appends Tool specification command line args into instance args list.

Parameters:

• optional_input_files (list) – list of tool’s optional input files
• input_database_urls (dict) – a mapping from upstream Data Store name to database URL
• output_database_urls (dict) – a mapping from downstream Data Store name to database URL
• tool_args (list) – List of Tool cmd line args

class spinetoolbox.tool_instance.GAMSToolInstance

Bases: spinetoolbox.tool_instance.ToolInstance

Class for GAMS Tool instances.

prepare(self, optional_input_files, input_database_urls, output_database_urls, tool_args)

See base class.

execute(self, **kwargs)

Executes a prepared instance.

handle_execution_finished(self, ret)

Handles execution finished.

Parameters:ret (int) –

class spinetoolbox.tool_instance.JuliaToolInstance(toolbox, tool_specification, basedir, settings, logger)

Bases: spinetoolbox.tool_instance.ToolInstance

Class for Julia Tool instances.

Parameters:

• toolbox (ToolboxUI) – QMainWindow instance
• tool_specification (ToolSpecification) – the tool specification for this instance
• basedir (str) – the path to the directory where this instance should run
• settings (QSettings) – Toolbox settings
• logger (LoggerInterface) – a logger instance

prepare(self, optional_input_files, input_database_urls, output_database_urls, tool_args)

See base class.

execute(self, **kwargs)

Executes a prepared instance.

handle_repl_execution_finished(self, ret)

Handles repl-execution finished.

Parameters:ret (int) – Tool specification process return value

handle_execution_finished(self, ret)

Handles execution finished.

Parameters:ret (int) – Tool specification process return value

class spinetoolbox.tool_instance.PythonToolInstance(toolbox, tool_specification, basedir, settings, logger)

Bases: spinetoolbox.tool_instance.ToolInstance

Class for Python Tool instances.

Parameters:

• toolbox (ToolboxUI) – QMainWindow instance
• tool_specification (ToolSpecification) – the tool specification for this instance
• basedir (str) – the path to the directory where this instance should run
• settings (QSettings) – Toolbox settings
• logger (LoggerInterface) – A logger instance

prepare(self, optional_input_files, input_database_urls, output_database_urls, tool_args)

See base class.

execute(self, **kwargs)

Executes a prepared instance.

handle_console_execution_finished(self, ret)

Handles console-execution finished.

Parameters:ret (int) – Tool specification process return value

handle_execution_finished(self, ret)

Handles execution finished.

Parameters:ret (int) – Tool specification process return value

class spinetoolbox.tool_instance.ExecutableToolInstance

Bases: spinetoolbox.tool_instance.ToolInstance

Class for Executable Tool instances.

prepare(self, optional_input_files, input_database_urls, output_database_urls, tool_args)

See base class.

execute(self, **kwargs)

Executes a prepared instance.

handle_execution_finished(self, ret)

Handles execution finished.

Parameters:ret (int) – Tool specification process return value