helpers

General helper functions and classes.

authors:

16. Savolainen (VTT)

date:

10.1.2018

Module Contents

helpers.set_taskbar_icon()

Set application icon to Windows taskbar.

helpers.supported_img_formats()

Function to check if reading .ico files is supported.

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)

helpers.spinedb_api_version_check()

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

helpers.busy_effect(func)

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

Parameters:func – Decorated function.

helpers.project_dir(qsettings)

Returns current project directory.

Parameters:qsettings (QSettings) – Settings object

helpers.get_datetime(show)

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

Parameters:show (boolean) – True returns date and time string. False returns empty string.

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.

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.

helpers.create_log_file_timestamp()

Creates a new timestamp string that is used as Data Interface and Data Store error log file.

Returns:Timestamp string or empty string if failed.

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

Method 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)

helpers.erase_dir(path, verbosity=False)

Delete directory and all its contents without prompt.

Parameters:

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

helpers.copy_dir(widget, src_dir, dst_dir)

Make a copy of a directory. All files and folders are copied.

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

helpers.rename_dir(widget, old_dir, new_dir)

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

Parameters:

• widget (QWidget) – Parent widget for QMessageBoxes
• old_dir (str) – Absolute path to directory that will be renamed
• new_dir (str) – Absolute path to new directory

helpers.fix_name_ambiguity(name_list, offset=0)

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

helpers.tuple_itemgetter(itemgetter_func, num_indexes)

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

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)) –

helpers.get_db_map(url, upgrade=False)

Returns a DiffDatabaseMapping instance from url. If the db is not the latest version, asks the user if they want to upgrade it.

helpers.do_get_db_map(url, upgrade)

Returns a DiffDatabaseMapping instance from url. Called by get_db_map.

helpers.int_list_to_row_count_tuples(int_list)

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

class 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 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 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)

helpers.make_icon_id(icon_code, color_code)

Take icon and color codes, and return equivalent integer.

helpers.interpret_icon_id(display_icon)

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

helpers.default_icon_id()