spinetoolbox.helpers

General helper functions and classes.

authors:

16. Savolainen (VTT)

date:

10.1.2018

Module Contents

spinetoolbox.helpers.set_taskbar_icon()

Set application icon to Windows taskbar.

spinetoolbox.helpers.supported_img_formats()

Function to check if reading .ico files is supported.

spinetoolbox.helpers.pyside2_version_check()

Check that PySide2 version is older than 5.12, since this is not supported yet. Issue #238 in GitLab.

qt_version is the Qt version used to compile PySide2 as string. E.g. “5.11.2” qt_version_info is a tuple with each version component of Qt used to compile PySide2. E.g. (5, 11, 2)

spinetoolbox.helpers.spinedb_api_version_check()

Check if spinedb_api is the correct version and explain how to upgrade if it is not.

spinetoolbox.helpers.spine_engine_version_check()

Check if spine engine package is the correct version and explain how to upgrade if it is not.

spinetoolbox.helpers.busy_effect(func)

Decorator to change the mouse cursor to ‘busy’ while a function is processed.

Parameters:func – Decorated function.

spinetoolbox.helpers.get_datetime(show, date=True)

Returns date and time string for appending into Event Log messages.

Parameters:

• show (bool) – True returns date and time string. False returns empty string.
• date (bool) – Whether or not the date should be included in the result

spinetoolbox.helpers.create_dir(base_path, folder='', verbosity=False)

Create (input/output) directories recursively.

Parameters:

• base_path (str) – Absolute path to wanted dir
• folder (str) – (Optional) Folder name. Usually short name of item.
• verbosity (bool) – True prints a message that tells if the directory already existed or if it was created.

Returns:

True if directory already exists or if it was created successfully.

Raises:

OSError if operation failed.

spinetoolbox.helpers.create_output_dir_timestamp()

Creates a new timestamp string that is used as Tool output directory.

Returns:Timestamp string or empty string if failed.

spinetoolbox.helpers.copy_files(src_dir, dst_dir, includes=None, excludes=None)

Function for copying files. Does not copy folders.

Parameters:

• src_dir (str) – Source directory
• dst_dir (str) – Destination directory
• includes (list) – Included files (wildcards accepted)
• excludes (list) – Excluded files (wildcards accepted)

Returns:

Number of files copied

Return type:

count (int)

spinetoolbox.helpers.erase_dir(path, verbosity=False)

Deletes a directory and all its contents without prompt.

Parameters:

• path (str) – Path to directory
• verbosity (bool) – Print logging messages or not

spinetoolbox.helpers.copy_dir(widget, src_dir, dst_dir)

Makes a copy of a directory. All files and folders are copied. Destination directory must not exist. Does not overwrite files.

Parameters:

• widget (QWidget) – Parent widget for QMessageBoxes
• src_dir (str) – Absolute path to directory that will be copied
• dst_dir (str) – Absolute path to new directory

spinetoolbox.helpers.recursive_overwrite(widget, src, dst, ignore=None, silent=True)

Copies everything from source directory to destination directory recursively. Overwrites existing files.

Parameters:

• widget (QWidget) – Enables e.g. printing to Event Log
• src (str) – Source directory
• dst (str) – Destination directory
• ignore – Ignore function
• silent (bool) – If False, messages are sent to Event Log, If True, copying is done in silence

spinetoolbox.helpers.rename_dir(old_dir, new_dir, logger)

Rename directory. Note: This is not used in renaming projects due to unreliability. Looks like it works fine in renaming project items though.

Parameters:

• old_dir (str) – Absolute path to directory that will be renamed
• new_dir (str) – Absolute path to new directory
• logger (LoggerInterface) – A logger instance

spinetoolbox.helpers.fix_name_ambiguity(input_list, offset=0)

Modify repeated entries in name list by appending an increasing integer.

spinetoolbox.helpers.tuple_itemgetter(itemgetter_func, num_indexes)

Change output of itemgetter to always be a tuple even for one index

spinetoolbox.helpers.format_string_list(str_list)

Return an unordered html list with all elements in str_list. Intended to print error logs as returned by spinedb_api.

Parameters:str_list (list(str)) –

spinetoolbox.helpers.rows_to_row_count_tuples(rows)

Breaks a list of rows into a list of (row, count) tuples corresponding to chunks of successive rows.

spinetoolbox.helpers.inverted(input_)

Inverts a dictionary that maps keys to a list of values. The output maps values to a list of keys that include the value in the input.

class spinetoolbox.helpers.Singleton

Bases: type

A singleton class from SO.

_instances

__call__(cls, *args, **kwargs)

class spinetoolbox.helpers.IconListManager(icon_size)

A class to manage icons for icon list widgets.

init_model(self)

Init model that can be used to display all icons in a list.

_model_data(self, index, role)

Replacement method for model.data(). Create pixmaps as they’re requested by the data() method, to reduce loading time.

create_object_pixmap(self, display_icon)

Create and return a pixmap corresponding to display_icon.

class spinetoolbox.helpers.IconManager

A class to manage object class icons for data store forms.

ICON_SIZE

create_object_pixmap(self, display_icon)

Create a pixmap corresponding to display_icon, cache it, and return it.

setup_object_pixmaps(self, object_classes)

Called after adding or updating object classes. Create the corresponding object pixmaps and clear obsolete entries from the relationship class icon cache.

object_pixmap(self, object_class_name)

A pixmap for the given object class.

object_icon(self, object_class_name)

An icon for the given object class.

relationship_pixmap(self, str_object_class_name_list)

A pixmap for the given object class name list, created by rendering several object pixmaps next to each other.

relationship_icon(self, str_object_class_name_list)

An icon for the given object class name list.

class spinetoolbox.helpers.CharIconEngine(char, color)

Bases: PySide2.QtGui.QIconEngine

Specialization of QIconEngine used to draw font-based icons.

paint(self, painter, rect, mode=None, state=None)

pixmap(self, size, mode=None, state=None)

spinetoolbox.helpers.make_icon_id(icon_code, color_code)

Take icon and color codes, and return equivalent integer.

spinetoolbox.helpers.interpret_icon_id(display_icon)

Take a display icon integer and return an equivalent tuple of icon and color code.

spinetoolbox.helpers.default_icon_id()

class spinetoolbox.helpers.ProjectDirectoryIconProvider

Bases: PySide2.QtWidgets.QFileIconProvider

QFileIconProvider that provides a Spine icon to the Open Project Dialog when a Spine Toolbox project directory is encountered.

icon(self, info)

Returns an icon for the file described by info.

Parameters:info (QFileInfo) – File (or directory) info Returns:Icon for a file system resource with the given info Return type:QIcon

spinetoolbox.helpers.path_in_dir(path, directory)

Returns True if the given path is in the given directory.

spinetoolbox.helpers.serialize_path(path, project_dir)

Returns a dict representation of the given path.

If path is in project_dir, converts the path to relative. If path does not exist returns it as-is.

Parameters:

• path (str) – path to serialize
• project_dir (str) – path to the project directory

Returns:

Dictionary representing the given path

Return type:

dict

spinetoolbox.helpers.serialize_url(url, project_dir)

Return a dict representation of the given URL.

If the URL is a file that is in project dir, the URL is converted to a relative path.

Parameters:

• url (str) – a URL to serialize
• project_dir (str) – path to the project directory

Returns:

Dictionary representing the URL

Return type:

dict

spinetoolbox.helpers.deserialize_path(serialized, project_dir)

Returns a deserialized path or URL.

Parameters:

• serialized (dict) – a serialized path or URL
• project_dir (str) – path to the project directory

Returns:

Path or URL as string

Return type:

str