project

Spine Toolbox project class.

authors:

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

date:

10.1.2018

Module Contents

class project.SpineToolboxProject(toolbox, name, description, work_dir=None, ext='.proj')

Bases: metaobject.MetaObject

Class for Spine Toolbox projects.

toolbox

toolbox of this project

Type:ToolboxUI

name

Project name

Type:str

description

Project description

Type:str

work_dir

Project work directory

Type:str

ext

Project save file extension(.proj)

Type:str

change_name(self, name)

Changes project name and updates project dir and save file name.

Parameters:name (str) – Project (long) name

change_filename(self, new_filename)

Change the save filename associated with this project.

Parameters:new_filename (str) – Filename used in saving the project. No full path. Example ‘project.proj’

change_work_dir(self, new_work_path)

Change project work directory.

Parameters:new_work_path (str) – Absolute path to new work directory

rename_project(self, name)

Save project under a new name. Used with File->Save As… menu command. Checks if given project name is valid.

Parameters:name (str) – New (long) name for project

save(self, tool_def_paths)

Collect project information and objects into a dictionary and write to a JSON file.

Parameters:tool_def_paths (list) – List of paths to tool definition files

load(self, item_dict)

Populate project item model with items loaded from project file.

Parameters:item_dict (dict) – Dictionary containing all project items in JSON format Returns:Boolean value depending on operation success.

load_tool_template_from_file(self, jsonfile)

Create a Tool template according to a tool definition file.

Parameters:jsonfile (str) – Path of the tool template definition file Returns:Instance of a subclass if Tool

load_tool_template_from_dict(self, definition, path)

Create a Tool template according to a dictionary.

Parameters:

• definition (dict) – Dictionary with the tool definition
• path (str) – Folder of the main program file

Returns:

Instance of a subclass if Tool

add_data_store(self, name, description, url, x=0, y=0, set_selected=False, verbosity=True)

Adds a Data Store to project item model.

Parameters:

• name (str) – Name
• description (str) – Description of item
• url (dict) – Url information
• x (int) – X coordinate of item on scene
• y (int) – Y coordinate of item on scene
• set_selected (bool) – Whether to set item selected after the item has been added to project
• verbosity (bool) – If True, prints message

add_data_connection(self, name, description, references, x=0, y=0, set_selected=False, verbosity=True)

Adds a Data Connection to project item model.

Parameters:

• name (str) – Name
• description (str) – Description of item
• references (list(str)) – List of file paths
• x (int) – X coordinate of item on scene
• y (int) – Y coordinate of item on scene
• set_selected (bool) – Whether to set item selected after the item has been added to project
• verbosity (bool) – If True, prints message

add_tool(self, name, description, tool_template, use_work=True, x=0, y=0, set_selected=False, verbosity=True)

Adds a Tool to project item model.

Parameters:

• name (str) – Name
• description (str) – Description of item
• tool_template (ToolTemplate) – Tool template of this tool
• use_work (bool) – Execute in work directory
• x (int) – X coordinate of item on scene
• y (int) – Y coordinate of item on scene
• set_selected (bool) – Whether to set item selected after the item has been added to project
• verbosity (bool) – If True, prints message

add_view(self, name, description, x=0, y=0, set_selected=False, verbosity=True)

Adds a View to project item model.

Parameters:

• name (str) – Name
• description (str) – Description of item
• x (int) – X coordinate of item on scene
• y (int) – Y coordinate of item on scene
• set_selected (bool) – Whether to set item selected after the item has been added to project
• verbosity (bool) – If True, prints message

add_data_interface(self, name, description, import_file_path='', mappings=None, x=0, y=0, set_selected=False, verbosity=True)

Adds a Data Interface to project item model.

Parameters:

• name (str) – Name
• description (str) – Description of item
• x (int) – X coordinate of item on scene
• y (int) – Y coordinate of item on scene
• set_selected (bool) – Whether to set item selected after the item has been added to project
• verbosity (bool) – If True, prints message

append_connection_model(self, item_name, category)

Adds new item to connection model to keep project and connection model synchronized.

add_to_dag(self, item_name)

Add new directed graph object.

set_item_selected(self, item)

Sets item selected and shows its info screen.

Parameters:item (ProjectItem) – Project item to select

execute_selected(self)

Starts executing selected directed acyclic graph. Selected graph is determined by the selected project item(s). Aborts, if items from multiple graphs are selected.

execute_project(self)

Determines the number of directed acyclic graphs to execute in the project. Determines the execution order of project items in each graph. Creates an instance for executing the first graph and starts executing it.

graph_execution_finished(self, state)

Releases resources from previous execution and prepares the next graph for execution if there are still graphs left. Otherwise, finishes the run.

Parameters:state (int) – 0: Ended normally. -1: User pressed Stop button

stop(self)

Stops execution of the current DAG. Slot for the main window Stop tool button in the toolbar.

handle_invalid_graphs(self)

Prints messages to Event Log if there are invalid DAGs (e.g. contain self-loops) in the project.

export_graphs(self)

Export all valid directed acyclic graphs in project to GraphML files.