+"""
+
+import argparse
+from pathlib import Path
+import spinedb_api
+import spine_engine
+from spine_engine.config import BUNDLE_DIR
+import spine_items
+
+parser = argparse.ArgumentParser()
+parser.add_argument("--embedded-python", help="path to embedded Python interpreter", required=True)
+options = parser.parse_args()
+embedded_python_path = Path(options.embedded_python)
+spinedb_api_path = Path(spinedb_api.__file__).parent.parent
+spine_engine_path = Path(spine_engine.__file__).parent.parent
+spine_items_path = Path(spine_items.__file__).parent.parent
+data_file_target = Path()
+data_files = ("CHANGELOG.md", "README.md", "COPYING", "COPYING.LESSER")
+embedded_python_datas = [(str(path), BUNDLE_DIR) for path in embedded_python_path.iterdir()]
+a = Analysis(
+ ['spinetoolbox.py'],
+ pathex=list(set(map(str, (spinedb_api_path, spine_engine_path, spine_items_path)))),
+ binaries=[],
+ datas=[(data_file, str(Path())) for data_file in data_files] + embedded_python_datas,
+ hiddenimports=[],
+ hookspath=["PyInstaller hooks"],
+ hooksconfig={},
+ runtime_hooks=[],
+ excludes=[],
+ noarchive=False,
+)
+pyz = PYZ(a.pure)
+exe = EXE(
+ pyz,
+ a.scripts,
+ [],
+ exclude_binaries=True,
+ name='spinetoolbox',
+ icon=Path("spinetoolbox", "ui", "resources", "app.ico"),
+ debug=False,
+ bootloader_ignore_signals=False,
+ strip=False,
+ upx=True,
+ console=False,
+ disable_windowed_traceback=False,
+ argv_emulation=False,
+ target_arch=None,
+ codesign_identity=None,
+ entitlements_file=None,
+)
+coll = COLLECT(
+ exe,
+ a.binaries,
+ a.datas,
+ strip=False,
+ upx=True,
+ upx_exclude=[],
+ name='Spine Toolbox',
+)
diff --git a/spinetoolbox/__init__.py b/spinetoolbox/__init__.py
index ab8b72adc..dc2fd686b 100644
--- a/spinetoolbox/__init__.py
+++ b/spinetoolbox/__init__.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,8 +10,6 @@
# this program. If not, see .
######################################################################################################################
-"""
-spinetoolbox package.
-"""
+"""spinetoolbox package."""
from .version import __version__, __version_info__
diff --git a/spinetoolbox/__main__.py b/spinetoolbox/__main__.py
index baf36aa05..1d259d4bd 100644
--- a/spinetoolbox/__main__.py
+++ b/spinetoolbox/__main__.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,10 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-Spine Toolbox application main file.
-"""
-
+"""Spine Toolbox application main file."""
import sys
from spinetoolbox.main import main
diff --git a/spinetoolbox/config.py b/spinetoolbox/config.py
index b55e95ee1..4995d4580 100644
--- a/spinetoolbox/config.py
+++ b/spinetoolbox/config.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,16 +10,12 @@
# this program. If not, see .
######################################################################################################################
-"""
-Application constants and style sheets
-"""
-
+"""Application constants and style sheets."""
import sys
import os
from pathlib import Path
-# NOTE: All required Python package versions are in setup.cfg
-LATEST_PROJECT_VERSION = 11
+LATEST_PROJECT_VERSION = 13
# For the Add/Update SpineOpt wizard
REQUIRED_SPINE_OPT_VERSION = "0.6.9"
@@ -26,9 +23,9 @@
# Invalid characters for directory names
# NOTE: "." is actually valid in a directory name but this is
# to prevent the user from creating directories like /..../
-INVALID_CHARS = ["<", ">", ":", "\"", "/", "\\", "|", "?", "*", "."]
+INVALID_CHARS = ["<", ">", ":", '"', "/", "\\", "|", "?", "*", "."]
# Invalid characters for file names
-INVALID_FILENAME_CHARS = ["<", ">", ":", "\"", "/", "\\", "|", "?", "*"]
+INVALID_FILENAME_CHARS = ["<", ">", ":", '"', "/", "\\", "|", "?", "*"]
# Paths to application, configuration file, default project and work dirs, and documentation index page
_frozen = getattr(sys, "frozen", False)
@@ -66,10 +63,12 @@
"QLabel{color: black;}"
"QGroupBox{border: 2px solid gray; "
"background-color: qlineargradient(x1: 0, y1: 0, x2: 1, y2: 0, stop: 0 #80B0FF, stop: 1 #e6efff);"
+ "font-size: 14px;"
"border-radius: 5px;"
"margin-top: 0.5em;}"
"QGroupBox:title{border-radius: 2px; "
- "background-color: ghostwhite;"
+ "background-color: white;"
+ "border-radius: 5px;"
"subcontrol-origin: margin;"
"subcontrol-position: top center;"
"padding-top: 0px;"
diff --git a/spinetoolbox/execution_managers.py b/spinetoolbox/execution_managers.py
index f8c7f737c..038466a69 100644
--- a/spinetoolbox/execution_managers.py
+++ b/spinetoolbox/execution_managers.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,10 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-Classes to manage tool instance execution in various forms.
-"""
-
+"""Classes to manage tool instance execution in various forms."""
import logging
from PySide6.QtCore import QObject, QProcess, Slot, Signal
diff --git a/spinetoolbox/fetch_parent.py b/spinetoolbox/fetch_parent.py
index e7641f107..912758ca7 100644
--- a/spinetoolbox/fetch_parent.py
+++ b/spinetoolbox/fetch_parent.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,70 +10,69 @@
# this program. If not, see .
######################################################################################################################
-"""
-The FetchParent and FlexibleFetchParent classes.
-"""
-
-from PySide6.QtCore import QTimer, Signal, QObject
+"""The FetchParent and FlexibleFetchParent classes."""
+from PySide6.QtCore import QTimer, Signal, QObject, Qt
from .helpers import busy_effect
class FetchParent(QObject):
- """
- Attrs:
- fetch_token (int or None)
- will_have_children (bool or None): Whether this parent will have children if fetched.
- None means we don't know yet. Set to a boolean value whenever we find out.
- """
_changes_pending = Signal()
- def __init__(self, owner=None, chunk_size=1000):
+ def __init__(self, index=None, owner=None, chunk_size=1000):
"""
Args:
- owner (object): somebody who owns this FetchParent. If it's a QObject instance, then this FetchParent
- becomes obsolete whenever the owner is destroyed
- chunk_size (int or None): the number of items this parent should be happy with fetching at a time.
- If None, then no limit is imposed and the parent should fetch the entire contents of the DB.
+ index (FetchIndex, optional): an index to speedup looking up fetched items
+ owner (object, optional): somebody who owns this FetchParent.
+ If it's a QObject instance, then this FetchParent becomes obsolete whenever the owner is destroyed
+ chunk_size (int, optional): the number of items this parent should be happy with fetching at a time.
+ If None, then no limit is imposed and the parent should fetch the entire contents of the DB.
"""
super().__init__()
- self._timer = QTimer()
- self._items_to_add = {}
- self._items_to_update = {}
- self._items_to_remove = {}
+ self._version = 0
+ self._restore_item_callbacks = {}
+ self._update_item_callbacks = {}
+ self._remove_item_callbacks = {}
+ self._changes_by_db_map = {}
self._obsolete = False
self._fetched = False
self._busy = False
self._position = {}
- self.fetch_token = None
- self.will_have_children = None
+ self._timer = QTimer()
self._timer.setSingleShot(True)
self._timer.setInterval(0)
self._timer.timeout.connect(self._apply_pending_changes)
self._changes_pending.connect(self._timer.start)
+ self._index = index
self._owner = owner
if isinstance(self._owner, QObject):
self._owner.destroyed.connect(lambda obj=None: self.set_obsolete(True))
+ self.setParent(self._owner)
self.chunk_size = chunk_size
- def reset_fetching(self, fetch_token):
- """Resets fetch parent as if nothing was ever fetched.
+ def apply_changes_immediately(self):
+ # For tests
+ self._changes_pending.connect(self._apply_pending_changes, Qt.UniqueConnection)
- Args:
- fetch_token (object): current fetch token
- """
+ @property
+ def index(self):
+ return self._index
+
+ def reset(self):
+ """Resets fetch parent as if nothing was ever fetched."""
if self.is_obsolete:
return
+ self._version += 1
+ self._restore_item_callbacks.clear()
+ self._update_item_callbacks.clear()
+ self._remove_item_callbacks.clear()
self._timer.stop()
- self._items_to_add.clear()
- self._items_to_update.clear()
- self._items_to_remove.clear()
+ self._changes_by_db_map.clear()
self._fetched = False
self._busy = False
self._position.clear()
- self.fetch_token = fetch_token
- self.will_have_children = None
- self.will_have_children_change()
+ if self.index is not None:
+ self.index.reset()
def position(self, db_map):
return self._position.setdefault(db_map, 0)
@@ -84,38 +84,83 @@ def increment_position(self, db_map):
def _apply_pending_changes(self):
if self.is_obsolete:
return
- for db_map in list(self._items_to_add):
- data = self._items_to_add.pop(db_map)
- self.handle_items_added({db_map: data})
- for db_map in list(self._items_to_update):
- data = self._items_to_update.pop(db_map)
- self.handle_items_updated({db_map: data})
- for db_map in list(self._items_to_remove):
- data = self._items_to_remove.pop(db_map)
- self.handle_items_removed({db_map: data})
+ for db_map in list(self._changes_by_db_map):
+ changes = self._changes_by_db_map.pop(db_map)
+ last_handler = None
+ items = []
+ for handler, item in changes:
+ if handler == last_handler:
+ items.append(item)
+ continue
+ if items:
+ last_handler({db_map: items}) # pylint: disable=not-callable
+ items = [item]
+ last_handler = handler
+ last_handler({db_map: items})
QTimer.singleShot(0, lambda: self.set_busy(False))
- def add_item(self, item, db_map):
- self._items_to_add.setdefault(db_map, []).append(item)
+ def bind_item(self, item, db_map):
+ # NOTE: If `item` is in the process of calling callbacks in another thread,
+ # the ones added below won't be called.
+ # So, it is important to call this function before self.add_item()
+ item.add_restore_callback(self._make_restore_item_callback(db_map))
+ item.add_update_callback(self._make_update_item_callback(db_map))
+ item.add_remove_callback(self._make_remove_item_callback(db_map))
+
+ def _make_restore_item_callback(self, db_map):
+ if db_map not in self._restore_item_callbacks:
+ self._restore_item_callbacks[db_map] = _ItemCallback(self.add_item, db_map, self._version)
+ return self._restore_item_callbacks[db_map]
+
+ def _make_update_item_callback(self, db_map):
+ if db_map not in self._update_item_callbacks:
+ self._update_item_callbacks[db_map] = _ItemCallback(self.update_item, db_map, self._version)
+ return self._update_item_callbacks[db_map]
+
+ def _make_remove_item_callback(self, db_map):
+ if db_map not in self._remove_item_callbacks:
+ self._remove_item_callbacks[db_map] = _ItemCallback(self.remove_item, db_map, self._version)
+ return self._remove_item_callbacks[db_map]
+
+ def _is_valid(self, version):
+ return (version is None or version == self._version) and not self.is_obsolete
+
+ def _change_item(self, handler, item, db_map, version):
+ if not self._is_valid(version):
+ return False
+ self._changes_by_db_map.setdefault(db_map, []).append((handler, item))
self._changes_pending.emit()
+ return True
- def update_item(self, item, db_map):
- self._items_to_update.setdefault(db_map, []).append(item)
- self._changes_pending.emit()
+ def add_item(self, item, db_map, version=None):
+ return self._change_item(self.handle_items_added, item, db_map, version)
- def remove_item(self, item, db_map):
- self._items_to_remove.setdefault(db_map, []).append(item)
- self._changes_pending.emit()
+ def update_item(self, item, db_map, version=None):
+ return self._change_item(self.handle_items_updated, item, db_map, version)
+
+ def remove_item(self, item, db_map, version=None):
+ return self._change_item(self.handle_items_removed, item, db_map, version)
@property
def fetch_item_type(self):
- """Returns the type of item to fetch, e.g., "object_class".
+ """Returns the DB item type to fetch, e.g., "entity_class".
Returns:
str
"""
raise NotImplementedError()
+ def key_for_index(self, db_map):
+ """Returns the key for this parent in the index.
+
+ Args:
+ db_map (DatabaseMapping)
+
+ Returns:
+ Any
+ """
+ return None
+
# pylint: disable=no-self-use
def accepts_item(self, item, db_map):
"""Called by the associated SpineDBWorker whenever items are fetched and also added/updated/removed.
@@ -126,7 +171,7 @@ def accepts_item(self, item, db_map):
Args:
item (dict): The item
- db_map (DiffDatabaseMapping)
+ db_map (DatabaseMapping)
Returns:
bool
@@ -140,16 +185,13 @@ def shows_item(self, item, db_map):
Args:
item (dict): The item
- db_map (DiffDatabaseMapping)
+ db_map (DatabaseMapping)
Returns:
bool
"""
return True
- def will_have_children_change(self):
- """Called when the will_have_children property changes."""
-
@property
def is_obsolete(self):
return self._obsolete
@@ -160,6 +202,8 @@ def set_obsolete(self, obsolete):
Args:
obsolete (bool): whether parent has become obsolete
"""
+ if obsolete:
+ self.set_busy(False)
self._obsolete = obsolete
@property
@@ -172,6 +216,8 @@ def set_fetched(self, fetched):
Args:
fetched (bool): whether parent has been fetched completely
"""
+ if fetched:
+ self.set_busy(False)
self._fetched = fetched
@property
@@ -191,7 +237,7 @@ def handle_items_added(self, db_map_data):
Called by SpineDBWorker when items are added to the DB.
Args:
- db_map_data (dict): Mapping DiffDatabaseMapping instances to list of dict-items for which
+ db_map_data (dict): Mapping DatabaseMapping instances to list of dict-items for which
``accepts_item()`` returns True.
"""
raise NotImplementedError(self.fetch_item_type)
@@ -201,7 +247,7 @@ def handle_items_removed(self, db_map_data):
Called by SpineDBWorker when items are removed from the DB.
Args:
- db_map_data (dict): Mapping DiffDatabaseMapping instances to list of dict-items for which
+ db_map_data (dict): Mapping DatabaseMapping instances to list of dict-items for which
``accepts_item()`` returns True.
"""
raise NotImplementedError(self.fetch_item_type)
@@ -211,15 +257,15 @@ def handle_items_updated(self, db_map_data):
Called by SpineDBWorker when items are updated in the DB.
Args:
- db_map_data (dict): Mapping DiffDatabaseMapping instances to list of dict-items for which
+ db_map_data (dict): Mapping DatabaseMapping instances to list of dict-items for which
``accepts_item()`` returns True.
"""
raise NotImplementedError(self.fetch_item_type)
class ItemTypeFetchParent(FetchParent):
- def __init__(self, fetch_item_type, owner=None, chunk_size=1000):
- super().__init__(owner=owner, chunk_size=chunk_size)
+ def __init__(self, fetch_item_type, index=None, owner=None, chunk_size=1000):
+ super().__init__(index=index, owner=owner, chunk_size=chunk_size)
self._fetch_item_type = fetch_item_type
@property
@@ -252,17 +298,23 @@ def __init__(
handle_items_updated=None,
accepts_item=None,
shows_item=None,
- will_have_children_change=None,
+ key_for_index=None,
+ index=None,
owner=None,
chunk_size=1000,
):
- super().__init__(fetch_item_type, owner=owner, chunk_size=chunk_size)
- self._accepts_item = accepts_item
- self._shows_item = shows_item
+ super().__init__(fetch_item_type, index=index, owner=owner, chunk_size=chunk_size)
self._handle_items_added = handle_items_added
self._handle_items_removed = handle_items_removed
self._handle_items_updated = handle_items_updated
- self._will_have_children_change = will_have_children_change
+ self._accepts_item = accepts_item
+ self._shows_item = shows_item
+ self._key_for_index = key_for_index
+
+ def key_for_index(self, db_map):
+ if self._key_for_index is None:
+ return None
+ return self._key_for_index(db_map)
def handle_items_added(self, db_map_data):
if self._handle_items_added is None:
@@ -289,8 +341,36 @@ def shows_item(self, item, db_map):
return super().shows_item(item, db_map)
return self._shows_item(item, db_map)
- def will_have_children_change(self):
- if self._will_have_children_change is None:
- super().will_have_children_change()
- else:
- self._will_have_children_change()
+
+class FetchIndex(dict):
+ def __init__(self):
+ super().__init__()
+ self._position = {}
+
+ def reset(self):
+ self._position.clear()
+ self.clear()
+
+ def process_item(self, item, db_map):
+ raise NotImplementedError()
+
+ def position(self, db_map):
+ return self._position.setdefault(db_map, 0)
+
+ def increment_position(self, db_map):
+ self._position[db_map] += 1
+
+ def get_items(self, key, db_map):
+ return self.get(db_map, {}).get(key, [])
+
+
+class _ItemCallback:
+ def __init__(self, fn, *args):
+ self._fn = fn
+ self._args = args
+
+ def __call__(self, item):
+ return self._fn(item, *self._args)
+
+ def __str__(self):
+ return str(self._fn) + " with " + str(self._args)
diff --git a/spinetoolbox/headless.py b/spinetoolbox/headless.py
index 783bfbb7e..1147b6375 100644
--- a/spinetoolbox/headless.py
+++ b/spinetoolbox/headless.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,9 +10,8 @@
# this program. If not, see .
######################################################################################################################
-"""
-Contains facilities to open and execute projects without GUI.
-"""
+"""Contains facilities to open and execute projects without GUI."""
+import os
from copy import deepcopy
from enum import IntEnum, unique
import json
@@ -19,13 +19,15 @@
import sys
from PySide6.QtCore import QCoreApplication, QEvent, QObject, QSettings, Signal, Slot
import networkx as nx
-
from spine_engine import SpineEngineState
from spine_engine.exception import EngineInitFailed
from spine_engine.load_project_items import load_item_specification_factories
from spine_engine.utils.serialization import deserialize_path
+from spine_engine.utils.helpers import get_file_size, ExecutionDirection
+from spine_engine.server.util.zip_handler import ZipHandler
+from .server.engine_client import EngineClient, RemoteEngineInitFailed, ClientSecurityModel
from .project_item.logging_connection import HeadlessConnection
-from .config import LATEST_PROJECT_VERSION
+from .config import LATEST_PROJECT_VERSION, PROJECT_ZIP_FILENAME
from .helpers import (
make_settings_dict_for_engine,
plugins_dirs,
@@ -193,6 +195,7 @@ def __init__(self, args, startup_event_type, parent):
self._plugin_specifications = None
self._connection_dicts = None
self._jump_dicts = None
+ self._server_config = None
def _dags(self):
graph = nx.DiGraph()
@@ -210,6 +213,12 @@ def _execute(self):
return
try:
status = self._open_project()
+ if self._args.execute_remotely:
+ self._server_config = self._read_server_config()
+ if not self._server_config:
+ self._logger.msg_error.emit("Reading server config file failed.")
+ QCoreApplication.instance().exit(Status.ARGUMENT_ERROR)
+ return
if status != Status.OK:
QCoreApplication.instance().exit(status)
return
@@ -319,9 +328,16 @@ def _execute_project(self):
spec_dict["definition_file_path"] = spec.definition_file_path
self._specification_dicts.setdefault(item_type, []).append(spec_dict)
dags = self._dags()
+ job_id = self._prepare_remote_execution()
+ if not job_id:
+ self._logger.msg_error.emit("Pinging the server or uploading the project failed.")
+ return Status.ERROR
settings = make_settings_dict_for_engine(self._app_settings)
- # Force local execution in headless mode
- if not settings.get("engineSettings/remoteExecutionEnabled", "false") == "false":
+ # Enable remote execution if server config file was given, else force local execution
+ if self._server_config is not None:
+ settings["engineSettings/remoteExecutionEnabled"] = "true"
+ settings = self._insert_remote_engine_settings(settings)
+ else:
settings["engineSettings/remoteExecutionEnabled"] = "false"
selected = {name for name_list in self._args.select for name in name_list} if self._args.select else None
deselected = {name for name_list in self._args.deselect for name in name_list} if self._args.deselect else None
@@ -352,11 +368,10 @@ def _execute_project(self):
"execution_permits": execution_permits,
"items_module_name": "spine_items",
"settings": settings,
- "project_dir": self._project_dir,
+ "project_dir": solve_project_dir(self._project_dir),
}
- # exec_remotely is forced to False (see above)
- exec_remotely = settings.get("engineSettings/remoteExecutionEnabled", "false") == "true"
- engine_manager = make_engine_manager(exec_remotely)
+ exec_remotely = True if self._server_config else False
+ engine_manager = make_engine_manager(exec_remotely, job_id=job_id)
try:
engine_manager.run_engine(engine_data)
except EngineInitFailed as error:
@@ -390,6 +405,7 @@ def _process_engine_event(self, event_type, data):
"standard_execution_msg": self._handle_standard_execution_msg,
"persistent_execution_msg": self._handle_persistent_execution_msg,
"kernel_execution_msg": self._handle_kernel_execution_msg,
+ "server_status_msg": self._handle_server_status_msg,
}.get(event_type)
if handler is None:
return
@@ -408,7 +424,7 @@ def _handle_node_execution_started(self, data):
Args:
data (dict): execution start data
"""
- if data["direction"] == "BACKWARD":
+ if data["direction"] == ExecutionDirection.BACKWARD:
# Currently there are no interesting messages when executing backwards.
return
self._node_messages[data["item_name"]] = dict()
@@ -482,6 +498,103 @@ def _handle_kernel_execution_msg(self, data):
data (dict): message data
"""
+ def _handle_server_status_msg(self, data):
+ """Handles received remote execution messages."""
+ if data["msg_type"] == "success":
+ self._logger.msg_success.emit(data["text"])
+ elif data["msg_type"] == "neutral":
+ self._logger.msg.emit(data["text"])
+ elif data["msg_type"] == "fail":
+ self._logger.msg_error.emit(data["text"])
+ elif data["msg_type"] == "warning":
+ self._logger.msg_warning.emit(data["text"])
+
+ def _read_server_config(self):
+ """Reads the user provided server settings file that the client requires to establish connection.
+
+ Returns:
+ dict: Dictionary containing the EngineClient settings or None if the given config file does not exist.
+ """
+ cfg_file = self._args.execute_remotely[0]
+ cfg_fp = os.path.join(self._project_dir, cfg_file)
+ if os.path.isfile(cfg_fp):
+ with open(cfg_fp, encoding="utf-8") as fp:
+ lines = fp.readlines()
+ lines = [l.strip() for l in lines]
+ host = lines[0]
+ port = lines[1]
+ smodel = lines[2]
+ rel_sec_folder = lines[3]
+ sec_model = "stonehouse" if smodel.lower() == "on" else ""
+ if sec_model == "stonehouse":
+ sec_folder = os.path.abspath(os.path.join(solve_project_dir(self._project_dir), rel_sec_folder))
+ else:
+ sec_folder = ""
+ cfg_dict = {"host": host, "port": port, "security_model": sec_model, "security_folder": sec_folder}
+ return cfg_dict
+ else:
+ self._logger.msg_error.emit(f"cfg file '{cfg_fp}' missing.")
+ return None
+
+ def _insert_remote_engine_settings(self, settings):
+ """Inserts remote engine client settings into the settings dictionary that is delivered to the engine.
+
+ Args:
+ settings (dict): Original settings dictionary
+
+ Returns:
+ dict: Settings dictionary containing remote engine client settings
+ """
+ settings["engineSettings/remoteHost"] = self._server_config["host"]
+ settings["engineSettings/remotePort"] = self._server_config["port"]
+ settings["engineSettings/remoteSecurityModel"] = self._server_config["security_model"]
+ settings["engineSettings/remoteSecurityFolder"] = self._server_config["security_folder"]
+ return settings
+
+ def _prepare_remote_execution(self):
+ """If remote execution is enabled, makes an EngineClient for pinging and uploading the project.
+ If ping is successful, the project is uploaded to the server. If the upload is successful, the
+ server responds with a Job id, which is later used by the client to make a 'start execution'
+ request.
+
+ Returns:
+ str: Job id if server is ready for remote execution, empty string if something went wrong
+ or "1" if local execution is enabled.
+ """
+ if not self._server_config:
+ return "1"
+ host, port = self._server_config["host"], self._server_config["port"]
+ security_on = False if self._server_config["security_model"].lower() == "" else True
+ sec_model = ClientSecurityModel.STONEHOUSE if security_on else ClientSecurityModel.NONE
+ try:
+ engine_client = EngineClient(host, port, sec_model, self._server_config["security_folder"])
+ except RemoteEngineInitFailed as e:
+ self._logger.msg_error.emit(f"Server is not responding in {host}:{port}. {e}.")
+ return ""
+ engine_client.set_start_time() # Set start_time for upload operation
+ # Archive the project into a zip-file
+ dest_dir = os.path.join(self._project_dir, os.pardir) # Parent dir of project_dir
+ _, project_name = os.path.split(self._project_dir)
+ self._logger.msg.emit(f"Squeezing project {project_name} into {PROJECT_ZIP_FILENAME}.zip")
+ try:
+ ZipHandler.package(src_folder=self._project_dir, dst_folder=dest_dir, fname=PROJECT_ZIP_FILENAME)
+ except Exception as e:
+ self._logger.msg_error.emit(f"{e}")
+ engine_client.close()
+ return ""
+ project_zip_file = os.path.abspath(os.path.join(self._project_dir, os.pardir, PROJECT_ZIP_FILENAME + ".zip"))
+ if not os.path.isfile(project_zip_file):
+ self._logger.msg_error.emit(f"Project zip-file {project_zip_file} does not exist")
+ engine_client.close()
+ return ""
+ file_size = get_file_size(os.path.getsize(project_zip_file))
+ self._logger.msg_warning.emit(f"Uploading project [{file_size}] ...")
+ job_id = engine_client.upload_project(project_name, project_zip_file)
+ t = engine_client.get_elapsed_time()
+ self._logger.msg.emit(f"Upload time: {t}. Job ID: {job_id}")
+ engine_client.close()
+ return job_id
+
def headless_main(args):
"""
@@ -551,6 +664,18 @@ def _specification_dicts(project_dict, project_dir, logger):
return specification_dicts
+def solve_project_dir(pd):
+ """Makes given path object OS independent.
+
+ Args:
+ pd (Path): Path Object
+
+ Returns:
+ str: OS independent path as string.
+ """
+ return str(pd).replace(os.sep, "/")
+
+
@unique
class Status(IntEnum):
"""Status codes returned from headless execution."""
diff --git a/spinetoolbox/helpers.py b/spinetoolbox/helpers.py
index b7db7e840..3666c53b4 100644
--- a/spinetoolbox/helpers.py
+++ b/spinetoolbox/helpers.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,9 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-General helper functions and classes.
-"""
+"""General helper functions and classes."""
import functools
import time
from enum import Enum, unique
@@ -28,11 +27,13 @@
import bisect
from contextlib import contextmanager
import tempfile
+from typing import Sequence
+
import matplotlib
from PySide6.QtCore import Qt, Slot, QFile, QIODevice, QSize, QRect, QPoint, QUrl, QObject, QEvent
from PySide6.QtCore import __version__ as qt_version
from PySide6.QtCore import __version_info__ as qt_version_info
-from PySide6.QtWidgets import QApplication, QMessageBox, QFileIconProvider, QStyle, QFileDialog, QInputDialog
+from PySide6.QtWidgets import QApplication, QMessageBox, QFileIconProvider, QStyle, QFileDialog, QInputDialog, QSplitter
from PySide6.QtGui import (
QGuiApplication,
QCursor,
@@ -51,9 +52,11 @@
QColor,
QFont,
QPainter,
+ QUndoCommand,
)
from spine_engine.utils.serialization import deserialize_path
from spinedb_api.spine_io.gdx_utils import find_gams_directory
+from spinedb_api.helpers import group_consecutive
from .config import (
DEFAULT_WORK_DIR,
PLUGINS_PATH,
@@ -66,7 +69,7 @@
if os.name == "nt":
import ctypes
-matplotlib.use('Qt5Agg')
+matplotlib.use("Qt5Agg")
matplotlib.rcParams.update({"font.size": 8})
logging.getLogger("matplotlib").setLevel(logging.WARNING)
_matplotlib_version = [int(x) for x in matplotlib.__version__.split(".") if x.isdigit()]
@@ -147,7 +150,7 @@ def create_dir(base_path, folder="", verbosity=False):
def rename_dir(old_dir, new_dir, toolbox, box_title):
- """Renames directory. Called by ``ProjectItemModel.set_item_name()``
+ """Renames directory.
Args:
old_dir (str): Absolute path to directory that will be renamed
@@ -238,7 +241,7 @@ def set_taskbar_icon():
def supported_img_formats():
"""Checks if reading .ico files is supported."""
img_formats = QImageReader().supportedImageFormats()
- img_formats_str = '\n'.join(str(x) for x in img_formats)
+ img_formats_str = "\n".join(str(x) for x in img_formats)
logging.debug("Supported Image formats:\n%s", img_formats_str)
@@ -300,7 +303,7 @@ def copy_files(src_dir, dst_dir, includes=None, excludes=None):
count (int): Number of files copied
"""
if includes is None:
- includes = ['*']
+ includes = ["*"]
if excludes is None:
excludes = []
src_files = []
@@ -406,8 +409,7 @@ def format_string_list(str_list):
def rows_to_row_count_tuples(rows):
- """Breaks a list of rows into a list of (row, count) tuples to corresponding
- chunks of successive rows.
+ """Breaks a list of rows into a list of (row, count) tuples corresponding to chunks of successive rows.
Args:
rows (Iterable of int): rows
@@ -415,14 +417,7 @@ def rows_to_row_count_tuples(rows):
Returns:
list of tuple: row count tuples
"""
- rows = set(rows)
- if not rows:
- return []
- sorted_rows = sorted(rows)
- break_points = [k + 1 for k in range(len(sorted_rows) - 1) if sorted_rows[k] + 1 != sorted_rows[k + 1]]
- break_points = [0] + break_points + [len(sorted_rows)]
- ranges = [(break_points[l], break_points[l + 1]) for l in range(len(break_points) - 1)]
- return [(sorted_rows[start], stop - start) for start, stop in ranges]
+ return [(first, last - first + 1) for first, last in group_consecutive(rows)]
class IconListManager:
@@ -511,7 +506,7 @@ def __init__(self, char, color=None):
super().__init__()
self.char = char
self.color = QColor(color)
- self.font = QFont('Font Awesome 5 Free Solid')
+ self.font = QFont("Font Awesome 5 Free Solid")
def paint(self, painter, rect, mode=None, state=None):
painter.save()
@@ -871,8 +866,8 @@ def select_conda_executable(parent, line_edit):
if answer[0] == "": # Canceled
return
# Check that selected file at least starts with string 'conda'
- _, selected_file = os.path.split(answer[0])
- if not selected_file.lower().startswith("conda"):
+ if not is_valid_conda_executable(answer[0]):
+ _, selected_file = os.path.split(answer[0])
msg = "Selected file {0} is not a valid Conda executable".format(selected_file)
# noinspection PyCallByClass, PyArgumentList
QMessageBox.warning(parent, "Invalid Conda selected", msg)
@@ -880,6 +875,20 @@ def select_conda_executable(parent, line_edit):
line_edit.setText(answer[0])
+def is_valid_conda_executable(p):
+ """Checks that given path points to an existing file and the file name starts with 'conda'.
+
+ Args:
+ p (str): Absolute path to a file
+ """
+ if not os.path.isfile(p):
+ return False
+ _, filename = os.path.split(p)
+ if not filename.lower().startswith("conda"):
+ return False
+ return True
+
+
def select_certificate_directory(parent, line_edit):
"""Shows file browser and inserts selected certificate directory to given line edit.
@@ -1011,11 +1020,11 @@ def make_icon_toolbar_ss(color):
return f"QToolBar{{spacing: 0px; background: {icon_background}; padding: 3px; border-style: solid;}}"
-def color_from_index(i, count, base_hue=0.0, saturation=1.0):
+def color_from_index(i, count, base_hue=0.0, saturation=1.0, value=1.0):
golden_ratio = 0.618033988749895
h = golden_ratio * (360 / count) * i
h = ((base_hue + h) % 360) / 360
- return QColor.fromHsvF(h, saturation, 1.0, 1.0)
+ return QColor.fromHsvF(h, saturation, value, 1.0)
def unique_name(prefix, existing):
@@ -1052,21 +1061,6 @@ def unique_name(prefix, existing):
return f"{prefix} ({free})"
-def get_upgrade_db_promt_text(url, current, expected):
- text = (
- f"The database at {url} is at revision {current} and needs to be "
- f"upgraded to revision {expected} in order to be used with the current "
- "version of Spine Toolbox."
- )
- info_text = (
- "WARNING: After the upgrade, "
- "the database may no longer be used "
- "with previous versions of Spine."
- "Do you want to upgrade the database now?"
- )
- return text, info_text
-
-
def parse_specification_file(spec_path, logger):
"""Parses specification file.
@@ -1306,6 +1300,16 @@ def wait(self):
@contextmanager
def signal_waiter(signal, condition=None, timeout=None):
+ """Gives a context manager that waits for the emission of given Qt signal.
+
+ Args:
+ signal (Any): signal to wait
+ condition (Callable, optional): a callable that takes the signal's parameters and returns True to stop waiting
+ timeout (float, optional): timeout in seconds; if None, wait indefinitely
+
+ Yields:
+ SignalWaiter: waiter instance
+ """
waiter = SignalWaiter(condition=condition, timeout=timeout)
signal.connect(waiter.trigger)
try:
@@ -1329,17 +1333,17 @@ def set_style(self, style):
self._formats.clear()
for ttype, tstyle in style:
text_format = self._formats[ttype] = QTextCharFormat()
- if tstyle['color']:
- brush = QBrush(QColor("#" + tstyle['color']))
+ if tstyle["color"]:
+ brush = QBrush(QColor("#" + tstyle["color"]))
text_format.setForeground(brush)
- if tstyle['bgcolor']:
- brush = QBrush(QColor("#" + tstyle['bgcolor']))
+ if tstyle["bgcolor"]:
+ brush = QBrush(QColor("#" + tstyle["bgcolor"]))
text_format.setBackground(brush)
- if tstyle['bold']:
+ if tstyle["bold"]:
text_format.setFontWeight(QFont.Bold)
- if tstyle['italic']:
+ if tstyle["italic"]:
text_format.setFontItalic(True)
- if tstyle['underline']:
+ if tstyle["underline"]:
text_format.setFontUnderline(True)
def yield_formats(self, text):
@@ -1391,8 +1395,11 @@ def restore_ui(window, app_settings, settings_group):
window_size = app_settings.value("windowSize")
window_pos = app_settings.value("windowPosition")
window_state = app_settings.value("windowState")
- window_maximized = app_settings.value("windowMaximized", defaultValue='false')
+ window_maximized = app_settings.value("windowMaximized", defaultValue="false")
n_screens = app_settings.value("n_screens", defaultValue=1)
+ splitter_states = {
+ splitter: app_settings.value(splitter.objectName() + "State") for splitter in window.findChildren(QSplitter)
+ }
app_settings.endGroup()
original_size = window.size()
if window_size:
@@ -1405,8 +1412,10 @@ def restore_ui(window, app_settings, settings_group):
if len(QGuiApplication.screens()) < int(n_screens):
# There are less screens available now than on previous application startup
window.move(0, 0) # Move this widget to primary screen position (0,0)
+ for splitter, state in splitter_states.items():
+ splitter.restoreState(state)
ensure_window_is_on_screen(window, original_size)
- if window_maximized == 'true':
+ if window_maximized == "true":
window.setWindowState(Qt.WindowMaximized)
@@ -1424,6 +1433,8 @@ def save_ui(window, app_settings, settings_group):
app_settings.setValue("windowState", window.saveState(version=1))
app_settings.setValue("windowMaximized", window.windowState() == Qt.WindowMaximized)
app_settings.setValue("n_screens", len(QGuiApplication.screens()))
+ for splitter in window.findChildren(QSplitter):
+ app_settings.setValue(splitter.objectName() + "State", splitter.saveState())
app_settings.endGroup()
@@ -1549,31 +1560,6 @@ def _is_metadata_item(item):
return "name" in item and "value" in item
-def separate_metadata_and_item_metadata(db_map_data):
- """Separates normal metadata items from item metadata items.
-
- Args:
- db_map_data (dict): database records
-
- Returns:
- tuple: item metadata records and metadata records
- """
- metadata_db_map_data = {}
- item_metadata_db_map_data = {}
- for db_map, items in db_map_data.items():
- metadata_items = []
- entity_metadata_items = []
- for item in items:
- if _is_metadata_item(item):
- metadata_items.append(item)
- else:
- entity_metadata_items.append(item)
- if metadata_items:
- metadata_db_map_data[db_map] = metadata_items
- item_metadata_db_map_data[db_map] = entity_metadata_items
- return item_metadata_db_map_data, metadata_db_map_data
-
-
class HTMLTagFilter(HTMLParser):
"""HTML tag filter."""
@@ -1630,3 +1616,66 @@ def solve_connection_file(connection_file, connection_file_dict):
fp.close()
return connection_file
return connection_file
+
+
+def remove_first(lst, items):
+ for x in items:
+ try:
+ lst.remove(x)
+ break
+ except ValueError:
+ pass
+
+
+class SealCommand(QUndoCommand):
+ """A 'meta' command that does not store undo data but can be used in mergeWith methods of other commands."""
+
+ def __init__(self, command_id=1):
+ """
+ Args:
+ command_id (int): command id
+ """
+ super().__init__("")
+ self._id = command_id
+
+ def redo(self):
+ self.setObsolete(True)
+
+ def id(self):
+ return self._id
+
+
+def plain_to_rich(text):
+ """Turns plain strings into rich text.
+
+ Args:
+ text (str): string to convert
+
+ Returns:
+ str: rich text string
+ """
+ return "" + text + ""
+
+
+def list_to_rich_text(data):
+ """Turns a sequence of strings into rich text list.
+
+ Args:
+ data (Sequence of str): iterable to convert
+
+ Returns:
+ str: rich text string
+ """
+ return plain_to_rich("
".join(data))
+
+
+def plain_to_tool_tip(text):
+ """Turns plain strings into rich text and empty strings/Nones to None.
+
+ Args:
+ text (str, optional): string to convert
+
+ Returns:
+ str or NoneType: rich text string or None
+ """
+ return plain_to_rich(text) if text else None
diff --git a/spinetoolbox/kernel_fetcher.py b/spinetoolbox/kernel_fetcher.py
index be1b52943..cf4e3b9ff 100644
--- a/spinetoolbox/kernel_fetcher.py
+++ b/spinetoolbox/kernel_fetcher.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -10,7 +11,6 @@
######################################################################################################################
"""Contains a class for fetching kernel specs in a thread."""
-
import os
import json
from PySide6.QtCore import Signal, Slot, QThread
diff --git a/spinetoolbox/link.py b/spinetoolbox/link.py
index 42562a6bd..0cc31a2a9 100644
--- a/spinetoolbox/link.py
+++ b/spinetoolbox/link.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,10 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-Classes for drawing graphics items on QGraphicsScene.
-"""
-
+"""Classes for drawing graphics items on QGraphicsScene."""
import functools
from math import sin, cos, pi, radians
from PySide6.QtCore import Qt, Slot, QPointF, QLineF, QRectF, QVariantAnimation
@@ -288,7 +286,7 @@ def hoverLeaveEvent(self, event):
class _SvgIcon(_IconBase):
- """A svg icon to show over a Link."""
+ """An SVG icon to show over a Link."""
def __init__(self, parent, extent, path, tooltip=None, active=False):
super().__init__(0, 0, extent, extent, parent, tooltip=tooltip, active=active)
@@ -317,7 +315,7 @@ class _TextIcon(_IconBase):
def __init__(self, parent, extent, char, tooltip=None, active=False):
super().__init__(0, 0, extent, extent, parent, tooltip=tooltip, active=active)
self._text_item = QGraphicsTextItem(self)
- font = QFont('Font Awesome 5 Free Solid', weight=QFont.Bold)
+ font = QFont("Font Awesome 5 Free Solid", weight=QFont.Bold)
self._text_item.setFont(font)
self._text_item.setDefaultTextColor(self._fg_color)
self._text_item.setPlainText(char)
@@ -370,7 +368,7 @@ def _place_icons(self):
if icon_count == 1:
self._icons[0].setPos(center - offset)
return
- points = list(_regular_poligon_points(icon_count, icon_extent, self._guide_path.angleAtPercent(0.5)))
+ points = list(_regular_polygon_points(icon_count, icon_extent, self._guide_path.angleAtPercent(0.5)))
points_center = functools.reduce(lambda a, b: a + b, points) / icon_count
offset += points_center - center
scale = icon_extent / self._icon_extent
@@ -628,12 +626,14 @@ def wake_up(self, src_connector):
view = self._toolbox.ui.graphicsView
self.tip = view.mapToScene(view.mapFromGlobal(QCursor.pos()))
self.src_connector = src_connector
- self.src_connector.scene().addItem(self)
+ scene = self.src_connector.scene()
+ scene.addItem(self)
self._stroker.setWidth(self.magic_number)
self._pen.setWidthF(self.magic_number)
self.setPen(self._pen)
self.update_geometry()
self.show()
+ scene.link_about_to_be_drawn.emit()
def sleep(self):
"""Removes this drawer from the scene, clears its source and destination connectors, and hides it.
@@ -643,6 +643,7 @@ def sleep(self):
scene.removeItem(self)
scene.link_drawer = self.src_connector = self.dst_connector = self.tip = None
self.hide()
+ scene.link_drawing_finished.emit()
class ConnectionLinkDrawer(LinkDrawerBase):
@@ -689,7 +690,7 @@ def add_link(self):
self.sleep()
-def _regular_poligon_points(n, side, initial_angle=0):
+def _regular_polygon_points(n, side, initial_angle=0):
internal_angle = 180 * (n - 2) / n
angle_inc = 180 - internal_angle
current_angle = initial_angle
diff --git a/spinetoolbox/load_project_items.py b/spinetoolbox/load_project_items.py
index e66092982..dab524c9a 100644
--- a/spinetoolbox/load_project_items.py
+++ b/spinetoolbox/load_project_items.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,23 +10,12 @@
# this program. If not, see .
######################################################################################################################
-"""
-Functions to load project item modules.
-"""
-import pathlib
+""" Functions to load project item modules. """
import importlib
-import importlib.util
-import pkgutil
-from spine_engine.project_item.project_item_info import ProjectItemInfo
-from spine_engine import __version__ as curr_engine_version
-from spinedb_api import __version__ as curr_db_api_version
-from .version import __version__ as curr_toolbox_version
-from .project_item.project_item_factory import ProjectItemFactory
def load_project_items(items_package_name):
- """
- Loads project item modules.
+ """Loads project item modules.
Args:
items_package_name (str): name of the package that contains the project items
@@ -35,38 +25,4 @@ def load_project_items(items_package_name):
while second maps item type to item factory
"""
items = importlib.import_module(items_package_name)
- items_root = pathlib.Path(items.__file__).parent
- categories = dict()
- factories = dict()
- for child in items_root.iterdir():
- if child.is_dir() and (child.joinpath("__init__.py").exists() or child.joinpath("__init__.pyc").exists()):
- spec = importlib.util.find_spec(f"{items_package_name}.{child.stem}")
- module = importlib.util.module_from_spec(spec)
- spec.loader.exec_module(module)
- module_material = _find_module_material(module)
- if module_material is not None:
- item_type, category, factory = module_material
- categories[item_type] = category
- factories[item_type] = factory
- return categories, factories
-
-
-def _find_module_material(module):
- item_type = None
- category = None
- factory = None
- prefix = module.__name__ + "."
- for _, modname, _ in pkgutil.iter_modules(module.__path__, prefix):
- submodule = __import__(modname, fromlist="dummy")
- for name in dir(submodule):
- attr = getattr(submodule, name)
- if not isinstance(attr, type):
- continue
- if attr is not ProjectItemInfo and issubclass(attr, ProjectItemInfo):
- item_type = attr.item_type()
- category = attr.item_category()
- if attr is not ProjectItemFactory and issubclass(attr, ProjectItemFactory):
- factory = attr
- if item_type is not None and factory is not None:
- return item_type, category, factory
- return None
+ return items.item_factories()
diff --git a/spinetoolbox/log_mixin.py b/spinetoolbox/log_mixin.py
index 27a376960..e09aceae4 100644
--- a/spinetoolbox/log_mixin.py
+++ b/spinetoolbox/log_mixin.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -8,10 +9,8 @@
# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
# this program. If not, see .
######################################################################################################################
-"""
-Contains LogMixin.
-"""
+"""Contains LogMixin."""
from .helpers import format_log_message
diff --git a/spinetoolbox/logger_interface.py b/spinetoolbox/logger_interface.py
index e510f449d..798575e16 100644
--- a/spinetoolbox/logger_interface.py
+++ b/spinetoolbox/logger_interface.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,10 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-A logger interface.
-"""
-
+"""A logger interface."""
from PySide6.QtCore import QObject, Signal
diff --git a/spinetoolbox/main.py b/spinetoolbox/main.py
index efd598418..88e40c30a 100644
--- a/spinetoolbox/main.py
+++ b/spinetoolbox/main.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,9 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-Provides the main() function.
-"""
+"""Provides the main() function."""
import os
import multiprocessing
import PySide6
@@ -44,15 +43,15 @@ def main():
logging.basicConfig(
stream=sys.stderr,
level=logging.DEBUG,
- format='%(asctime)s %(levelname)s: %(message)s',
- datefmt='%Y-%m-%d %H:%M:%S',
+ format="%(asctime)s %(levelname)s: %(message)s",
+ datefmt="%Y-%m-%d %H:%M:%S",
)
if not pyside6_version_check():
return 1
_add_pywin32_system32_to_path()
parser = _make_argument_parser()
args = parser.parse_args()
- if args.execute_only or args.list_items:
+ if args.execute_only or args.list_items or args.execute_remotely:
return_code = headless_main(args)
if return_code == Status.ARGUMENT_ERROR:
parser.print_usage()
@@ -94,10 +93,11 @@ def _make_argument_parser():
"-d",
"--deselect",
action="append",
- help="deselect project item ITEM for execution (takes precendence over --select)",
+ help="deselect project item ITEM for execution (takes precedence over --select)",
nargs="*",
metavar="ITEM",
)
+ parser.add_argument("--execute-remotely", help="execute remotely", action="append", metavar="SERVER CONFIG FILE")
return parser
diff --git a/spinetoolbox/metaobject.py b/spinetoolbox/metaobject.py
index 55264f250..4b98e9718 100644
--- a/spinetoolbox/metaobject.py
+++ b/spinetoolbox/metaobject.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,18 +10,16 @@
# this program. If not, see .
######################################################################################################################
-"""
-MetaObject class.
-"""
-
+"""MetaObject class."""
from PySide6.QtCore import QObject
from spine_engine.utils.helpers import shorten
class MetaObject(QObject):
- def __init__(self, name, description):
- """Class for an object which has a name, type, and some description.
+ """Class for an object which has a name, type, and some description."""
+ def __init__(self, name, description):
+ """
Args:
name (str): Object name
description (str): Object description
diff --git a/spinetoolbox/mvcmodels/__init__.py b/spinetoolbox/mvcmodels/__init__.py
index 8b96d2413..336d85acc 100644
--- a/spinetoolbox/mvcmodels/__init__.py
+++ b/spinetoolbox/mvcmodels/__init__.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
diff --git a/spinetoolbox/mvcmodels/array_model.py b/spinetoolbox/mvcmodels/array_model.py
index 00cfd6d53..f8d173e4d 100644
--- a/spinetoolbox/mvcmodels/array_model.py
+++ b/spinetoolbox/mvcmodels/array_model.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,15 +10,14 @@
# this program. If not, see .
######################################################################################################################
-"""
-Contains model for the Array editor widget.
-"""
+"""Contains model for the Array editor widget."""
import locale
from numbers import Number
import numpy
from PySide6.QtCore import QAbstractTableModel, QModelIndex, Qt
from spinedb_api import Array, from_database, ParameterValueFormatError, SpineDBAPIError
from .indexed_value_table_model import EXPANSE_COLOR
+from ..helpers import plain_to_tool_tip
class ArrayModel(QAbstractTableModel):
@@ -145,7 +145,7 @@ def data(self, index, role=Qt.ItemDataRole.DisplayRole):
if row == len(self._data):
return None
element = self._data[row]
- return str(element)
+ return plain_to_tool_tip(str(element))
if role == Qt.ItemDataRole.BackgroundRole and row == len(self._data):
return EXPANSE_COLOR
return None
diff --git a/spinetoolbox/mvcmodels/compound_table_model.py b/spinetoolbox/mvcmodels/compound_table_model.py
index be9e1b84b..614874215 100644
--- a/spinetoolbox/mvcmodels/compound_table_model.py
+++ b/spinetoolbox/mvcmodels/compound_table_model.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,10 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-Models that vertically concatenate two or more table models.
-"""
-
+"""Models that vertically concatenate two or more table models."""
import bisect
from PySide6.QtCore import Qt, Signal, Slot, QModelIndex, QTimer
from ..mvcmodels.minimal_table_model import MinimalTableModel
@@ -385,9 +383,10 @@ def _get_row_for_insertion(self, pos):
def _insert_row_map(self, pos, single_row_map):
if not single_row_map:
- # To trigger fetching. The QTimer is to avoid funny situations where the user enters new data
- # via the empty row model, and those rows need to be removed at the same time as we fetch the added data.
- # Doing it in the same loop cycle causes bugs.
+ # Emit layoutChanged to trigger fetching.
+ # The QTimer is to avoid funny situations where the user enters new data via the empty row model,
+ # and those rows need to be removed at the same time as we fetch the added data.
+ # Doing it in the same loop cycle was causing bugs.
QTimer.singleShot(0, self.layoutChanged.emit)
return
row = self._get_row_for_insertion(pos)
diff --git a/spinetoolbox/mvcmodels/empty_row_model.py b/spinetoolbox/mvcmodels/empty_row_model.py
index b0edf36d6..7ae1c6e8f 100644
--- a/spinetoolbox/mvcmodels/empty_row_model.py
+++ b/spinetoolbox/mvcmodels/empty_row_model.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,10 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-Contains a table model with an empty last row.
-"""
-
+""" Contains a table model with an empty last row. """
from PySide6.QtCore import Qt, Slot, QModelIndex
from .minimal_table_model import MinimalTableModel
diff --git a/spinetoolbox/mvcmodels/file_list_models.py b/spinetoolbox/mvcmodels/file_list_models.py
index b83ae4d79..75fa33642 100644
--- a/spinetoolbox/mvcmodels/file_list_models.py
+++ b/spinetoolbox/mvcmodels/file_list_models.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Items.
# Spine Items is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,12 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-Common models.
-Contains a generic File list model and an Item for that model.
-Used by the Importer and Tool project items but this may be handy for other project items
-as well.
-"""
+"""Contains a generic File list model and an Item for that model."""
from collections import namedtuple
from itertools import combinations, takewhile
import json
@@ -23,6 +19,7 @@
from PySide6.QtWidgets import QFileIconProvider
from PySide6.QtGui import QStandardItemModel, QStandardItem, QPixmap, QPainter, QIcon, QColor
from spine_engine.project_item.project_item_resource import extract_packs, CmdLineArg, LabelArg
+from spinetoolbox.helpers import plain_to_rich
class FileListModel(QAbstractItemModel):
@@ -100,7 +97,7 @@ def data(self, index, role=Qt.ItemDataRole.DisplayRole):
return (
resource.path
if resource.hasfilepath
- else f"This file will be generated by {resource.provider_name} upon execution."
+ else plain_to_rich(f"This file will be generated by {resource.provider_name} upon execution.")
)
return None
diff --git a/spinetoolbox/mvcmodels/filter_checkbox_list_model.py b/spinetoolbox/mvcmodels/filter_checkbox_list_model.py
index 24345b4dc..6c030d8a8 100644
--- a/spinetoolbox/mvcmodels/filter_checkbox_list_model.py
+++ b/spinetoolbox/mvcmodels/filter_checkbox_list_model.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,26 +10,23 @@
# this program. If not, see .
######################################################################################################################
-"""
-Provides FilterCheckboxListModel for FilterWidget.
-"""
-
+"""Provides FilterCheckboxListModel for FilterWidget."""
import re
-from PySide6.QtCore import Qt, QModelIndex, QAbstractListModel
+from PySide6.QtCore import Qt, QModelIndex, QAbstractListModel, Slot
from spinetoolbox.helpers import bisect_chunks
class SimpleFilterCheckboxListModel(QAbstractListModel):
- _SELECT_ALL_STR = '(Select all)'
- _SELECT_ALL_FILTERED_STR = '(Select all filtered)'
- _EMPTY_STR = '(Empty)'
- _ADD_TO_SELECTION_STR = 'Add current selection to filter'
+ _SELECT_ALL_STR = "(Select all)"
+ _SELECT_ALL_FILTERED_STR = "(Select all filtered)"
+ _EMPTY_STR = "(Empty)"
+ _ADD_TO_SELECTION_STR = "Add current selection to filter"
def __init__(self, parent, show_empty=True):
- """Init class.
-
+ """
Args:
- parent (QWidget)
+ parent (QWidget): parent widget
+ show_empty (bool): if True, adds an empty row to the end of the list
"""
super().__init__(parent)
self._data = []
@@ -180,9 +178,13 @@ def get_not_selected(self):
return self._data_set.difference(self._selected)
def set_filter(self, filter_expression):
- if filter_expression and (isinstance(filter_expression, str) and not filter_expression.isspace()):
+ filter_expression = filter_expression.strip()
+ if filter_expression:
+ try:
+ self._filter_expression = re.compile(filter_expression)
+ except re.error:
+ return
self._action_rows[0] = self._SELECT_ALL_STR
- self._filter_expression = re.compile(filter_expression)
self._filter_index = [i for i, item in enumerate(self._data) if self.search_filter_expression(item)]
self._selected_filtered = set(self._data[i] for i in self._filter_index)
self._add_to_selection = False
@@ -282,11 +284,13 @@ class LazyFilterCheckboxListModel(SimpleFilterCheckboxListModel):
"""Extends SimpleFilterCheckboxListModel to allow for lazy loading in synch with another model."""
def __init__(self, parent, db_mngr, db_maps, fetch_parent, show_empty=True):
- """Init class.
-
+ """
Args:
- parent (SpineDBEditor)
- fetch_parent (FetchParent)
+ parent (SpineDBEditor): parent widget
+ db_mngr (SpineDBManager): database manager
+ db_maps (Sequence of DatabaseMapping): database maps
+ fetch_parent (FetchParent): fetch parent
+ show_empty (bool): if True, show an empty row at the end of the list
"""
super().__init__(parent, show_empty=show_empty)
self._db_mngr = db_mngr
@@ -315,11 +319,11 @@ class DataToValueFilterCheckboxListModel(SimpleFilterCheckboxListModel):
"""Extends SimpleFilterCheckboxListModel to allow for translating internal data to a value for display role."""
def __init__(self, parent, data_to_value, show_empty=True):
- """Init class.
-
+ """
Args:
- parent (SpineDBEditor)
+ parent (SpineDBEditor): parent widget
data_to_value (method): a method to translate item data to a value for display role
+ show_empty (bool): if True, add an empty row to the end of the list
"""
super().__init__(parent, show_empty=show_empty)
self.data_to_value = data_to_value
diff --git a/spinetoolbox/mvcmodels/filter_execution_model.py b/spinetoolbox/mvcmodels/filter_execution_model.py
index 27e22c968..d05ef20b5 100644
--- a/spinetoolbox/mvcmodels/filter_execution_model.py
+++ b/spinetoolbox/mvcmodels/filter_execution_model.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,10 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-Contains FilterExecutionModel.
-"""
-
+"""Contains FilterExecutionModel."""
from PySide6.QtCore import Qt, QModelIndex, QAbstractListModel
diff --git a/spinetoolbox/mvcmodels/indexed_value_table_model.py b/spinetoolbox/mvcmodels/indexed_value_table_model.py
index 95d0d6ac6..d7e7f6931 100644
--- a/spinetoolbox/mvcmodels/indexed_value_table_model.py
+++ b/spinetoolbox/mvcmodels/indexed_value_table_model.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,10 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-A model for indexed parameter values, used by the parameter_value editors.
-"""
-
+"""A model for indexed parameter values, used by the parameter_value editors."""
from PySide6.QtCore import QAbstractTableModel, QModelIndex, Qt
from PySide6.QtGui import QColor
diff --git a/spinetoolbox/mvcmodels/map_model.py b/spinetoolbox/mvcmodels/map_model.py
index 04437bc78..d5dc860c2 100644
--- a/spinetoolbox/mvcmodels/map_model.py
+++ b/spinetoolbox/mvcmodels/map_model.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,9 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-A model for maps, used by the parameter_value editors.
-"""
+"""A model for maps, used by the parameter_value editors."""
from copy import deepcopy
from numbers import Number
from itertools import takewhile
@@ -184,7 +183,7 @@ def flags(self, index):
def headerData(self, section, orientation, role=Qt.ItemDataRole.DisplayRole):
"""Returns row numbers for vertical headers and column titles for horizontal ones."""
if role != Qt.ItemDataRole.DisplayRole:
- return None
+ return super().headerData(section, orientation, role)
if orientation == Qt.Orientation.Vertical:
if section < len(self._rows):
return section + 1
diff --git a/spinetoolbox/mvcmodels/minimal_table_model.py b/spinetoolbox/mvcmodels/minimal_table_model.py
index 943525561..2a99e2b2e 100644
--- a/spinetoolbox/mvcmodels/minimal_table_model.py
+++ b/spinetoolbox/mvcmodels/minimal_table_model.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,17 +10,15 @@
# this program. If not, see .
######################################################################################################################
-"""
-Contains a minimal table model.
-"""
-
+""" Contains a minimal table model. """
from PySide6.QtCore import Qt, QModelIndex, QAbstractTableModel
class MinimalTableModel(QAbstractTableModel):
- def __init__(self, parent=None, header=None, lazy=True):
- """Table model for outlining simple tabular data.
+ """Table model for outlining simple tabular data."""
+ def __init__(self, parent=None, header=None, lazy=True):
+ """
Args:
parent (QObject, optional): the parent object
header (list of str): header labels
@@ -28,6 +27,7 @@ def __init__(self, parent=None, header=None, lazy=True):
super().__init__(parent)
if header is None:
header = []
+ self._parent = parent
self.header = header
self._main_data = list()
self._fetched = not lazy
diff --git a/spinetoolbox/mvcmodels/minimal_tree_model.py b/spinetoolbox/mvcmodels/minimal_tree_model.py
index 690346868..14b4aee41 100644
--- a/spinetoolbox/mvcmodels/minimal_tree_model.py
+++ b/spinetoolbox/mvcmodels/minimal_tree_model.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,19 +10,17 @@
# this program. If not, see .
######################################################################################################################
-"""
-Models to represent items in a tree.
-"""
+"""Models to represent items in a tree."""
from PySide6.QtCore import Qt, QAbstractItemModel, QModelIndex
class TreeItem:
"""A tree item that can fetch its children."""
- def __init__(self, model=None):
+ def __init__(self, model):
"""
Args:
- model (MinimalTreeModel, optional): The model where the item belongs.
+ model (MinimalTreeModel): The model where the item belongs.
"""
super().__init__()
self._children = []
@@ -29,10 +28,15 @@ def __init__(self, model=None):
self._parent_item = None
self._fetched = False
self._set_up_once = False
+ self._has_children_initially = False
+ self._created_children = {}
+
+ def set_has_children_initially(self, has_children_initially):
+ self._has_children_initially = has_children_initially
def has_children(self):
"""Returns whether this item has or could have children."""
- if self.can_fetch_more():
+ if self._has_children_initially:
return True
return bool(self.child_count())
@@ -40,11 +44,6 @@ def has_children(self):
def model(self):
return self._model
- @property
- def child_item_class(self):
- """Returns the type of child items. Reimplement in subclasses to return something more meaningful."""
- return TreeItem
-
@property
def children(self):
return self._children
@@ -67,30 +66,39 @@ def parent_item(self, parent_item):
if not isinstance(parent_item, TreeItem) and parent_item is not None:
raise ValueError("Parent must be instance of TreeItem or None")
self._parent_item = parent_item
- if parent_item is not None:
- self._model = parent_item.model
- self._model.destroyed.connect(lambda obj=None: self.tear_down())
+
+ def is_valid(self):
+ """Tests if item is valid.
+
+ Return:
+ bool: True if item is valid, False otherwise
+ """
+ return True
def child(self, row):
"""Returns the child at given row or None if out of bounds."""
- try:
+ if 0 <= row < len(self._children):
return self.children[row]
- except IndexError:
- return None
+ return None
def last_child(self):
"""Returns the last child."""
- return self.child(-1)
+ return self.child(self.child_count() - 1)
def child_count(self):
"""Returns the number of children."""
return len(self.children)
+ def row_count(self):
+ """Returns the number of rows, which may be different from the number of children.
+ This allows subclasses to hide children."""
+ return self.child_count()
+
def child_number(self):
"""Returns the rank of this item within its parent or -1 if it's an orphan."""
if self.parent_item:
return self.parent_item.children.index(self)
- return -1
+ return None
def find_children(self, cond=lambda child: True):
"""Returns children that meet condition expressed as a lambda function."""
@@ -108,7 +116,7 @@ def next_sibling(self):
def previous_sibling(self):
"""Returns the previous sibling or None if it's the first."""
- if self.child_number() <= 0:
+ if self.child_number() is None:
return None
return self.parent_item.child(self.child_number() - 1)
@@ -123,6 +131,9 @@ def set_up(self):
def _do_set_up(self):
"""Do stuff after the item has been inserted."""
+ def _polish_children(self, children):
+ """Polishes children just before inserting them."""
+
def insert_children(self, position, children):
"""Insert new children at given position. Returns a boolean depending on how it went.
@@ -135,9 +146,10 @@ def insert_children(self, position, children):
"""
bad_types = [type(child) for child in children if not isinstance(child, TreeItem)]
if bad_types:
- raise TypeError(f"Can't insert children of type {bad_types} to an item of type {type(self)}")
+ raise TypeError(f"Can't insert children of type {bad_types} to an item of type {type(self).__name__}")
if position < 0 or position > self.child_count():
return False
+ self._polish_children(children)
parent_index = self.index()
self.model.beginInsertRows(parent_index, position, position + len(children) - 1)
for child in children:
@@ -156,7 +168,9 @@ def tear_down(self):
"""Do stuff after the item has been removed."""
def tear_down_recursively(self):
- for child in self.children:
+ for child in self._created_children.values():
+ child.tear_down_recursively()
+ for child in self._children:
child.tear_down_recursively()
self.tear_down()
@@ -176,20 +190,12 @@ def remove_children(self, position, count):
return False
if last >= self.child_count():
last = self.child_count() - 1
- children = self.children[first : last + 1]
self.model.beginRemoveRows(self.index(), first, last)
- for child in children:
- child.parent_item = None
del self.children[first : last + 1]
self.model.endRemoveRows()
- for child in children:
- child.tear_down_recursively()
+ self._has_children_initially = False
return True
- def clear_children(self):
- """Clear children list."""
- self.children.clear()
-
# pylint: disable=no-self-use
def flags(self, column):
"""Enables the item and makes it selectable."""
@@ -287,7 +293,14 @@ def visit_all(self, index=QModelIndex(), view=None):
current = parent_item
def item_from_index(self, index):
- """Return the item corresponding to the given index."""
+ """Return the item corresponding to the given index.
+
+ Args:
+ index (QModelIndex): model index
+
+ Returns:
+ TreeItem: item at index
+ """
if index.isValid():
return index.internalPointer()
return self._invisible_root_item
@@ -302,7 +315,7 @@ def index_from_item(self, item):
QModelIndex: item's index
"""
row = item.child_number()
- if row < 0:
+ if row is None:
return QModelIndex()
return self.createIndex(row, 0, item)
@@ -331,13 +344,15 @@ def rowCount(self, parent=QModelIndex()):
if parent.column() > 0:
return 0
parent_item = self.item_from_index(parent)
- return parent_item.child_count()
+ return parent_item.row_count()
def data(self, index, role=Qt.ItemDataRole.DisplayRole):
"""Returns the data stored under the given role for the index."""
if not index.isValid():
return None
item = self.item_from_index(index)
+ if not item.is_valid():
+ return None
return item.data(index.column(), role)
def setData(self, index, value, role=Qt.ItemDataRole.EditRole):
diff --git a/spinetoolbox/mvcmodels/project_item_model.py b/spinetoolbox/mvcmodels/project_item_model.py
deleted file mode 100644
index af2e50660..000000000
--- a/spinetoolbox/mvcmodels/project_item_model.py
+++ /dev/null
@@ -1,358 +0,0 @@
-######################################################################################################################
-# Copyright (C) 2017-2022 Spine project consortium
-# This file is part of Spine Toolbox.
-# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
-# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
-# any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
-# without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
-# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
-# this program. If not, see .
-######################################################################################################################
-
-"""
-Contains a class for storing project items.
-"""
-import logging
-from copy import copy
-from PySide6.QtCore import Qt, QModelIndex, QAbstractItemModel, Slot
-from PySide6.QtGui import QIcon, QFont
-
-from .project_tree_item import LeafProjectTreeItem
-
-
-class ProjectItemModel(QAbstractItemModel):
- def __init__(self, root, parent=None):
- """Class to store project tree items and ultimately project items in a tree structure.
-
- Args:
- root (RootProjectTreeItem): Root item for the project item tree
- parent (QObject): parent object
- """
- super().__init__(parent)
- self._root = root
- self._project = None
-
- def root(self):
- """Returns the root item."""
- return self._root
-
- def connect_to_project(self, project):
- """Connects the model to a project.
-
- Args:
- project (SpineToolboxProject): project to connect to
- """
- self.remove_leaves()
- self._project = project
- project.project_about_to_be_torn_down.connect(self.remove_leaves)
- project.item_added.connect(self._add_leaf_item)
- project.item_about_to_be_removed.connect(self._remove_leaf_item)
- project.item_renamed.connect(self._rename_item)
-
- @Slot(str)
- def _add_leaf_item(self, name):
- """Adds a leaf item to the model
-
- Args:
- name (str): project item's name
- """
- project_item = self._project.get_item(name)
- leaf_item = LeafProjectTreeItem(project_item)
- category_index = self.find_category(project_item.item_category())
- self.insert_item(leaf_item, category_index)
-
- @Slot(str)
- def _remove_leaf_item(self, name):
- """Removes a leaf item from the model.
-
- Args:
- name (str): project item's name
- """
- leaf_item = self.find_item(name).internalPointer()
- project_item = leaf_item.project_item
- category_index = self.find_category(project_item.item_category())
- self.remove_item(leaf_item, category_index)
-
- @Slot(str, str)
- def _rename_item(self, old_name, new_name):
- """Renames a leaf item.
-
- Args:
- old_name (str): item's old name
- new_name (str): item's new name
- """
- self._remove_leaf_item(old_name)
- self._add_leaf_item(new_name)
-
- def rowCount(self, parent=QModelIndex()):
- """Reimplemented rowCount method.
-
- Args:
- parent (QModelIndex): Index of parent item whose children are counted.
-
- Returns:
- int: Number of children of given parent
- """
- if not parent.isValid(): # Number of category items (children of root)
- return self.root().child_count()
- return parent.internalPointer().child_count()
-
- def columnCount(self, parent=QModelIndex()):
- """Returns model column count which is always 1."""
- return 1
-
- def flags(self, index):
- """Returns flags for the item at given index
-
- Args:
- index (QModelIndex): Flags of item at this index.
- """
- return index.internalPointer().flags()
-
- def parent(self, index=QModelIndex()):
- """Returns index of the parent of given index.
-
- Args:
- index (QModelIndex): Index of item whose parent is returned
-
- Returns:
- QModelIndex: Index of parent item
- """
- item = self.item(index)
- parent_item = item.parent()
- if not parent_item:
- return QModelIndex()
- if parent_item == self.root():
- return QModelIndex()
- # logging.debug("parent_item: {0}".format(parent_item.name))
- return self.createIndex(parent_item.row(), 0, parent_item)
-
- def index(self, row, column, parent=QModelIndex()):
- """Returns index of item with given row, column, and parent.
-
- Args:
- row (int): Item row
- column (int): Item column
- parent (QModelIndex): Parent item index
-
- Returns:
- QModelIndex: Item index
- """
- if row < 0 or row >= self.rowCount(parent):
- return QModelIndex()
- if column < 0 or column >= self.columnCount(parent):
- return QModelIndex()
- parent_item = self.item(parent)
- child = parent_item.child(row)
- if not child:
- return QModelIndex()
- return self.createIndex(row, column, child)
-
- def data(self, index, role=None):
- """Returns data in the given index according to requested role.
-
- Args:
- index (QModelIndex): Index to query
- role (int): Role to return
-
- Returns:
- object: Data depending on role.
- """
- if not index.isValid():
- return None
- item = index.internalPointer()
- if role == Qt.ItemDataRole.DisplayRole:
- return item.name
- if role == Qt.ItemDataRole.DecorationRole:
- if not hasattr(item, "project_item"):
- # item is a CategoryProjectTreeItem or root
- return None
- # item is a LeafProjectTreeItem
- icon_path = item.project_item.get_icon().icon_file
- return QIcon(icon_path)
- if role == Qt.ItemDataRole.FontRole:
- if not hasattr(item, "project_item"):
- bold_font = QFont()
- bold_font.setBold(True)
- return bold_font
- return None
-
- def item(self, index):
- """Returns item at given index.
-
- Args:
- index (QModelIndex): Index of item
-
- Returns:
- RootProjectTreeItem, CategoryProjectTreeItem or LeafProjectTreeItem: Item at given index or root project
- item if index is not valid
- """
- if not index.isValid():
- return self.root()
- return index.internalPointer()
-
- def find_category(self, category_name):
- """Returns the index of the given category name.
-
- Args:
- category_name (str): Name of category item to find
-
- Returns:
- QModelIndex: index of a category item or None if it was not found
- """
- category_names = [category.name for category in self.root().children()]
- try:
- row = category_names.index(category_name)
- except ValueError:
- logging.error("Category name %s not found in %s", category_name, category_names)
- return None
- return self.index(row, 0, QModelIndex())
-
- def find_item(self, name):
- """Returns the QModelIndex of the leaf item with the given name
-
- Args:
- name (str): The searched project item (long) name
-
- Returns:
- QModelIndex: Index of a project item with the given name or None if not found
- """
- for category in self.root().children():
- category_index = self.find_category(category.name)
- start_index = self.index(0, 0, category_index)
- matching_index = self.match(
- start_index, Qt.ItemDataRole.DisplayRole, name, 1, Qt.MatchFixedString | Qt.MatchRecursive
- )
- if not matching_index:
- pass # no match in this category
- elif len(matching_index) == 1:
- return matching_index[0]
- return None
-
- def get_item(self, name):
- """Returns leaf item with given name or None if it doesn't exist.
-
- Args:
- name (str): Project item name
-
- Returns:
- LeafProjectTreeItem, NoneType
- """
- ind = self.find_item(name)
- if ind is None:
- return None
- return self.item(ind)
-
- def category_of_item(self, name):
- """Returns the category item of the category that contains project item with given name
-
- Args:
- name (str): Project item name
-
- Returns:
- CategoryProjectTreeItem: category item or None if the category was not found
- """
- for category in self.root().children():
- for item in category.children():
- if name == item.name:
- return category
- return None
-
- def insert_item(self, item, parent=QModelIndex()):
- """Adds a new item to model. Fails if given parent is not
- a category item nor a leaf item. New item is inserted as
- the last item of its branch.
-
- Args:
- item (CategoryProjectTreeItem or LeafProjectTreeItem): Project item to add to model
- parent (QModelIndex): Parent project item
-
- Returns:
- bool: True if successful, False otherwise
- """
- parent_item = self.item(parent)
- row = self.rowCount(parent) # parent.child_count()
- self.beginInsertRows(parent, row, row)
- retval = parent_item.add_child(item)
- self.endInsertRows()
- return retval
-
- def remove_item(self, item, parent=QModelIndex()):
- """Removes item from project.
-
- Args:
- item (BaseProjectTreeItem): Item to remove
- parent (QModelIndex): Parent of item that is to be removed
-
- Returns:
- bool: True if item removed successfully, False if item removing failed
- """
- parent_item = self.item(parent)
- row = item.row()
- self.beginRemoveRows(parent, row, row)
- parent_item.remove_child(row)
- self.endRemoveRows()
-
- def items(self, category_name=None):
- """Returns a list of leaf items in model according to category name. If no category name given,
- returns all leaf items in a list.
-
- Args:
- category_name (str): Item category. Data Connections, Data Stores, Importers, Exporters, Tools or Views
- permitted.
-
- Returns:
- :obj:'list' of :obj:'LeafProjectTreeItem': Depending on category_name argument, returns all items or only
- items according to category. An empty list is returned if there are no items in the given category
- or if an unknown category name was given.
- """
- if not category_name:
- items = list()
- for category in self.root().children():
- items += category.children()
- return items
- category_index = self.find_category(category_name)
- if not category_index:
- logging.error("Category item '%s' not found", category_name)
- return list()
- return category_index.internalPointer().children()
-
- def n_items(self):
- """Returns the number of all items in the model excluding category items and root.
-
- Returns:
- int: Number of items
- """
- return len(self.items())
-
- def item_names(self):
- """Returns all leaf item names in a list.
-
- Returns:
- obj:'list' of obj:'str': Item names
- """
- return [item.name for item in self.items()]
-
- def items_per_category(self):
- """Returns a dict mapping category indexes to a list of items in that category.
-
- Returns:
- dict(QModelIndex,list(LeafProjectTreeItem))
- """
- category_inds = [self.index(row, 0) for row in range(self.rowCount())]
- return {ind: copy(ind.internalPointer().children()) for ind in category_inds}
-
- def leaf_indexes(self):
- """Yields leaf indexes."""
- for row in range(self.rowCount()):
- category_index = self.index(row, 0)
- for inner_row in range(self.rowCount(category_index)):
- yield self.index(inner_row, 0, category_index)
-
- @Slot()
- def remove_leaves(self):
- self.beginResetModel()
- for row in range(self.rowCount()):
- category_index = self.index(row, 0)
- category_index.internalPointer().children().clear()
- self.endResetModel()
diff --git a/spinetoolbox/mvcmodels/project_item_specification_models.py b/spinetoolbox/mvcmodels/project_item_specification_models.py
index 7b3914a36..6813739a6 100644
--- a/spinetoolbox/mvcmodels/project_item_specification_models.py
+++ b/spinetoolbox/mvcmodels/project_item_specification_models.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,10 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-Contains a class for storing Tool specifications.
-"""
-
+"""Contains a class for storing Tool specifications."""
import bisect
from PySide6.QtCore import Qt, QModelIndex, QAbstractListModel, QSortFilterProxyModel, Slot, Signal
@@ -107,13 +105,6 @@ def data(self, index, role=None):
row = index.row()
if role == Qt.ItemDataRole.DisplayRole:
return self._spec_names[row]
- if role == Qt.ItemDataRole.ToolTipRole:
- if row >= self.rowCount():
- return ""
- return (
- "
Drag-and-drop this onto the Design View "
- f"to create a new {self._spec_names[row]} item.
"
- )
if role == Qt.ItemDataRole.DecorationRole:
spec = self.specification(row)
return self._icons[spec.item_type]
diff --git a/spinetoolbox/mvcmodels/project_tree_item.py b/spinetoolbox/mvcmodels/project_tree_item.py
deleted file mode 100644
index 939869715..000000000
--- a/spinetoolbox/mvcmodels/project_tree_item.py
+++ /dev/null
@@ -1,203 +0,0 @@
-######################################################################################################################
-# Copyright (C) 2017-2022 Spine project consortium
-# This file is part of Spine Toolbox.
-# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
-# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
-# any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
-# without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
-# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
-# this program. If not, see .
-######################################################################################################################
-
-"""
-Project Tree items.
-"""
-
-import logging
-import bisect
-from PySide6.QtCore import Qt
-from spinetoolbox.metaobject import MetaObject
-
-
-class BaseProjectTreeItem(MetaObject):
- """Base class for all project tree items."""
-
- def __init__(self, name, description):
- """
- Args:
- name (str): Object name
- description (str): Object description
- """
- super().__init__(name, description)
- self._parent = None # Parent BaseProjectTreeItem. Set when add_child is called
- self._children = list() # Child BaseProjectTreeItems. Appended when new items are inserted into model.
-
- def flags(self): # pylint: disable=no-self-use
- """Returns the item flags."""
- return Qt.NoItemFlags
-
- def parent(self):
- """Returns parent project tree item."""
- return self._parent
-
- def child_count(self):
- """Returns the number of child project tree items."""
- return len(self._children)
-
- def children(self):
- """Returns the children of this project tree item."""
- return self._children
-
- def child(self, row):
- """Returns child BaseProjectTreeItem on given row.
-
- Args:
- row (int): Row of child to return
-
- Returns:
- BaseProjectTreeItem: item on given row or None if it does not exist
- """
- try:
- item = self._children[row]
- except IndexError:
- logging.error("[%s] has no child on row %s", self.name, row)
- return None
- return item
-
- def row(self):
- """Returns the row on which this item is located."""
- if self._parent is not None:
- r = self._parent.children().index(self)
- # logging.debug("{0} is on row:{1}".format(self.name, r))
- return r
- return 0
-
- def add_child(self, child_item):
- """Base method that shall be overridden in subclasses."""
- raise NotImplementedError()
-
- def remove_child(self, row):
- """Remove the child of this BaseProjectTreeItem from given row. Do not call this method directly.
- This method is called by ProjectItemTreeModel when items are removed.
-
- Args:
- row (int): Row of child to remove
-
- Returns:
- bool: True if operation succeeded, False otherwise
- """
- if row < 0 or row > len(self._children):
- return False
- child = self._children.pop(row)
- child._parent = None
- return True
-
- def custom_context_menu(self, toolbox):
- """Returns the context menu for this item. Implement in subclasses as needed.
-
- Args:
- toolbox (QWidget): The widget that is controlling the menu
-
- Returns:
- QMenu: context menu
- """
- raise NotImplementedError()
-
-
-class RootProjectTreeItem(BaseProjectTreeItem):
- """Class for the root project tree item."""
-
- def __init__(self):
- super().__init__("root", "The Root Project Tree Item.")
-
- def add_child(self, child_item):
- """Adds given category item as the child of this root project tree item. New item is added as the last item.
-
- Args:
- child_item (CategoryProjectTreeItem): Item to add
-
- Returns:
- True for success, False otherwise
- """
- if isinstance(child_item, CategoryProjectTreeItem):
- self._children.append(child_item)
- child_item._parent = self
- return True
- logging.error("You can only add a category item as a child of the root item")
- return False
-
- def custom_context_menu(self, toolbox):
- """See base class."""
- raise NotImplementedError()
-
-
-class CategoryProjectTreeItem(BaseProjectTreeItem):
- """Class for category project tree items."""
-
- def flags(self):
- """Returns the item flags."""
- return Qt.ItemIsEnabled
-
- def add_child(self, child_item):
- """Adds given project tree item as the child of this category item. New item is added as the last item.
-
- Args:
- child_item (LeafProjectTreeTreeItem): Item to add
- Returns:
- True for success, False otherwise
- """
- if not isinstance(child_item, LeafProjectTreeItem):
- logging.error("You can only add a leaf item as a child of a category item")
- return False
- key = lambda x: x.name.lower()
- pos = bisect.bisect_left([key(x) for x in self._children], key(child_item))
- self._children.insert(pos, child_item)
- child_item._parent = self
- return True
-
- def custom_context_menu(self, toolbox):
- """Returns the context menu for this item.
-
- Args:
- toolbox (ToolboxUI): Toolbox main window
-
- Returns:
- QMenu: context menu
- """
- return toolbox.item_category_context_menu()
-
-
-class LeafProjectTreeItem(BaseProjectTreeItem):
- """Class for leaf items in the project item tree."""
-
- def __init__(self, project_item):
- """
- Args:
- project_item (ProjectItem): the real project item this item represents
- """
- super().__init__(project_item.name, project_item.description)
- self._project_item = project_item
-
- @property
- def project_item(self):
- """the project item linked to this leaf"""
- return self._project_item
-
- def add_child(self, child_item):
- """See base class."""
- raise NotImplementedError()
-
- def flags(self):
- """Returns the item flags."""
- return Qt.ItemIsEnabled | Qt.ItemIsSelectable | Qt.ItemIsEditable
-
- def custom_context_menu(self, toolbox):
- """Returns the context menu for this item.
-
- Args:
- toolbox (ToolboxUI): Toolbox main window
-
- Returns:
- QMenu: context menu
- """
- return toolbox.project_item_context_menu(self._project_item.actions())
diff --git a/spinetoolbox/mvcmodels/resource_filter_model.py b/spinetoolbox/mvcmodels/resource_filter_model.py
index cb6de2997..d3fecb438 100644
--- a/spinetoolbox/mvcmodels/resource_filter_model.py
+++ b/spinetoolbox/mvcmodels/resource_filter_model.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,21 +10,19 @@
# this program. If not, see .
######################################################################################################################
-"""
-Contains ResourceFilterModel.
-"""
+""" Contains ResourceFilterModel. """
from PySide6.QtCore import Qt, Signal
from PySide6.QtGui import QStandardItemModel, QStandardItem
+from spinedb_api.filters.alternative_filter import ALTERNATIVE_FILTER_TYPE
from spinedb_api.filters.scenario_filter import SCENARIO_FILTER_TYPE
-from spinedb_api.filters.tool_filter import TOOL_FILTER_TYPE
from ..project_commands import SetFiltersOnlineCommand
class ResourceFilterModel(QStandardItemModel):
tree_built = Signal()
_SELECT_ALL = "Select all"
- _FILTER_TYPES = {"Scenario filter": SCENARIO_FILTER_TYPE, "Tool filter": TOOL_FILTER_TYPE}
- _FILTER_TYPE_TO_TEXT = dict(zip(_FILTER_TYPES.values(), _FILTER_TYPES.keys()))
+ FILTER_TYPES = {"Scenario filter": SCENARIO_FILTER_TYPE, "Alternative filter": ALTERNATIVE_FILTER_TYPE}
+ FILTER_TYPE_TO_TEXT = dict(zip(FILTER_TYPES.values(), FILTER_TYPES.keys()))
def __init__(self, connection, project, undo_stack, logger):
"""
@@ -46,13 +45,14 @@ def connection(self):
def build_tree(self):
"""Rebuilds model's contents."""
- def append_filter_items(parent_item, filter_names, filter_type, online, online_default):
+ def append_filter_items(parent_item, filter_names, filter_type, online, online_default, enabled):
for name in filter_names[filter_type]:
filter_item = QStandardItem(name)
filter_item.setCheckState(
Qt.CheckState.Checked if online.get(name, online_default) else Qt.CheckState.Unchecked
)
- filter_item.setFlags(Qt.ItemIsEnabled | Qt.ItemIsSelectable | Qt.ItemIsUserCheckable)
+ filter_item.setFlags(Qt.ItemIsSelectable | Qt.ItemIsUserCheckable)
+ filter_item.setEnabled(enabled)
parent_item.appendRow(filter_item)
self.clear()
@@ -62,7 +62,7 @@ def append_filter_items(parent_item, filter_names, filter_type, online, online_d
root_item = QStandardItem(resource_label)
root_item.setFlags(Qt.ItemIsEnabled | Qt.ItemIsSelectable)
self.appendRow(root_item)
- for type_label, type_ in self._FILTER_TYPES.items():
+ for type_label, type_ in self.FILTER_TYPES.items():
filter_parent = QStandardItem(type_label)
if not filters_by_type.get(type_):
no_filters_item = QStandardItem("None available")
@@ -70,15 +70,23 @@ def append_filter_items(parent_item, filter_names, filter_type, online, online_d
filter_parent.appendRow(no_filters_item)
root_item.appendRow(filter_parent)
continue
- filter_parent.setFlags(Qt.ItemIsEnabled | Qt.ItemIsSelectable)
+ filter_enabled = self._connection.is_filter_type_enabled(type_)
+ filter_parent.setFlags(Qt.ItemIsSelectable)
+ filter_parent.setEnabled(filter_enabled)
select_all_item = QStandardItem(self._SELECT_ALL)
- select_all_item.setFlags(Qt.ItemIsEnabled | Qt.ItemIsSelectable | Qt.ItemIsUserCheckable)
+ select_all_item.setFlags(Qt.ItemIsSelectable | Qt.ItemIsUserCheckable)
select_all_item.setCheckState(Qt.CheckState.Unchecked)
+ select_all_item.setEnabled(filter_enabled)
filter_parent.appendRow(select_all_item)
root_item.appendRow(filter_parent)
online_filters = self._connection.online_filters(resource_label, type_)
append_filter_items(
- filter_parent, filters_by_type, type_, online_filters, self._connection.is_filter_online_by_default
+ filter_parent,
+ filters_by_type,
+ type_,
+ online_filters,
+ self._connection.is_filter_online_by_default,
+ filter_enabled,
)
self._set_all_selected_item(resource_label, filter_parent)
self.tree_built.emit()
@@ -89,12 +97,10 @@ def fetch_filters(self):
url = resource.url
if not url:
continue
- scenario_names = self._connection.get_scenario_names(url)
- if scenario_names:
- filters.setdefault(resource.label, {})[SCENARIO_FILTER_TYPE] = scenario_names
- tool_names = self._connection.get_tool_names(url)
- if tool_names:
- filters.setdefault(resource.label, {})[TOOL_FILTER_TYPE] = tool_names
+ for filter_type in (SCENARIO_FILTER_TYPE, ALTERNATIVE_FILTER_TYPE):
+ names = self._connection.get_filter_item_names(filter_type, url)
+ if names:
+ filters.setdefault(resource.label, {})[filter_type] = names
return filters
def setData(self, index, value, role=Qt.ItemDataRole.EditRole):
@@ -114,7 +120,7 @@ def _change_filter_checked_state(self, index, is_on):
if item.hasChildren():
return
resource_type_item = item.parent()
- filter_type = self._FILTER_TYPES[resource_type_item.text()]
+ filter_type = self.FILTER_TYPES[resource_type_item.text()]
root_item = resource_type_item.parent()
resource_label = root_item.text()
if item.text() == self._SELECT_ALL:
@@ -131,7 +137,7 @@ def set_online(self, resource, filter_type, online):
Args:
resource (str): Resource label
- filter_type (str): Either SCENARIO_FILTER_TYPE or TOOL_FILTER_TYPE, for now.
+ filter_type (str): Always SCENARIO_FILTER_TYPE, for now.
online (dict): mapping from scenario/tool id to online flag
"""
self.connection.set_online(resource, filter_type, online)
@@ -159,13 +165,31 @@ def _find_filter_type_item(self, resource, filter_type):
"""
root_item = self.findItems(resource)[0]
filter_type_item = None
- filter_type_text = self._FILTER_TYPE_TO_TEXT[filter_type]
+ filter_type_text = self.FILTER_TYPE_TO_TEXT[filter_type]
for row in range(root_item.rowCount()):
filter_type_item = root_item.child(row)
if filter_type_item.text() == filter_type_text:
break
return filter_type_item
+ def filter_type_items(self, filter_type):
+ """An iterator to filter type items.
+
+ Args:
+ filter_type (str): filter type
+
+ Yields:
+ QStandardItem: filter type item
+ """
+ filter_text = self.FILTER_TYPE_TO_TEXT[filter_type]
+ root_item = self.invisibleRootItem()
+ for root_row in range(root_item.rowCount()):
+ resource_item = root_item.child(root_row)
+ for resource_row in range(resource_item.rowCount()):
+ filter_type_item = resource_item.child(resource_row)
+ if filter_type_item.text() == filter_text:
+ yield filter_type_item
+
def _set_all_selected_item(self, resource, filter_type_item, emit_data_changed=False):
"""Updates 'Select All' item's checked state.
@@ -174,7 +198,7 @@ def _set_all_selected_item(self, resource, filter_type_item, emit_data_changed=F
filter_type_item (QStandardItem): filter type item
emit_data_changed (bool): if True, emit dataChanged signal if the state was updated
"""
- online_filters = self._connection.online_filters(resource, self._FILTER_TYPES[filter_type_item.text()])
+ online_filters = self._connection.online_filters(resource, self.FILTER_TYPES[filter_type_item.text()])
all_online = all(online_filters.values())
all_selected_item = filter_type_item.child(0)
all_selected = all_selected_item.data(Qt.ItemDataRole.CheckStateRole) == Qt.CheckState.Checked.value
@@ -185,3 +209,23 @@ def _set_all_selected_item(self, resource, filter_type_item, emit_data_changed=F
self.dataChanged.emit(
all_selected_item.index(), all_selected_item.index(), [Qt.ItemDataRole.CheckStateRole]
)
+
+ def set_filter_type_enabled(self, filter_type, enabled):
+ """Enables or disables a filter type.
+
+ Args:
+ filter_type (str): filter type
+ enabled (bool): whether the filter is enabled
+ """
+ filter_text = self.FILTER_TYPE_TO_TEXT[filter_type]
+ root_item = self.invisibleRootItem()
+ for root_row in range(root_item.rowCount()):
+ resource_item = root_item.child(root_row)
+ for resource_row in range(resource_item.rowCount()):
+ filter_type_item = resource_item.child(resource_row)
+ if filter_type_item.text() != filter_text:
+ continue
+ filter_type_item.setEnabled(enabled)
+ for filter_type_row in range(filter_type_item.rowCount()):
+ filter_item = filter_type_item.child(filter_type_row)
+ filter_item.setEnabled(enabled)
diff --git a/spinetoolbox/mvcmodels/shared.py b/spinetoolbox/mvcmodels/shared.py
index 868353e84..487754ab3 100644
--- a/spinetoolbox/mvcmodels/shared.py
+++ b/spinetoolbox/mvcmodels/shared.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,10 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-Contains stuff that is used by more than one model
-"""
-
+"""Contains stuff that is used by more than one model."""
from PySide6.QtCore import Qt
PARSED_ROLE = Qt.ItemDataRole.UserRole
diff --git a/spinetoolbox/mvcmodels/time_pattern_model.py b/spinetoolbox/mvcmodels/time_pattern_model.py
index e69a92580..652afaffd 100644
--- a/spinetoolbox/mvcmodels/time_pattern_model.py
+++ b/spinetoolbox/mvcmodels/time_pattern_model.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,10 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-A model for time patterns, used by the parameter_value editors.
-"""
-
+"""A model for time patterns, used by the parameter_value editors."""
import numpy as np
from PySide6.QtCore import QModelIndex, Qt
from PySide6.QtWidgets import QMessageBox
diff --git a/spinetoolbox/mvcmodels/time_series_model_fixed_resolution.py b/spinetoolbox/mvcmodels/time_series_model_fixed_resolution.py
index efdc727f7..339c3c77b 100644
--- a/spinetoolbox/mvcmodels/time_series_model_fixed_resolution.py
+++ b/spinetoolbox/mvcmodels/time_series_model_fixed_resolution.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,10 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-A model for fixed resolution time series, used by the parameter_value editors.
-"""
-
+"""A model for fixed resolution time series, used by the parameter_value editors."""
import numpy as np
from PySide6.QtCore import QModelIndex, Qt, Slot, QLocale
from spinedb_api import TimeSeriesFixedResolution
diff --git a/spinetoolbox/mvcmodels/time_series_model_variable_resolution.py b/spinetoolbox/mvcmodels/time_series_model_variable_resolution.py
index 2c977fcb6..683aeb799 100644
--- a/spinetoolbox/mvcmodels/time_series_model_variable_resolution.py
+++ b/spinetoolbox/mvcmodels/time_series_model_variable_resolution.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,12 +10,8 @@
# this program. If not, see .
######################################################################################################################
-"""
-A model for variable resolution time series, used by the parameter_value editors.
-"""
-
+"""A model for variable resolution time series, used by the parameter_value editors."""
import numpy as np
-
from PySide6.QtCore import QModelIndex, Qt, Slot
from spinedb_api import TimeSeriesVariableResolution
from .indexed_value_table_model import IndexedValueTableModel
@@ -63,7 +60,7 @@ def insertRows(self, row, count, parent=QModelIndex()):
if len(old_indexes) > 1:
last_time_step = last_time_stamp - old_indexes[-2]
else:
- last_time_step = np.timedelta64(1, 'h')
+ last_time_step = np.timedelta64(1, "h")
new_indexes[: len(old_indexes)] = old_indexes
for i in range(count):
@@ -78,7 +75,7 @@ def insertRows(self, row, count, parent=QModelIndex()):
if len(old_indexes) > 1:
time_step = old_indexes[1] - first_time_stamp
else:
- time_step = np.timedelta64(1, 'h')
+ time_step = np.timedelta64(1, "h")
for i in range(count):
new_indexes[i] = first_time_stamp - (count - i) * time_step
new_indexes[count:] = old_indexes
diff --git a/spinetoolbox/plotting.py b/spinetoolbox/plotting.py
index 0c54f0a47..83562b8dc 100644
--- a/spinetoolbox/plotting.py
+++ b/spinetoolbox/plotting.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,9 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-Functions for plotting on PlotWidget.
-"""
+"""Functions for plotting on PlotWidget."""
import datetime
from enum import auto, Enum, unique
import math
@@ -20,14 +19,12 @@
import functools
from operator import methodcaller, itemgetter
from typing import Dict, List, Optional, Union
-
from matplotlib.patches import Patch
from matplotlib.ticker import MaxNLocator
import numpy as np
-from PySide6.QtCore import Qt, QModelIndex
-
+from PySide6.QtCore import Qt
from spinedb_api.parameter_value import NUMPY_DATETIME64_UNIT, from_database
-from spinedb_api import Array, IndexedValue, TimeSeries, DateTime
+from spinedb_api import IndexedValue, DateTime
from .mvcmodels.shared import PARSED_ROLE
from .widgets.plot_canvas import LegendPosition
from .widgets.plot_widget import PlotWidget
@@ -299,7 +296,7 @@ def plot_data(data_list, plot_widget=None, plot_type=None):
plot_widget.canvas.axes.set_title(plot_title)
for data in data_list:
if type(data.x[0]) not in (float, np.float_, int):
- plot_widget.canvas.axes.tick_params(axis='x', labelrotation=30)
+ plot_widget.canvas.axes.tick_params(axis="x", labelrotation=30)
if len(squeezed_data) > 1:
plot_widget.add_legend(legend_handles)
if needs_redraw:
@@ -701,7 +698,7 @@ def plot_db_mngr_items(items, db_maps, plot_widget=None):
Args:
items (list of dict): parameter value items
- db_maps (list of DatabaseMappingBase): database mappings corresponding to items
+ db_maps (list of DatabaseMapping): database mappings corresponding to items
plot_widget (PlotWidget, optional): widget to add plots to
"""
if not items:
@@ -718,14 +715,12 @@ def plot_db_mngr_items(items, db_maps, plot_widget=None):
except PlottingError as error:
raise PlottingError(f"Failed to plot value in {db_map.codename}: {error}")
db_name = db_map.codename
- parameter_name = item["parameter_name"]
- object_name_list = item["object_name_list"]
- if object_name_list is not None:
- object_names = tuple(object_name_list.split(","))
- else:
- object_names = (item["object_name"],)
+ parameter_name = item["parameter_definition_name"]
+ entity_byname = item["entity_byname"]
+ if not isinstance(entity_byname, tuple):
+ entity_byname = (entity_byname,)
alternative_name = item["alternative_name"]
- indexes = (db_name, parameter_name) + object_names + (alternative_name,)
+ indexes = (db_name, parameter_name) + entity_byname + (alternative_name,)
index_names = _pivot_index_names(indexes)
node = root_node
for i, index in enumerate(indexes[:-1]):
diff --git a/spinetoolbox/plugin_manager.py b/spinetoolbox/plugin_manager.py
index cb3da5048..c964e1093 100644
--- a/spinetoolbox/plugin_manager.py
+++ b/spinetoolbox/plugin_manager.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,9 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-Contains PluginManager class.
-"""
+"""Contains PluginManager class."""
import itertools
import os
import json
@@ -44,7 +43,7 @@ def _download_file(remote, local):
def _download_plugin(plugin, plugin_local_dir):
# 1. Create paths
plugin_remote_file = plugin["url"]
- plugin_remote_dir = urljoin(plugin_remote_file, '.')
+ plugin_remote_dir = urljoin(plugin_remote_file, ".")
plugin_local_file = os.path.join(plugin_local_dir, "plugin.json")
# 2. Download and parse plugin.json file
_download_file(plugin_remote_file, plugin_local_file)
@@ -105,7 +104,6 @@ def load_installed_plugins(self):
local_data = load_specification_local_data(project.config_dir) if project else {}
for plugin_dir in plugins_dirs(self._toolbox.qsettings()):
self.load_individual_plugin(plugin_dir, local_data)
- self._toolbox.refresh_toolbars()
def reload_plugins_with_local_data(self):
"""Reloads plugins that have project specific local data."""
@@ -153,7 +151,6 @@ def load_individual_plugin(self, plugin_dir, specification_local_data):
self._plugin_specs.update(plugin_specs)
toolbar = self._plugin_toolbars[name] = PluginToolBar(name, parent=self._toolbox)
toolbar.setup(plugin_specs, disabled_plugins)
- self._toolbox.addToolBar(Qt.TopToolBarArea, toolbar)
def _create_worker(self):
worker = _PluginWorker()
diff --git a/spinetoolbox/project.py b/spinetoolbox/project.py
index 399ccdc33..b3187f113 100644
--- a/spinetoolbox/project.py
+++ b/spinetoolbox/project.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,17 +10,15 @@
# this program. If not, see .
######################################################################################################################
-"""
-Spine Toolbox project class.
-"""
+"""Spine Toolbox project class."""
from enum import auto, Enum, unique
from itertools import chain
import os
from pathlib import Path
import json
-import random
from PySide6.QtCore import Signal, QCoreApplication
from PySide6.QtGui import QColor
+from PySide6.QtWidgets import QMessageBox
import networkx as nx
from spine_engine.exception import EngineInitFailed, RemoteEngineInitFailed
from spine_engine.utils.helpers import create_timestamp, gather_leaf_data
@@ -153,10 +152,52 @@ def toolbox(self):
def all_item_names(self):
return list(self._project_items)
+ @property
+ def n_items(self):
+ return len(self.all_item_names)
+
@property
def settings(self):
return self._settings
+ def has_items(self):
+ """Returns True if project has project items.
+
+ Returns:
+ bool: True if project has items, False otherwise
+ """
+ return bool(self._project_items)
+
+ def get_item(self, name):
+ """Returns project item.
+
+ Args:
+ name (str): Item's name
+
+ Returns:
+ ProjectItem: Project item
+ """
+ return self._project_items[name]
+
+ def get_items(self):
+ """Returns all project items.
+
+ Returns:
+ list of ProjectItem: All project items
+ """
+ return list(self._project_items.values())
+
+ def get_items_by_type(self, _type):
+ """Returns all project items with given _type.
+
+ Args:
+ _type (str): Project Item type
+
+ Returns:
+ list of ProjectItem: Project Items with given type or an empty list if none found
+ """
+ return [item for item in self.get_items() if item.item_type() == _type]
+
def _create_project_structure(self, directory):
"""Makes the given directory a Spine Toolbox project directory.
Creates directories and files that are common to all projects.
@@ -284,6 +325,7 @@ def load(self, spec_factories, item_factories):
Returns:
bool: True if the operation was successful, False otherwise
"""
+ self._toolbox.ui.textBrowser_eventlog.clear()
project_dict = load_project_dict(self.config_dir, self._logger)
if project_dict is None:
return False
@@ -315,7 +357,7 @@ def load(self, spec_factories, item_factories):
self._logger.msg.emit("Loading project items...")
if not items_dict:
self._logger.msg_warning.emit("Project has no items")
- self.restore_project_items(items_dict, item_factories, silent=True)
+ self.restore_project_items(items_dict, item_factories)
self._logger.msg.emit("Restoring connections...")
connection_dicts = project_info["project"]["connections"]
connections = list(map(self.connection_from_dict, connection_dicts))
@@ -574,12 +616,11 @@ def _default_specification_file_path(self, specification):
return None
return candidate_path
- def add_item(self, item, silent=True):
- """Adds a project to item project.
+ def add_item(self, item):
+ """Adds a project item to project.
Args:
item (ProjectItem): item to add
- silent (bool): if True, don't log messages
"""
if item.name in self._project_items:
raise RuntimeError("Item already in project.")
@@ -587,35 +628,6 @@ def add_item(self, item, silent=True):
name = item.name
self.item_added.emit(name)
item.set_up()
- if not silent:
- self._logger.msg.emit(f"{item.item_type()} {name} added to project")
-
- def has_items(self):
- """Returns True if project has project items.
-
- Returns:
- bool: True if project has items, False otherwise
- """
- return bool(self._project_items)
-
- def get_item(self, name):
- """Returns project item.
-
- Args:
- name (str): item's name
-
- Returns:
- ProjectItem: project item
- """
- return self._project_items[name]
-
- def get_items(self):
- """Returns all project items.
-
- Returns:
- list of ProjectItem: all project items
- """
- return list(self._project_items.values())
def rename_item(self, previous_name, new_name, rename_data_dir_message):
"""Renames a project item
@@ -746,7 +758,24 @@ def add_connection(self, *args, silent=False, notify_resource_changes=True):
self.connection_established.emit(connection)
self._update_jump_icons()
if not self._is_dag_valid(dag):
- return True # Connection was added successfully even though DAG is not valid.
+ self.remove_connection(connection)
+ msg = "This connection creates a cycle into the DAG.\n\nWould you like to add a Loop connection?"
+ title = f"Add Loop?"
+ message_box = QMessageBox(
+ QMessageBox.Icon.Question,
+ title,
+ msg,
+ QMessageBox.StandardButton.Ok | QMessageBox.StandardButton.Cancel,
+ parent=self._toolbox,
+ )
+ message_box.button(QMessageBox.StandardButton.Ok).setText("Add Loop")
+ answer = message_box.exec()
+ if answer == QMessageBox.StandardButton.Cancel:
+ return False
+ src_conn = self.get_item(connection.source).get_icon().conn_button(connection.source_position)
+ dst_conn = self.get_item(connection.destination).get_icon().conn_button(connection.destination_position)
+ self._toolbox.ui.graphicsView.add_jump(src_conn, dst_conn)
+ return False
destination = self._project_items[connection.destination]
source = self._project_items[connection.source]
if notify_resource_changes:
@@ -906,13 +935,12 @@ def dag_with_node(self, node):
"""Returns the DiGraph that contains the given node (project item) name (str)."""
return next((x for x in self._dag_iterator() if x.has_node(node)), None)
- def restore_project_items(self, items_dict, item_factories, silent):
+ def restore_project_items(self, items_dict, item_factories):
"""Restores project items from dictionary.
Args:
items_dict (dict): a mapping from item name to item dict
item_factories (dict): a mapping from item type to ProjectItemFactory
- silent (bool): if True, suppress a log messages
"""
for item_name, item_dict in items_dict.items():
try:
@@ -940,7 +968,7 @@ def restore_project_items(self, items_dict, item_factories, silent):
)
continue
project_item.copy_local_data(item_dict)
- self.add_item(project_item, silent)
+ self.add_item(project_item)
def remove_item_by_name(self, item_name, delete_data=False):
"""Removes project item by its name.
@@ -1013,7 +1041,7 @@ def _execute_dags(self, dags, execution_permits_list):
worker.finished.connect(lambda worker=worker: self._handle_engine_worker_finished(worker))
self._engine_workers.append(worker)
timestamp = create_timestamp()
- self._toolbox.start_execution(timestamp)
+ self._toolbox.make_execution_timestamp(timestamp)
# NOTE: Don't start the workers as they are created. They may finish too quickly, before the others
# are added to ``_engine_workers``, and thus ``_handle_engine_worker_finished()`` will believe
# that the project is done executing before it's fully loaded.
@@ -1106,12 +1134,12 @@ def execute_selected(self, names):
for dag in [dag for dag in self._dag_iterator() if set(names) & dag.nodes]:
more_dags = self._split_to_subdags(dag, names)
dags += more_dags
+ valid_dags = self._validate_dags(dags)
execution_permit_list = list()
- for dag in dags:
+ for dag in valid_dags:
execution_permits = {name: name in names for name in dag.nodes}
execution_permit_list.append(execution_permits)
- self._validate_dags(dags)
- self.execute_dags(dags, execution_permit_list, "Executing Selected Directed Acyclic Graphs")
+ self.execute_dags(valid_dags, execution_permit_list, "Executing Selected Directed Acyclic Graphs")
def _split_to_subdags(self, dag, selected_items):
"""Checks if given dag contains weakly connected components. If it does,
@@ -1127,8 +1155,13 @@ def _split_to_subdags(self, dag, selected_items):
"""
if len(dag.nodes) == 1:
return [dag]
+ # Get selected items that are in current dag
+ selected_items_in_this_dag = list()
+ for selected_item in list(selected_items):
+ if selected_item in list(dag.nodes()):
+ selected_items_in_this_dag.append(selected_item)
# List of Connections that have a selected item as its source or destination item
- connections = connections_to_selected_items(self._connections, set(selected_items))
+ connections = connections_to_selected_items(self._connections, set(selected_items_in_this_dag))
edges = dag_edges(connections)
d = make_dag(edges) # Make DAG as SpineEngine does it
if nx.number_weakly_connected_components(d) > 1:
@@ -1412,12 +1445,7 @@ def _update_predecessor(self, predecessor, outgoing_connections, resource_cache)
def _is_dag_valid(self, dag):
if not nx.is_directed_acyclic_graph(dag):
- edges = _edges_causing_loops(dag)
- for node in dag.nodes:
- self._project_items[node].invalidate_workflow(edges)
return False
- for node in dag.nodes:
- self._project_items[node].revalidate_workflow()
return True
def _update_ranks(self, dag):
@@ -1488,7 +1516,8 @@ def prepare_remote_execution(self):
return job_id
def finalize_remote_execution(self, job_id):
- """Sends a request to server to remove the project directory and removes the project ZIP file from client.y
+ """Sends a request to server to remove the project directory. In addition,
+ removes the project ZIP file from client machine.
Args:
job_id (str): job id
@@ -1539,31 +1568,8 @@ def node_successors(g):
return {n: list(g.successors(n)) for n in nx.topological_sort(g)}
-def _edges_causing_loops(g):
- """Returns a list of edges whose removal from g results in it becoming acyclic.
-
- Args:
- g (DiGraph)
-
- Returns:
- list
- """
- result = list()
- h = g.copy() # Let's work on a copy of the graph
- while True:
- try:
- cycle = list(nx.find_cycle(h))
- except nx.NetworkXNoCycle:
- break
- edge = random.choice(cycle)
- h.remove_edge(*edge)
- result.append(edge)
- return result
-
-
def _ranks(node_successors):
- """
- Calculates node ranks.
+ """Calculates node ranks.
Args:
node_successors (dict): a mapping from successor name to a list of predecessor names
diff --git a/spinetoolbox/project_commands.py b/spinetoolbox/project_commands.py
index fb83e802f..d6f818797 100644
--- a/spinetoolbox/project_commands.py
+++ b/spinetoolbox/project_commands.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,10 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-QUndoCommand subclasses for modifying the project.
-"""
-
+"""QUndoCommand subclasses for modifying the project."""
from PySide6.QtGui import QUndoCommand
from spine_engine.project_item.connection import Jump
@@ -32,31 +30,37 @@ def is_critical(self):
class SetItemSpecificationCommand(SpineToolboxCommand):
- def __init__(self, item, spec, old_spec):
- """Command to set the specification for a Tool.
+ """Command to set the specification for a project item."""
+ def __init__(self, item_name, spec, old_spec, project):
+ """
Args:
- item (ProjectItem): the Item
+ item_name (str): item's name
spec (ProjectItemSpecification): the new spec
old_spec (ProjectItemSpecification): the old spec
+ project (SpineToolboxProject): project
"""
super().__init__()
- self.item = item
- self.spec = spec
- self.old_spec = old_spec
- self.setText(f"set specification of {item.name}")
+ self._item_name = item_name
+ self._spec = spec
+ self._old_spec = old_spec
+ self._project = project
+ self.setText(f"set specification of {item_name}")
def redo(self):
- self.item.do_set_specification(self.spec)
+ item = self._project.get_item(self._item_name)
+ item.do_set_specification(self._spec)
def undo(self):
- self.item.do_set_specification(self.old_spec)
+ item = self._project.get_item(self._item_name)
+ item.do_set_specification(self._old_spec)
class MoveIconCommand(SpineToolboxCommand):
- def __init__(self, icon, project):
- """Command to move icons in the Design view.
+ """Command to move icons in the Design view."""
+ def __init__(self, icon, project):
+ """
Args:
icon (ProjectItemIcon): the icon
project (SpineToolboxProject): project
@@ -89,9 +93,10 @@ def _move_to(self, positions):
class SetProjectDescriptionCommand(SpineToolboxCommand):
- def __init__(self, project, description):
- """Command to set the project description.
+ """Command to set the project description."""
+ def __init__(self, project, description):
+ """
Args:
project (SpineToolboxProject): the project
description (str): The new description
@@ -110,9 +115,10 @@ def undo(self):
class AddProjectItemsCommand(SpineToolboxCommand):
- def __init__(self, project, items_dict, item_factories, silent=True):
- """Command to add items.
+ """Command to add items."""
+ def __init__(self, project, items_dict, item_factories):
+ """
Args:
project (SpineToolboxProject): the project
items_dict (dict): a mapping from item name to item dict
@@ -123,7 +129,6 @@ def __init__(self, project, items_dict, item_factories, silent=True):
self._project = project
self._items_dict = items_dict
self._item_factories = item_factories
- self._silent = silent
if not items_dict:
self.setObsolete(True)
elif len(items_dict) == 1:
@@ -132,7 +137,7 @@ def __init__(self, project, items_dict, item_factories, silent=True):
self.setText("add multiple items")
def redo(self):
- self._project.restore_project_items(self._items_dict, self._item_factories, self._silent)
+ self._project.restore_project_items(self._items_dict, self._item_factories)
def undo(self):
for item_name in self._items_dict:
@@ -140,9 +145,10 @@ def undo(self):
class RemoveAllProjectItemsCommand(SpineToolboxCommand):
- def __init__(self, project, item_factories, delete_data=False):
- """Command to remove all items from project.
+ """Command to remove all items from project."""
+ def __init__(self, project, item_factories, delete_data=False):
+ """
Args:
project (SpineToolboxProject): the project
item_factories (dict): a mapping from item type to ProjectItemFactory
@@ -161,15 +167,16 @@ def redo(self):
self._project.remove_item_by_name(name, self._delete_data)
def undo(self):
- self._project.restore_project_items(self._items_dict, self._item_factories, silent=True)
+ self._project.restore_project_items(self._items_dict, self._item_factories)
for connection_dict in self._connection_dicts:
self._project.add_connection(self._project.connection_from_dict(connection_dict), silent=True)
class RemoveProjectItemsCommand(SpineToolboxCommand):
- def __init__(self, project, item_factories, item_names, delete_data=False):
- """Command to remove items.
+ """Command to remove items."""
+ def __init__(self, project, item_factories, item_names, delete_data=False):
+ """
Args:
project (SpineToolboxProject): The project
item_factories (dict): a mapping from item type to ProjectItemFactory
@@ -200,7 +207,7 @@ def redo(self):
self._project.remove_item_by_name(name, self._delete_data)
def undo(self):
- self._project.restore_project_items(self._items_dict, self._item_factories, silent=True)
+ self._project.restore_project_items(self._items_dict, self._item_factories)
for connection_dict in self._connection_dicts:
self._project.add_connection(self._project.connection_from_dict(connection_dict), silent=True)
for jump_dict in self._jump_dicts:
@@ -208,9 +215,10 @@ def undo(self):
class RenameProjectItemCommand(SpineToolboxCommand):
- def __init__(self, project, previous_name, new_name):
- """Command to rename project items.
+ """Command to rename project items."""
+ def __init__(self, project, previous_name, new_name):
+ """
Args:
project (SpineToolboxProject): the project
previous_name (str): item's previous name
@@ -237,9 +245,10 @@ def is_critical(self):
class AddConnectionCommand(SpineToolboxCommand):
- def __init__(self, project, source_name, source_position, destination_name, destination_position):
- """Command to add connection between project items.
+ """Command to add connection between project items."""
+ def __init__(self, project, source_name, source_position, destination_name, destination_position):
+ """
Args:
project (SpineToolboxProject): project
source_name (str): source item's name
@@ -282,9 +291,10 @@ def undo(self):
class RemoveConnectionsCommand(SpineToolboxCommand):
- def __init__(self, project, connections):
- """Command to remove links.
+ """Command to remove links."""
+ def __init__(self, project, connections):
+ """
Args:
project (SpineToolboxProject): project
connections (list of LoggingConnection): the connections
@@ -311,9 +321,10 @@ def undo(self):
class AddJumpCommand(SpineToolboxCommand):
- def __init__(self, project, source_name, source_position, destination_name, destination_position):
- """Command to add a jump between project items.
+ """Command to add a jump between project items."""
+ def __init__(self, project, source_name, source_position, destination_name, destination_position):
+ """
Args:
project (SpineToolboxProject): project
source_name (str): source item's name
@@ -384,53 +395,66 @@ def undo(self):
class SetJumpConditionCommand(SpineToolboxCommand):
"""Command to set jump condition."""
- def __init__(self, jump_properties, jump, condition):
+ def __init__(self, project, jump, jump_properties, condition):
"""
Args:
- jump_properties (JumpPropertiesWidget): jump's properties tab
+ project (SpineToolboxProject): project
jump (Jump): target jump
- condition (str): jump condition
+ jump_properties (JumpPropertiesWidget): jump's properties tab
+ condition (dict): jump condition
"""
super().__init__()
+ self._project = project
self._jump_properties = jump_properties
- self._jump = jump
+ self._jump_source = jump.source
+ self._jump_destination = jump.destination
self._condition = condition
self._previous_condition = jump.condition
- self.setText("change loop condition")
+ self.setText(f"change loop condition for jump {jump.name}")
def redo(self):
- self._jump_properties.set_condition(self._jump, self._condition)
+ jump = self._project.find_jump(self._jump_source, self._jump_destination)
+ self._jump_properties.set_condition(jump, self._condition)
def undo(self):
- self._jump_properties.set_condition(self._jump, self._previous_condition)
+ jump = self._project.find_jump(self._jump_source, self._jump_destination)
+ self._jump_properties.set_condition(jump, self._previous_condition)
class UpdateJumpCmdLineArgsCommand(SpineToolboxCommand):
- def __init__(self, jump_properties, jump, cmd_line_args):
- """Command to update Jump command line args.
+ """Command to update Jump command line args."""
+ def __init__(self, project, jump, jump_properties, cmd_line_args):
+ """
Args:
+ project (SpineToolboxProject): project
+ jump (Jump): jump
jump_properties (JumpPropertiesWidget): the item
cmd_line_args (list): list of command line args
"""
super().__init__()
+ self._project = project
self._jump_properties = jump_properties
- self._jump = jump
+ self._jump_source = jump.source
+ self._jump_destination = jump.destination
self._redo_cmd_line_args = cmd_line_args
- self._undo_cmd_line_args = self._jump.cmd_line_args
- self.setText(f"change command line arguments of {jump.name}")
+ self._undo_cmd_line_args = jump.cmd_line_args
+ self.setText(f"change command line arguments of jump {jump.name}")
def redo(self):
- self._jump_properties.update_cmd_line_args(self._jump, self._redo_cmd_line_args)
+ jump = self._project.find_jump(self._jump_source, self._jump_destination)
+ self._jump_properties.update_cmd_line_args(jump, self._redo_cmd_line_args)
def undo(self):
- self._jump_properties.update_cmd_line_args(self._jump, self._undo_cmd_line_args)
+ jump = self._project.find_jump(self._jump_source, self._jump_destination)
+ self._jump_properties.update_cmd_line_args(jump, self._undo_cmd_line_args)
class SetFiltersOnlineCommand(SpineToolboxCommand):
- def __init__(self, project, connection, resource, filter_type, online):
- """Command to toggle filter value.
+ """Command to toggle filter value."""
+ def __init__(self, project, connection, resource, filter_type, online):
+ """
Args:
project (SpineToolboxProject): project
connection (Connection): connection
@@ -485,10 +509,39 @@ def undo(self):
connection.set_filter_default_online_status(not self._checked)
+class SetConnectionFilterTypeEnabled(SpineToolboxCommand):
+ """Command to enable and disable connection's filter types."""
+
+ def __init__(self, project, connection, filter_type, enabled):
+ """
+ Args:
+ project (SpineToolboxProject): project
+ connection (LoggingConnection): connection
+ filter_type (str): filter type
+ enabled (bool): whether filter type is enabled
+ """
+ super().__init__()
+ self.setText(f"change {connection.name}")
+ self._project = project
+ self._source_name = connection.source
+ self._destination_name = connection.destination
+ self._filter_type = filter_type
+ self._enabled = enabled
+
+ def redo(self):
+ connection = self._project.find_connection(self._source_name, self._destination_name)
+ connection.set_filter_type_enabled(self._filter_type, self._enabled)
+
+ def undo(self):
+ connection = self._project.find_connection(self._source_name, self._destination_name)
+ connection.set_filter_type_enabled(self._filter_type, not self._enabled)
+
+
class SetConnectionOptionsCommand(SpineToolboxCommand):
- def __init__(self, project, connection, options):
- """Command to set connection options.
+ """Command to set connection options."""
+ def __init__(self, project, connection, options):
+ """
Args:
project (SpineToolboxProject): project
connection (LoggingConnection): project
@@ -513,9 +566,10 @@ def undo(self):
class AddSpecificationCommand(SpineToolboxCommand):
- def __init__(self, project, specification, save_to_disk):
- """Command to add item specification to a project.
+ """Command to add item specification to a project."""
+ def __init__(self, project, specification, save_to_disk):
+ """
Args:
project (ToolboxUI): the toolbox
specification (ProjectItemSpecification): the spec
@@ -540,9 +594,10 @@ def undo(self):
class ReplaceSpecificationCommand(SpineToolboxCommand):
- def __init__(self, project, name, specification):
- """Command to replace item specification in project.
+ """Command to replace item specification in project."""
+ def __init__(self, project, name, specification):
+ """
Args:
project (ToolboxUI): the toolbox
name (str): the name of the spec to be replaced
@@ -569,9 +624,10 @@ def is_critical(self):
class RemoveSpecificationCommand(SpineToolboxCommand):
- def __init__(self, project, name):
- """Command to remove specs from a project.
+ """Command to remove specs from a project."""
+ def __init__(self, project, name):
+ """
Args:
project (SpineToolboxProject): the project
name (str): specification's name
@@ -590,9 +646,10 @@ def undo(self):
class SaveSpecificationAsCommand(SpineToolboxCommand):
- def __init__(self, project, name, path):
- """Command to remove item specs from a project.
+ """Command to remove item specs from a project."""
+ def __init__(self, project, name, path):
+ """
Args:
project (SpineToolboxProject): the project
name (str): specification's name
diff --git a/spinetoolbox/project_item/__init__.py b/spinetoolbox/project_item/__init__.py
index b8ab876f9..22dd1fb3b 100644
--- a/spinetoolbox/project_item/__init__.py
+++ b/spinetoolbox/project_item/__init__.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,6 +10,4 @@
# this program. If not, see .
######################################################################################################################
-"""
-This subpackage contains base classes for project items.
-"""
+"""This subpackage contains base classes for project items."""
diff --git a/spinetoolbox/project_item/logging_connection.py b/spinetoolbox/project_item/logging_connection.py
index c5d9eaa4c..30a168da8 100644
--- a/spinetoolbox/project_item/logging_connection.py
+++ b/spinetoolbox/project_item/logging_connection.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -8,10 +9,10 @@
# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
# this program. If not, see .
######################################################################################################################
-"""Contains logging connection and jump classes."""
+"""Contains logging connection and jump classes."""
from spinedb_api.filters.scenario_filter import SCENARIO_FILTER_TYPE
-from spinedb_api.filters.tool_filter import TOOL_FILTER_TYPE
+from spinedb_api.filters.alternative_filter import ALTERNATIVE_FILTER_TYPE
from spinedb_api import DatabaseMapping, SpineDBAPIError, SpineDBVersionError
from spine_engine.project_item.connection import ResourceConvertingConnection, Jump, ConnectionBase, FilterSettings
from ..log_mixin import LogMixin
@@ -20,6 +21,9 @@
from ..fetch_parent import FlexibleFetchParent
+_DATABASE_ITEM_TYPE = {ALTERNATIVE_FILTER_TYPE: "alternative", SCENARIO_FILTER_TYPE: "scenario"}
+
+
class HeadlessConnection(ResourceConvertingConnection):
"""A project item connection that is compatible with headless mode."""
@@ -55,6 +59,15 @@ def set_filter_enabled(self, resource_label, filter_type, filter_name, enabled):
)
specific_filter_settings[filter_name] = enabled
+ def set_filter_type_enabled(self, filter_type, enabled):
+ """Enables or disables a filter type.
+
+ Args:
+ filter_type (str): filter type
+ enabled (bool): True to enable the filter type, False to disable it
+ """
+ self._filter_settings.enabled_filter_types[filter_type] = enabled
+
def _convert_legacy_resource_filter_ids_to_filter_settings(self):
"""Converts legacy resource filter ids to filter settings.
@@ -80,15 +93,8 @@ def _convert_legacy_resource_filter_ids_to_filter_settings(self):
).setdefault(SCENARIO_FILTER_TYPE, {})
for row in db_map.query(db_map.scenario_sq):
specific_filter_settings[row.name]: row.id = row.id in scenario_filter_ids
- tool_filter_ids = resource_filter_ids.get(TOOL_FILTER_TYPE)
- if tool_filter_ids is not None:
- specific_filter_settings = self._filter_settings.known_filters.setdefault(
- resource.label, {}
- ).setdefault(TOOL_FILTER_TYPE, {})
- for row in db_map.query(db_map.tool_sq):
- specific_filter_settings[row.name] = row.id in tool_filter_ids
finally:
- db_map.connection.close()
+ db_map.close()
self._legacy_resource_filter_ids = None
@staticmethod
@@ -157,7 +163,7 @@ def graphics_item(self):
return self.link
def has_filters(self):
- """Returns True if connection has scenario or tool filters.
+ """Returns True if connection has any filters.
Returns:
bool: True if connection has filters, False otherwise
@@ -169,20 +175,14 @@ def has_filters(self):
db_map = self._get_db_map(url, ignore_version_error=True)
if db_map is None:
continue
- available_scenarios = {
- x["name"] for x in self._toolbox.db_mngr.get_items(db_map, "scenario", only_visible=True)
- }
- scenario_filters = self._filter_settings.known_filters.get(resource.label, {}).get(SCENARIO_FILTER_TYPE, {})
- if any(enabled for s, enabled in scenario_filters.items() if s in available_scenarios):
- return True
- if self._filter_settings.auto_online and any(name not in scenario_filters for name in available_scenarios):
- return True
- available_tools = {x["name"] for x in self._toolbox.db_mngr.get_items(db_map, "tool", only_visible=True)}
- tool_filters = self._filter_settings.known_filters.get(resource.label, {}).get(TOOL_FILTER_TYPE, {})
- if any(enabled for t, enabled in tool_filters.items() if t in available_tools):
- return True
- if self._filter_settings.auto_online and any(name not in tool_filters for name in available_tools):
- return True
+ known_filters = self._filter_settings.known_filters.get(resource.label, {})
+ for filter_type, item_type in _DATABASE_ITEM_TYPE.items():
+ available = {x["name"] for x in self._toolbox.db_mngr.get_items(db_map, item_type)}
+ filters = known_filters.get(filter_type, {})
+ if any(enabled for s, enabled in filters.items() if s in available):
+ return True
+ if self._filter_settings.auto_online and any(name not in filters for name in available):
+ return True
return False
def _get_db_map(self, url, ignore_version_error=False):
@@ -222,7 +222,7 @@ def _make_fetch_parent(self, db_map, item_type):
def _fetch_more_if_possible(self):
for db_map in self._db_maps.values():
- for item_type in ("scenario", "tool"):
+ for item_type in ("scenario",):
fetch_parent = self._make_fetch_parent(db_map, item_type)
if self._toolbox.db_mngr.can_fetch_more(db_map, fetch_parent):
self._toolbox.db_mngr.fetch_more(db_map, fetch_parent)
@@ -241,17 +241,23 @@ def receive_session_rolled_back(self, db_map):
def receive_error_msg(self, _db_map_error_log):
pass
- def get_scenario_names(self, url):
+ def get_filter_item_names(self, filter_type, url):
db_map = self._get_db_map(url)
if db_map is None:
return []
- return sorted(x["name"] for x in self._toolbox.db_mngr.get_items(db_map, "scenario", only_visible=True))
-
- def get_tool_names(self, url):
- db_map = self._get_db_map(url)
- if db_map is None:
- return []
- return sorted(x["name"] for x in self._toolbox.db_mngr.get_items(db_map, "tool", only_visible=True))
+ item_type = _DATABASE_ITEM_TYPE[filter_type]
+ return sorted(x["name"] for x in self._toolbox.db_mngr.get_items(db_map, item_type))
+
+ def _do_purge_before_writing(self, resources):
+ purged_urls = super()._do_purge_before_writing(resources)
+ committed_db_maps = set()
+ for url in purged_urls:
+ db_map = self._toolbox.db_mngr.db_map(url)
+ if db_map:
+ committed_db_maps.add(db_map)
+ if committed_db_maps:
+ self._toolbox.db_mngr.notify_session_committed(self, *committed_db_maps)
+ return purged_urls
def may_have_filters(self):
"""Returns whether this connection may have filters.
@@ -317,8 +323,8 @@ def set_online(self, resource, filter_type, online):
Args:
resource (str): Resource label
- filter_type (str): Either SCENARIO_FILTER_TYPE or TOOL_FILTER_TYPE, for now.
- online (dict): mapping from scenario/tool name to online flag
+ filter_type (str): filter type
+ online (dict): mapping from scenario name to online flag
"""
self._filter_settings.known_filters.setdefault(resource, {}).setdefault(filter_type, {}).update(online)
@@ -336,6 +342,13 @@ def refresh_resource_filter_model(self):
"""Makes resource filter mode fetch filter data from database."""
self.resource_filter_model.build_tree()
+ def set_filter_type_enabled(self, filter_type, enabled):
+ """See base class."""
+ super().set_filter_type_enabled(filter_type, enabled)
+ self.resource_filter_model.set_filter_type_enabled(filter_type, enabled)
+ if self is self._toolbox.active_link_item:
+ self._toolbox.link_properties_widgets[LoggingConnection].set_filter_type_enabled(filter_type, enabled)
+
def receive_resources_from_source(self, resources):
"""See base class."""
super().receive_resources_from_source(resources)
@@ -373,9 +386,12 @@ def _check_available_filters(self):
Returns:
FilterSettings: filter settings containing only filters that exist in source databases
"""
- filter_settings = FilterSettings(auto_online=self._filter_settings.auto_online)
+ filter_settings = FilterSettings(
+ auto_online=self._filter_settings.auto_online,
+ enabled_filter_types=self._filter_settings.enabled_filter_types,
+ )
for resource in self._resources:
- for filter_type in (SCENARIO_FILTER_TYPE, TOOL_FILTER_TYPE):
+ for filter_type in (SCENARIO_FILTER_TYPE, ALTERNATIVE_FILTER_TYPE):
online_filters = self._resource_filters_online(resource, filter_type)
if online_filters is not None:
filter_settings.known_filters.setdefault(resource.label, {})[filter_type] = online_filters
@@ -388,10 +404,8 @@ def _resource_filters_online(self, resource, filter_type):
db_map = self._get_db_map(url)
if db_map is None:
return None
- db_item_type = {SCENARIO_FILTER_TYPE: "scenario", TOOL_FILTER_TYPE: "tool"}[filter_type]
- available_filters = (
- x["name"] for x in self._toolbox.db_mngr.get_items(db_map, db_item_type, only_visible=True)
- )
+ db_item_type = _DATABASE_ITEM_TYPE[filter_type]
+ available_filters = (x["name"] for x in self._toolbox.db_mngr.get_items(db_map, db_item_type))
specific_filter_settings = self._filter_settings.known_filters.get(resource.label, {}).get(filter_type, {})
checked_specific_filter_settings = {}
for name in sorted(available_filters):
diff --git a/spinetoolbox/project_item/project_item.py b/spinetoolbox/project_item/project_item.py
index 644989799..4588449ed 100644
--- a/spinetoolbox/project_item/project_item.py
+++ b/spinetoolbox/project_item/project_item.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -8,13 +9,11 @@
# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
# this program. If not, see .
######################################################################################################################
-"""
-Contains base classes for project items and item factories.
-"""
+"""Contains base classes for project items and item factories."""
import os
import logging
-from PySide6.QtCore import Slot, Qt
+from PySide6.QtCore import Slot
from spine_engine.utils.helpers import shorten
from ..helpers import create_dir, open_url
from ..metaobject import MetaObject
@@ -77,14 +76,9 @@ def item_type():
"""
raise NotImplementedError()
- @staticmethod
- def item_category():
- """Item's category.
-
- Returns:
- str: category name
- """
- raise NotImplementedError()
+ @property
+ def project(self):
+ return self._project
@property
def logger(self):
@@ -164,7 +158,9 @@ def set_specification(self, specification):
"""Pushes a new SetItemSpecificationCommand to the toolbox' undo stack."""
if specification == self._specification:
return
- self._toolbox.undo_stack.push(SetItemSpecificationCommand(self, specification, self.undo_specification()))
+ self._toolbox.undo_stack.push(
+ SetItemSpecificationCommand(self.name, specification, self.undo_specification(), self._project)
+ )
def do_set_specification(self, specification):
"""Sets specification for this item. Removes specification if None given as argument.
@@ -203,8 +199,13 @@ def add_notification(self, text):
self.get_icon().exclamation_icon.add_notification(text)
def remove_notification(self, text):
+ """Remove the first notification that includes given subtext."""
self.get_icon().exclamation_icon.remove_notification(text)
+ def clear_other_notifications(self, text):
+ """Remove notifications that don't include the given subtext."""
+ self.get_icon().exclamation_icon.clear_other_notifications(text)
+
def set_rank(self, rank):
"""Set rank of this item for displaying in the design view."""
if rank is not None:
@@ -220,7 +221,7 @@ def handle_execution_successful(self, execution_direction, engine_state):
"""Performs item dependent actions after the execution item has finished successfully.
Args:
- execution_direction (str): "FORWARD" or "BACKWARD"
+ execution_direction (ExecutionDirection): ExecutionDirection.FORWARD or ExecutionDirection.BACKWARD
engine_state: engine state after item's execution
"""
@@ -305,23 +306,6 @@ def replace_resources_from_downstream(self, old, new):
new (list of ProjectItemResource): new resources
"""
- def invalidate_workflow(self, edges):
- """Notifies that this item's workflow is not acyclic.
-
- Args:
- edges (list): A list of edges that make the graph acyclic after removing them.
- """
- edges = ", ".join("{0} -> {1}".format(*edge) for edge in edges)
- self.clear_notifications()
- self.set_rank(None)
- self.add_notification(
- "The workflow defined for this item has loops and thus cannot be executed. "
- f"Possible fix: remove link(s) {edges}."
- )
-
- def revalidate_workflow(self):
- self.remove_notification("The workflow defined for this item has loops and thus cannot be executed.")
-
def item_dict(self):
"""Returns a dictionary corresponding to this item.
diff --git a/spinetoolbox/project_item/project_item_factory.py b/spinetoolbox/project_item/project_item_factory.py
index 71cdbd83b..e7825a787 100644
--- a/spinetoolbox/project_item/project_item_factory.py
+++ b/spinetoolbox/project_item/project_item_factory.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -8,9 +9,8 @@
# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
# this program. If not, see .
######################################################################################################################
-"""
-Contains base classes for project items and item factories.
-"""
+
+"""Contains base classes for project items and item factories."""
class ProjectItemFactory:
diff --git a/spinetoolbox/project_item/specification_editor_window.py b/spinetoolbox/project_item/specification_editor_window.py
index 2db92545b..a44c78a76 100644
--- a/spinetoolbox/project_item/specification_editor_window.py
+++ b/spinetoolbox/project_item/specification_editor_window.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Items.
# Spine Items is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,10 +10,8 @@
# this program. If not, see .
######################################################################################################################
-"""
-Contains SpecificationEditorWindowBase and ChangeSpecPropertyCommand
-"""
-
+"""Contains SpecificationEditorWindowBase and ChangeSpecPropertyCommand"""
+from enum import IntEnum, unique
from PySide6.QtGui import QKeySequence, QIcon, QUndoStack, QAction, QUndoCommand
from PySide6.QtCore import Signal, Slot, Qt
from PySide6.QtWidgets import (
@@ -29,19 +28,42 @@
QToolButton,
)
from spinetoolbox.widgets.notification import ChangeNotifier, Notification
-from spinetoolbox.helpers import CharIconEngine, restore_ui, save_ui
+from spinetoolbox.helpers import CharIconEngine, restore_ui, save_ui, SealCommand
+
+
+class UniqueCommandId:
+ _NEXT_ID = 1
+
+ @classmethod
+ def unique_id(cls):
+ """Returns a new unique command id.
+
+ Returns:
+ int: unique id
+ """
+ new_id = cls._NEXT_ID
+ cls._NEXT_ID += 1
+ return new_id
+
+
+@unique
+class CommandId(IntEnum):
+ NONE = -1
+ NAME_UPDATE = UniqueCommandId.unique_id()
+ DESCRIPTION_UPDATE = UniqueCommandId.unique_id()
class ChangeSpecPropertyCommand(QUndoCommand):
"""Command to set specification properties."""
- def __init__(self, callback, new_value, old_value, cmd_name):
+ def __init__(self, callback, new_value, old_value, cmd_name, command_id=CommandId.NONE):
"""
Args:
- callback (function): Function to call to set the spec property.
- new_value (any): new value
- old_value (any): old value
+ callback (Callable): Function to call to set the spec property.
+ new_value (Any): new value
+ old_value (Any): old value
cmd_name (str): command name
+ command_id (IntEnum): command id
"""
super().__init__()
self._callback = callback
@@ -49,6 +71,8 @@ def __init__(self, callback, new_value, old_value, cmd_name):
self._old_value = old_value
self.setText(cmd_name)
self.setObsolete(new_value == old_value)
+ self._id = command_id
+ self._sealed = False
def redo(self):
self._callback(self._new_value)
@@ -56,6 +80,21 @@ def redo(self):
def undo(self):
self._callback(self._old_value)
+ def id(self):
+ return self._id.value
+
+ def mergeWith(self, other):
+ if not isinstance(other, ChangeSpecPropertyCommand):
+ self._sealed = True
+ return False
+ if self._sealed or self.id() != other.id():
+ return False
+ if self._old_value == other._new_value:
+ self.setObsolete(True)
+ else:
+ self._new_value = other._new_value
+ return True
+
class SpecificationEditorWindowBase(QMainWindow):
"""Base class for spec editors."""
@@ -118,12 +157,11 @@ def _restore_dock_widgets(self):
"""Restores dockWidgets to some default state. Called in the constructor, before restoring the ui from settings.
Reimplement in subclasses if needed."""
- def _make_new_specification(self, spec_name, exiting=None):
+ def _make_new_specification(self, spec_name):
"""Returns a ProjectItemSpecification from current form settings.
Args:
spec_name (str): Name of the spec
- exiting (bool, optional): Set as True if called when trying to exit the editor window
Returns:
ProjectItemSpecification
@@ -189,7 +227,7 @@ def _save(self, exiting=None):
return self.prompt_exit_without_saving()
self.show_error("Please enter a name for the specification.")
return False
- spec = self._make_new_specification(name, exiting)
+ spec = self._make_new_specification(name)
if spec is None:
return self.prompt_exit_without_saving() if exiting else False
if not self._original_spec_name:
@@ -290,9 +328,9 @@ def __init__(self, parent, spec, undo_stack):
self.setMovable(False)
widget = QWidget()
layout = QHBoxLayout(widget)
- layout.addWidget(QLabel("Name"))
+ layout.addWidget(QLabel("Name:"))
layout.addWidget(self._line_edit_name)
- layout.addWidget(QLabel("Description"))
+ layout.addWidget(QLabel("Description:"))
layout.addWidget(self._line_edit_description)
layout.setContentsMargins(3, 3, 3, 3)
layout.setStretchFactor(self._line_edit_name, 1)
@@ -300,7 +338,7 @@ def __init__(self, parent, spec, undo_stack):
self.addWidget(widget)
toolbox_icon = QIcon(":/symbols/Spine_symbol.png")
self.show_toolbox_action = self.addAction(toolbox_icon, "Show Spine Toolbox (Ctrl+ESC)")
- self.show_toolbox_action.setShortcut(Qt.CTRL | Qt.Key_Escape)
+ self.show_toolbox_action.setShortcut(QKeySequence(Qt.Modifier.CTRL.value | Qt.Key.Key_Escape.value))
self.menu = self._make_main_menu()
self.save_action = self.menu.addAction("Save")
self.duplicate_action = self.menu.addAction("Duplicate")
@@ -309,7 +347,7 @@ def __init__(self, parent, spec, undo_stack):
self.duplicate_action.setEnabled(self._parent.specification is not None)
self.save_action.setShortcut(QKeySequence.Save)
self.save_action.setIcon(QIcon(":/icons/menu_icons/save_solid.svg"))
- self.duplicate_action.setShortcut(QKeySequence(Qt.CTRL | Qt.Key_D))
+ self.duplicate_action.setShortcut(QKeySequence(Qt.Modifier.CTRL.value | Qt.Key.Key_D.value))
self.duplicate_action.setIcon(QIcon(":/icons/menu_icons/copy.svg"))
self.close_action.setShortcut(QKeySequence.Close)
self.close_action.setIcon(QIcon(":/icons/menu_icons/window-close.svg"))
@@ -317,8 +355,10 @@ def __init__(self, parent, spec, undo_stack):
if spec:
self.do_set_name(spec.name)
self.do_set_description(spec.description)
- self._line_edit_name.editingFinished.connect(self._set_name)
- self._line_edit_description.editingFinished.connect(self._set_description)
+ self._line_edit_name.textEdited.connect(self._update_name)
+ self._line_edit_name.editingFinished.connect(self._finish_name_editing)
+ self._line_edit_description.textEdited.connect(self._update_description)
+ self._line_edit_description.editingFinished.connect(self._finish_description_editing)
def _make_main_menu(self):
menu = QMenu(self)
@@ -328,40 +368,66 @@ def _make_main_menu(self):
menu_button.setPopupMode(QToolButton.ToolButtonPopupMode.InstantPopup)
action = QAction(self)
action.triggered.connect(menu_button.showMenu)
- keys = [QKeySequence(Qt.ALT | Qt.Key_F), QKeySequence(Qt.ALT | Qt.Key_E)]
+ keys = [
+ QKeySequence(Qt.Modifier.ALT.value | Qt.Key.Key_F.value),
+ QKeySequence(Qt.Modifier.ALT.value | Qt.Key.Key_E.value),
+ ]
action.setShortcuts(keys)
self._parent.addAction(action)
keys_str = ", ".join([key.toString() for key in keys])
menu_button.setToolTip(f"Main menu ({keys_str})
")
return menu
- @Slot()
- def _set_name(self):
- if self.name() == self._current_name:
- return
+ @Slot(str)
+ def _update_name(self, name):
+ """Pushes a command to undo stack that updates the specification name.
+
+ Args:
+ name (str): updated name
+ """
self._undo_stack.push(
- ChangeSpecPropertyCommand(self.do_set_name, self.name(), self._current_name, "change specification name")
+ ChangeSpecPropertyCommand(
+ self.do_set_name, name, self._current_name, "change specification name", CommandId.NAME_UPDATE
+ )
)
@Slot()
- def _set_description(self):
- if self.description() == self._current_description:
- return
+ def _finish_name_editing(self):
+ """Seals the last undo command."""
+ self._undo_stack.push(SealCommand(CommandId.NAME_UPDATE.value))
+
+ @Slot(str)
+ def _update_description(self, description):
+ """Pushes a command to undo stack that updates the specification description.
+
+ Args:
+ description (str): updated description
+ """
self._undo_stack.push(
ChangeSpecPropertyCommand(
self.do_set_description,
self.description(),
self._current_description,
"change specification description",
+ CommandId.DESCRIPTION_UPDATE,
)
)
+ @Slot()
+ def _finish_description_editing(self):
+ """Seals the last undo command."""
+ self._undo_stack.push(SealCommand(CommandId.DESCRIPTION_UPDATE.value))
+
def do_set_name(self, name):
+ self.name_changed.emit(name)
+ if self._line_edit_name.text() == name:
+ return
self._current_name = name
self._line_edit_name.setText(name)
- self.name_changed.emit(name)
def do_set_description(self, description):
+ if self._line_edit_description.text() == description:
+ return
self._current_description = description
self._line_edit_description.setText(description)
diff --git a/spinetoolbox/project_item_icon.py b/spinetoolbox/project_item_icon.py
index b396f14bf..de2343047 100644
--- a/spinetoolbox/project_item_icon.py
+++ b/spinetoolbox/project_item_icon.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,21 +10,16 @@
# this program. If not, see .
######################################################################################################################
-"""
-Classes for drawing graphics items on QGraphicsScene.
-"""
-
+"""Classes for drawing graphics items on QGraphicsScene."""
import math
from PySide6.QtCore import Qt, QPointF, QRectF, QLineF
from PySide6.QtWidgets import (
QGraphicsItem,
QGraphicsTextItem,
- QGraphicsSimpleTextItem,
QGraphicsPathItem,
QGraphicsEllipseItem,
QGraphicsColorizeEffect,
QGraphicsDropShadowEffect,
- QApplication,
QToolTip,
QStyle,
)
@@ -32,7 +28,6 @@
QPen,
QBrush,
QTextCursor,
- QPalette,
QTextBlockFormat,
QFont,
QPainterPath,
@@ -81,9 +76,11 @@ def __init__(self, toolbox, icon_file, icon_color):
self.rank_icon = RankIcon(self)
# Make item name graphics item.
self._name = ""
- self.name_item = QGraphicsSimpleTextItem(self._name)
+ self.name_item = QGraphicsTextItem(self._name)
self.name_item.setZValue(100)
self.set_name_attributes() # Set font, size, position, etc.
+ self.spec_item = None # For displaying Tool Spec icon
+ self.spec_item_renderer = None
# Make connector buttons
self.connectors = dict(
bottom=ConnectorButton(toolbox, self, position="bottom"),
@@ -97,6 +94,31 @@ def __init__(self, toolbox, icon_file, icon_color):
self.setGraphicsEffect(shadow_effect)
self._update_path()
+ def add_specification_icon(self, spec_icon_path):
+ """Adds an SVG icon to bottom left corner of the item icon based on Tool Specification type.
+
+ Args:
+ spec_icon_path (str): Path to icon resource file.
+ """
+ self.spec_item = QGraphicsSvgItem(self)
+ self.spec_item_renderer = QSvgRenderer()
+ loading_ok = self.spec_item_renderer.load(spec_icon_path)
+ if not loading_ok:
+ self._toolbox.msg_error.emit(f"Loading SVG icon from resource {spec_icon_path} failed")
+ return
+ size = self.spec_item_renderer.defaultSize()
+ self.spec_item.setSharedRenderer(self.spec_item_renderer)
+ self.spec_item.setElementId("")
+ dim_max = max(size.width(), size.height())
+ rect_w = 0.3 * self.rect().width() # Parent rect width
+ self.spec_item.setScale(rect_w / dim_max)
+ self.spec_item.setPos(self.sceneBoundingRect().bottomLeft() - self.spec_item.sceneBoundingRect().center())
+
+ def remove_specification_icon(self):
+ """Removes the specification icon SVG from the scene."""
+ self.spec_item.setParentItem(None)
+ self.spec_item = None
+
def rect(self):
return self._rect
@@ -126,8 +148,7 @@ def _do_update_path(self, rounded):
self._selection_halo.setPen(selection_pen)
def finalize(self, name, x, y):
- """
- Names the icon and moves it by given amount.
+ """Names the icon and moves it by a given amount.
Args:
name (str): icon's name
@@ -138,7 +159,7 @@ def finalize(self, name, x, y):
self.update_name_item(name)
def _setup(self):
- """Setup item's attributes."""
+ """Sets up item attributes."""
self.colorizer.setColor(self._icon_color)
background_color = fix_lightness_color(self._icon_color)
gradient = QRadialGradient(self._rect.center(), 1 * self._rect.width())
@@ -187,25 +208,28 @@ def name(self):
return self._name
def update_name_item(self, new_name):
- """Set a new text to name item.
+ """Sets a new text to name item.
Args:
new_name (str): icon's name
"""
self._name = new_name
- self.name_item.setText(new_name)
+ self.name_item.setPlainText(new_name)
self._reposition_name_item()
+ self.name_item.setTextWidth(100)
def set_name_attributes(self):
- """Set name QGraphicsSimpleTextItem attributes (font, size, position, etc.)"""
- # Set font size and style
+ """Sets name item attributes (font, size, style, alignment)."""
font = self.name_item.font()
font.setPixelSize(self.FONT_SIZE_PIXELS)
font.setBold(True)
self.name_item.setFont(font)
+ option = self.name_item.document().defaultTextOption()
+ option.setAlignment(Qt.AlignmentFlag.AlignCenter)
+ self.name_item.document().setDefaultTextOption(option)
def _reposition_name_item(self):
- """Set name item position (centered on top of the master icon)."""
+ """Sets name item position (centered on top of the master icon)."""
main_rect = self.sceneBoundingRect()
name_rect = self.name_item.sceneBoundingRect()
self.name_item.setPos(main_rect.center().x() - name_rect.width() / 2, main_rect.y() - name_rect.height() - 4)
@@ -299,9 +323,13 @@ def update_links_geometry(self):
if not scene:
return
icon_group = scene.icon_group | {self}
- scene.dirty_links |= set(
- link for icon in icon_group for conn in icon.connectors.values() for link in conn.links
- )
+ dirty_links = set(link for icon in icon_group for conn in icon.connectors.values() for link in conn.links)
+ if not dirty_links:
+ return
+ qsettings = self._toolbox.qsettings()
+ curved_links = qsettings.value("appSettings/curvedLinks", defaultValue="false") == "true"
+ for link in dirty_links:
+ link.update_geometry(curved_links)
def mouseReleaseEvent(self, event):
"""Clears pre-bump rects, and pushes a move icon command if necessary."""
@@ -328,14 +356,14 @@ def contextMenuEvent(self, event):
event.accept()
self.scene().clearSelection()
self.setSelected(True)
- ind = self._toolbox.project_item_model.find_item(self.name())
- self._toolbox.show_project_or_item_context_menu(event.screenPos(), ind)
+ item = self._toolbox.project().get_item(self.name())
+ self._toolbox.show_project_or_item_context_menu(event.screenPos(), item)
def itemChange(self, change, value):
"""
Reacts to item removal and position changes.
- In particular, destroys the drop shadow effect when the items is removed from a scene
+ In particular, destroys the drop shadow effect when the item is removed from a scene
and keeps track of item's movements on the scene.
Args:
@@ -414,11 +442,6 @@ def _restablish_bumped_items(self):
pass
return restablished
- def select_item(self):
- """Update GUI to show the details of the selected item."""
- ind = self._toolbox.project_item_model.find_item(self.name())
- self._toolbox.ui.treeView_project.setCurrentIndex(ind)
-
def paint(self, painter, option, widget=None):
"""Sets a dashed pen if selected."""
selected = bool(option.state & QStyle.StateFlag.State_Selected)
@@ -501,7 +524,6 @@ def mousePressEvent(self, event):
if event.button() != Qt.LeftButton:
event.accept()
return
- self._parent.select_item()
self._start_link(event)
def _start_link(self, event):
@@ -571,7 +593,7 @@ def __init__(self, parent):
self._parent = parent
self._execution_state = "not started"
self._text_item = QGraphicsTextItem(self)
- font = QFont('Font Awesome 5 Free Solid')
+ font = QFont("Font Awesome 5 Free Solid")
self._text_item.setFont(font)
parent_rect = parent.rect()
self.setRect(0, 0, 0.5 * parent_rect.width(), 0.5 * parent_rect.height())
@@ -646,7 +668,7 @@ def __init__(self, parent):
super().__init__(parent)
self._parent = parent
self._notifications = list()
- font = QFont('Font Awesome 5 Free Solid')
+ font = QFont("Font Awesome 5 Free Solid")
font.setPixelSize(self.FONT_SIZE_PIXELS)
self.setFont(font)
self.setDefaultTextColor(QColor("red"))
@@ -662,6 +684,14 @@ def clear_notifications(self):
self._notifications.clear()
self.hide()
+ def clear_other_notifications(self, subtext):
+ """Remove notifications that don't include the given subtext."""
+ k = next((i for i, text in enumerate(self._notifications) if subtext not in text), None)
+ if k is not None:
+ self._notifications.pop(k)
+ if not self._notifications:
+ self.hide()
+
def add_notification(self, text):
"""Add a notification."""
self._notifications.append(text)
@@ -707,7 +737,7 @@ def __init__(self, parent):
self._parent = parent
self._rect = parent.component_rect
self.bg = QGraphicsPathItem(self)
- bg_brush = QApplication.palette().brush(QPalette.ToolTipBase)
+ bg_brush = QBrush(QColor(Qt.GlobalColor.white))
self.bg.setBrush(bg_brush)
self.bg.setFlag(QGraphicsItem.ItemStacksBehindParent)
self.setFlag(QGraphicsItem.ItemIsSelectable, enabled=False)
diff --git a/spinetoolbox/project_settings.py b/spinetoolbox/project_settings.py
index ff5d9553f..d65f99353 100644
--- a/spinetoolbox/project_settings.py
+++ b/spinetoolbox/project_settings.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -8,8 +9,8 @@
# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
# this program. If not, see .
######################################################################################################################
-"""Contains project-specific settings."""
+"""Contains project-specific settings."""
import dataclasses
diff --git a/spinetoolbox/project_upgrader.py b/spinetoolbox/project_upgrader.py
index 199f8da33..792d84dba 100644
--- a/spinetoolbox/project_upgrader.py
+++ b/spinetoolbox/project_upgrader.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,11 +10,8 @@
# this program. If not, see .
######################################################################################################################
-"""
-Contains ProjectUpgrader class used in upgrading and converting projects
-and project dicts from earlier versions to the latest version.
-"""
-
+"""Contains ProjectUpgrader class used in upgrading and converting projects
+and project dicts from earlier versions to the latest version."""
import shutil
import os
import json
@@ -53,22 +51,36 @@ def upgrade(self, project_dict, project_dir):
f"Opening project {project_dir} failed. The project's version is {v}, while "
f"this version of Spine Toolbox supports project versions up to and "
f"including {LATEST_PROJECT_VERSION}. To open this project, you should "
- f"upgrade Spine Toolbox"
+ f"upgrade Spine Toolbox."
)
return False
if v < LATEST_PROJECT_VERSION:
+ if not self.confirm_upgrade(project_dir):
+ return False
# Back up project.json file before upgrading
if not self.backup_project_file(project_dir, v):
- self._toolbox.msg_error.emit("Upgrading project failed")
+ self._toolbox.msg_error.emit(f"Upgrading project {project_dir} failed")
return False
upgraded_dict = self.upgrade_to_latest(v, project_dict, project_dir)
# Force save project dict to project.json
if not self.force_save(upgraded_dict, project_dir):
- self._toolbox.msg_error.emit("Upgrading project failed")
+ self._toolbox.msg_error.emit(f"Upgrading project {project_dir} failed")
return False
return upgraded_dict
return project_dict
+ def confirm_upgrade(self, project_dir):
+ """Asks user whether to upgrade the project to a new version."""
+ button = QMessageBox.question(
+ self._toolbox,
+ "Upgrade project?",
+ f"Project {project_dir} needs an upgrade to work "
+ f"with this version of Spine Toolbox.
Upgrade project?",
+ )
+ if button == QMessageBox.StandardButton.Yes:
+ return True
+ return False
+
def upgrade_to_latest(self, v, project_dict, project_dir):
"""Upgrades the given project dictionary to the latest version.
@@ -80,8 +92,8 @@ def upgrade_to_latest(self, v, project_dict, project_dir):
Returns:
dict: Upgraded project dictionary
"""
- # TODO: Fix upgrade_vx_to_vx() methods so they do not depend on self._toolbox.item_factories because these are
- # TODO: going to change
+ # Note: upgrade_vx_to_vx() methods should not depend on self._toolbox.item_factories
+ # because these are likely to change
while v < LATEST_PROJECT_VERSION:
if v == 1:
project_dict = self.upgrade_v1_to_v2(project_dict, self._toolbox.item_factories)
@@ -103,6 +115,10 @@ def upgrade_to_latest(self, v, project_dict, project_dir):
project_dict = self.upgrade_v9_to_v10(project_dict)
elif v == 10:
project_dict = self.upgrade_v10_to_v11(project_dict)
+ elif v == 11:
+ project_dict = self.upgrade_v11_to_v12(project_dict)
+ elif v == 12:
+ project_dict = self.upgrade_v12_to_v13(project_dict)
v += 1
self._toolbox.msg_success.emit(f"Project upgraded to version {v}")
return project_dict
@@ -523,6 +539,44 @@ def upgrade_v10_to_v11(old):
new["project"]["settings"] = ProjectSettings().to_dict()
return new
+ @staticmethod
+ def upgrade_v11_to_v12(old):
+ """Upgrades version 11 project dictionary to version 12.
+
+ Changes:
+ 1. Julia's execution settings are now Tool Spec settings instead of global settings
+ Execution settings are local user settings so this only updates the project version
+ to make sure that these projects cannot be opened with an older Toolbox version.
+
+ Args:
+ old (dict): Version 11 project dictionary
+
+ Returns:
+ dict: Version 12 project dictionary
+ """
+ new = copy.deepcopy(old)
+ new["project"]["version"] = 12
+ return new
+
+ @staticmethod
+ def upgrade_v12_to_v13(old):
+ """Upgrades version 12 project dictionary to version 13.
+
+ Changes:
+ 1. Connections now have enabled filter types field.
+ Old projects should open just fine so this only updates the project version
+ to make sure that these projects cannot be opened with an older Toolbox version.
+
+ Args:
+ old (dict): Version 12 project dictionary
+
+ Returns:
+ dict: Version 13 project dictionary
+ """
+ new = copy.deepcopy(old)
+ new["project"]["version"] = 13
+ return new
+
@staticmethod
def make_unique_importer_specification_name(importer_name, label, k):
return f"{importer_name} - {os.path.basename(label['path'])} - {k}"
@@ -579,8 +633,8 @@ def is_valid(self, v, p):
return self.is_valid_v2_to_v8(p, v)
if 9 <= v <= 10:
return self.is_valid_v9_to_v10(p)
- if v == 11:
- return self.is_valid_v11(p)
+ if 11 <= v <= 13:
+ return self.is_valid_v11_to_v12(p)
raise NotImplementedError(f"No validity check available for version {v}")
def is_valid_v1(self, p):
@@ -709,9 +763,9 @@ def is_valid_v9_to_v10(self, p):
return False
return True
- def is_valid_v11(self, p):
+ def is_valid_v11_to_v12(self, p):
"""Checks that the given project JSON dictionary contains
- a valid version 11 Spine Toolbox project. Valid meaning, that
+ a valid version 11 or 12 Spine Toolbox project. Valid meaning, that
it contains all required keys and values are of the correct
type.
@@ -719,7 +773,7 @@ def is_valid_v11(self, p):
p (dict): Project information JSON
Returns:
- bool: True if project is a valid version 11 project, False otherwise
+ bool: True if project is a valid version 11 or 12 project, False otherwise
"""
if "project" not in p:
self._toolbox.msg_error.emit("Invalid project.json file. Key 'project' not found.")
diff --git a/spinetoolbox/qthread_pool_executor.py b/spinetoolbox/qthread_pool_executor.py
index 6dbd5e614..03d93843a 100644
--- a/spinetoolbox/qthread_pool_executor.py
+++ b/spinetoolbox/qthread_pool_executor.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,9 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-Qt-based thread pool executor.
-"""
+"""Qt-based thread pool executor."""
import os
from PySide6.QtCore import QMutex, QSemaphore, QThread
@@ -20,13 +19,21 @@ class TimeOutError(Exception):
"""An exception to raise when a timeouts expire"""
+class _CustomQSemaphore(QSemaphore):
+ def tryAcquire(self, n, timeout=None):
+ if timeout is None:
+ timeout = -1
+ timeout *= 1000
+ return super().tryAcquire(n, timeout)
+
+
class QtBasedQueue:
"""A Qt-based clone of queue.Queue."""
def __init__(self):
self._items = []
self._mutex = QMutex()
- self._semafore = QSemaphore()
+ self._semafore = _CustomQSemaphore()
def put(self, item):
self._mutex.lock()
@@ -35,9 +42,6 @@ def put(self, item):
self._semafore.release()
def get(self, timeout=None):
- if timeout is None:
- timeout = -1
- timeout *= 1000
if not self._semafore.tryAcquire(1, timeout):
raise TimeOutError()
self._mutex.lock()
@@ -50,26 +54,42 @@ class QtBasedFuture:
"""A Qt-based clone of concurrent.futures.Future."""
def __init__(self):
- self._result_queue = QtBasedQueue()
- self._exception_queue = QtBasedQueue()
+ self._semafore = _CustomQSemaphore()
+ self._done = False
+ self._result = None
+ self._exception = None
+ self._done_callbacks = []
def set_result(self, result):
- self._exception_queue.put(None)
- self._result_queue.put(result)
+ self._result = result
+ self._done = True
+ self._semafore.release()
+ for callback in self._done_callbacks:
+ callback(self)
+ self._done_callbacks = []
def set_exception(self, exc):
- self._exception_queue.put(exc)
- self._result_queue.put(None)
+ self._exception = exc
+ self._done = True
+ self._semafore.release()
def result(self, timeout=None):
- result = self._result_queue.get(timeout=timeout)
- exc = self.exception(timeout=0)
- if exc is not None:
- raise exc
- return result
+ if not self._done and not self._semafore.tryAcquire(1, timeout):
+ raise TimeOutError()
+ if self._exception is not None:
+ raise self._exception
+ return self._result
def exception(self, timeout=None):
- return self._exception_queue.get(timeout=timeout)
+ if not self._done and not self._semafore.tryAcquire(1, timeout):
+ raise TimeOutError()
+ return self._exception
+
+ def add_done_callback(self, callback):
+ if self._done:
+ callback(self)
+ return
+ self._done_callbacks.append(callback)
class QtBasedThread(QThread):
@@ -119,11 +139,7 @@ def _do_work(self):
if self._shutdown:
break
future, fn, args, kwargs = request
- try:
- result = fn(*args, **kwargs)
- future.set_result(result)
- except Exception as exc: # pylint: disable=broad-except
- future.set_exception(exc)
+ _set_future_result_and_exc(future, fn, *args, **kwargs)
self._semafore.release()
def shutdown(self):
@@ -134,3 +150,21 @@ def shutdown(self):
thread = self._threads.pop()
thread.wait()
thread.deleteLater()
+
+
+class SynchronousExecutor:
+ def submit(self, fn, *args, **kwargs):
+ future = QtBasedFuture()
+ _set_future_result_and_exc(future, fn, *args, **kwargs)
+ return future
+
+ def shutdown(self):
+ pass
+
+
+def _set_future_result_and_exc(future, fn, *args, **kwargs):
+ try:
+ result = fn(*args, **kwargs)
+ future.set_result(result)
+ except Exception as exc: # pylint: disable=broad-except
+ future.set_exception(exc)
diff --git a/spinetoolbox/resources_icons_rc.py b/spinetoolbox/resources_icons_rc.py
index 3ffddd7aa..34b5ad9be 100644
--- a/spinetoolbox/resources_icons_rc.py
+++ b/spinetoolbox/resources_icons_rc.py
@@ -1,6 +1,7 @@
# Resource object code (Python 3)
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -27017,6 +27018,33 @@
style=\x22stroke-\
width:0.5\x22 />\x0d\x0a<\
/svg>\x0d\x0a\
+\x00\x00\x01\x8d\
+<\
+svg xmlns=\x22http:\
+//www.w3.org/200\
+0/svg\x22 viewBox=\x22\
+0 0 512 512\x22>\
\x00\x00\x014\
<\
svg xmlns=\x22http:\
@@ -30168,6 +30196,41 @@
\x22\x0d\x0a style=\x22f\
ill:#ff0000\x22 />\x0d\
\x0a\x0d\x0a\
+\x00\x00\x02\x0f\
+<\
+svg xmlns=\x22http:\
+//www.w3.org/200\
+0/svg\x22 viewBox=\x22\
+0 0 384 512\x22>\
\x00\x00\x01\x1b\
<\
svg xmlns=\x22http:\
@@ -31804,6 +31867,10 @@
\x0bR\x1e\xf3\
\x00m\
\x00e\x00n\x00u\x00_\x00i\x00c\x00o\x00n\x00s\
+\x00\x09\
+\x08\x88\xa9\x07\
+\x00s\
+\x00h\x00a\x00r\x00e\x00.\x00s\x00v\x00g\
\x00\x12\
\x0an5\x93\
\x00p\
@@ -31975,6 +32042,11 @@
\x01\x80\x9cg\
\x00c\
\x00o\x00g\x00_\x00m\x00i\x00n\x00u\x00s\x00.\x00s\x00v\x00g\
+\x00\x12\
+\x03\xedqg\
+\x00b\
+\x00o\x00l\x00t\x00-\x00l\x00i\x00g\x00h\x00t\x00n\x00i\x00n\x00g\x00.\x00s\x00v\
+\x00g\
\x00\x09\
\x09(\xae'\
\x00t\
@@ -32056,9 +32128,9 @@
qt_resource_struct = b"\
\x00\x00\x00\x00\x00\x02\x00\x00\x00\x04\x00\x00\x00\x01\
\x00\x00\x00\x00\x00\x00\x00\x00\
-\x00\x00\x00\x10\x00\x02\x00\x00\x00\x03\x00\x00\x00X\
+\x00\x00\x00\x10\x00\x02\x00\x00\x00\x03\x00\x00\x00Z\
\x00\x00\x00\x00\x00\x00\x00\x00\
-\x00\x00\x00\x00\x00\x02\x00\x00\x00\x19\x00\x00\x00\x09\
+\x00\x00\x00\x00\x00\x02\x00\x00\x00\x1a\x00\x00\x00\x09\
\x00\x00\x00\x00\x00\x00\x00\x00\
\x00\x00\x00 \x00\x02\x00\x00\x00\x03\x00\x00\x00\x06\
\x00\x00\x00\x00\x00\x00\x00\x00\
@@ -32076,21 +32148,21 @@
\x00\x00\x01\x8aE\xfa\xa6P\
\x00\x00\x01\xea\x00\x00\x00\x00\x00\x01\x00\x062\x92\
\x00\x00\x01\x8aE\xfa\xa6\xa3\
-\x00\x00\x04X\x00\x00\x00\x00\x00\x01\x00\x06\xa7<\
+\x00\x00\x04p\x00\x00\x00\x00\x00\x01\x00\x06\xa8\xcd\
\x00\x00\x01\x8aE\xfa\xa6P\
-\x00\x00\x04\xa0\x00\x00\x00\x00\x00\x01\x00\x06\xbc&\
+\x00\x00\x04\xb8\x00\x00\x00\x00\x00\x01\x00\x06\xbd\xb7\
\x00\x00\x01\x8aE\xfa\xa6\x82\
\x00\x00\x03D\x00\x00\x00\x00\x00\x01\x00\x06\x88\x1a\
\x00\x00\x01\x8aE\xfa\xa6\xa3\
-\x00\x00\x04\x80\x00\x00\x00\x00\x00\x01\x00\x06\xa9\x10\
+\x00\x00\x04\x98\x00\x00\x00\x00\x00\x01\x00\x06\xaa\xa1\
\x00\x00\x01\x8aE\xfa\xa6P\
-\x00\x00\x03\xf4\x00\x00\x00\x00\x00\x01\x00\x06\x98\x16\
+\x00\x00\x04\x0c\x00\x00\x00\x00\x00\x01\x00\x06\x99\xa7\
\x00\x00\x01\x8aE\xfa\xa6\x82\
\x00\x00\x02\x80\x00\x00\x00\x00\x00\x01\x00\x06E\xb2\
\x00\x00\x01\x8aE\xfa\xa6P\
\x00\x00\x02h\x00\x00\x00\x00\x00\x01\x00\x06B\xab\
\x00\x00\x01\x8aE\xfa\xa6\xa3\
-\x00\x00\x03\xde\x00\x00\x00\x00\x00\x01\x00\x06\x95\xa7\
+\x00\x00\x03\xf6\x00\x00\x00\x00\x00\x01\x00\x06\x978\
\x00\x00\x01\x8aE\xfa\xa6_\
\x00\x00\x03^\x00\x00\x00\x00\x00\x01\x00\x06\x8a3\
\x00\x00\x01\x8aE\xfa\xa6P\
@@ -32102,19 +32174,21 @@
\x00\x00\x01\x8aE\xfa\xa6P\
\x00\x00\x01\xbe\x00\x00\x00\x00\x00\x01\x00\x060\xaf\
\x00\x00\x01\x8aE\xfa\xa6\x91\
+\x00\x00\x03\x98\x00\x00\x00\x00\x00\x01\x00\x06\x94o\
+\x00\x00\x01\x8e\xd1T\x9c\xe7\
\x00\x00\x01\xa6\x00\x00\x00\x00\x00\x01\x00\x06/\x9c\
\x00\x00\x01\x8aE\xfa\xa6\x92\
-\x00\x00\x04\x0c\x00\x00\x00\x00\x00\x01\x00\x06\x9e\x7f\
+\x00\x00\x04$\x00\x00\x00\x00\x00\x01\x00\x06\xa0\x10\
\x00\x00\x01\x8aE\xfa\xa6\x92\
-\x00\x00\x03\x98\x00\x02\x00\x00\x00\x09\x00\x00\x00O\
+\x00\x00\x03\xb0\x00\x02\x00\x00\x00\x09\x00\x00\x00Q\
\x00\x00\x00\x00\x00\x00\x00\x00\
-\x00\x00\x03~\x00\x02\x00\x00\x00-\x00\x00\x00\x22\
+\x00\x00\x03~\x00\x02\x00\x00\x00.\x00\x00\x00#\
\x00\x00\x00\x00\x00\x00\x00\x00\
\x00\x00\x02\x0a\x00\x00\x00\x00\x00\x01\x00\x065G\
\x00\x00\x01\x8aE\xfa\xa6\xa3\
-\x00\x00\x04<\x00\x00\x00\x00\x00\x01\x00\x06\xa1\x98\
+\x00\x00\x04T\x00\x00\x00\x00\x00\x01\x00\x06\xa3)\
\x00\x00\x01\x8aE\xfa\xa6\xa3\
-\x00\x00\x03\xc2\x00\x00\x00\x00\x00\x01\x00\x06\x94o\
+\x00\x00\x03\xda\x00\x00\x00\x00\x00\x01\x00\x06\x96\x00\
\x00\x00\x01\x8aE\xfa\xa6P\
\x00\x00\x02\xda\x00\x00\x00\x00\x00\x01\x00\x06T\x05\
\x00\x00\x01\x8aE\xfa\xa6P\
@@ -32122,113 +32196,115 @@
\x00\x00\x01\x8aE\xfa\xa6\xa3\
\x00\x00\x03\x02\x00\x00\x00\x00\x00\x01\x00\x06`G\
\x00\x00\x01\x8aE\xfa\xa6P\
-\x00\x00\x02R\x00\x00\x00\x00\x00\x01\x00\x07\x05\xa0\
+\x00\x00\x02R\x00\x00\x00\x00\x00\x01\x00\x07\x071\
\x00\x00\x01\x8aE\xfa\xa6q\
-\x00\x00\x0b\x18\x00\x00\x00\x00\x00\x01\x00\x07\xad\x12\
+\x00\x00\x0bZ\x00\x00\x00\x00\x00\x01\x00\x07\xb0\xb6\
\x00\x00\x01\x8aE\xfa\xa6\x82\
-\x00\x00\x06\x18\x00\x00\x00\x00\x00\x01\x00\x06\xebN\
+\x00\x00\x060\x00\x00\x00\x00\x00\x01\x00\x06\xec\xdf\
\x00\x00\x01\x8aE\xfa\xa6\x82\
-\x00\x00\x08\xba\x00\x00\x00\x00\x00\x01\x00\x07A\xae\
+\x00\x00\x08\xd2\x00\x00\x00\x00\x00\x01\x00\x07C?\
\x00\x00\x01\x8aE\xfa\xa6`\
-\x00\x00\x09\x16\x00\x00\x00\x00\x00\x01\x00\x07Vm\
+\x00\x00\x09X\x00\x00\x00\x00\x00\x01\x00\x07Z\x11\
\x00\x00\x01\x8aE\xfa\xa6`\
-\x00\x00\x06\xba\x00\x00\x00\x00\x00\x01\x00\x07\x03D\
+\x00\x00\x06\xd2\x00\x00\x00\x00\x00\x01\x00\x07\x04\xd5\
\x00\x00\x01\x8aE\xfa\xa6\x82\
-\x00\x00\x08>\x00\x00\x00\x00\x00\x01\x00\x07;\xea\
+\x00\x00\x08V\x00\x00\x00\x00\x00\x01\x00\x07={\
\x00\x00\x01\x8aE\xfa\xa6\x82\
-\x00\x00\x08\xf2\x00\x00\x00\x00\x00\x01\x00\x07T\xab\
+\x00\x00\x094\x00\x00\x00\x00\x00\x01\x00\x07XO\
\x00\x00\x01\x8aE\xfa\xa6q\
-\x00\x00\x0a2\x00\x00\x00\x00\x00\x01\x00\x07\x94\xae\
+\x00\x00\x0at\x00\x00\x00\x00\x00\x01\x00\x07\x98R\
\x00\x00\x01\x8aE\xfa\xa6q\
-\x00\x00\x07F\x00\x00\x00\x00\x00\x01\x00\x07\x17\xb0\
+\x00\x00\x07^\x00\x00\x00\x00\x00\x01\x00\x07\x19A\
\x00\x00\x01\x8aE\xfa\xa6\x82\
-\x00\x00\x06\xda\x00\x00\x00\x00\x00\x01\x00\x07\x08\xe0\
+\x00\x00\x06\xf2\x00\x00\x00\x00\x00\x01\x00\x07\x0aq\
\x00\x00\x01\x8aE\xfa\xa6q\
-\x00\x00\x08\x1e\x00\x00\x00\x00\x00\x01\x00\x07\x22\xda\
+\x00\x00\x08\xf2\x00\x00\x00\x00\x00\x01\x00\x07U\x1d\
+\x00\x00\x01\x8e\xd1T\x9c\xe6\
+\x00\x00\x086\x00\x00\x00\x00\x00\x01\x00\x07$k\
\x00\x00\x01\x8aE\xfa\xa6`\
-\x00\x00\x08`\x00\x00\x00\x00\x00\x01\x00\x07=\xf7\
+\x00\x00\x08x\x00\x00\x00\x00\x00\x01\x00\x07?\x88\
\x00\x00\x01\x8aE\xfa\xa6q\
-\x00\x00\x07\x98\x00\x00\x00\x00\x00\x01\x00\x07\x1d\xab\
+\x00\x00\x07\xb0\x00\x00\x00\x00\x00\x01\x00\x07\x1f<\
\x00\x00\x01\x8aE\xfa\xa6\x82\
-\x00\x00\x08\x94\x00\x00\x00\x00\x00\x01\x00\x07?S\
+\x00\x00\x08\xac\x00\x00\x00\x00\x00\x01\x00\x07@\xe4\
\x00\x00\x01\x8aE\xfa\xa6\x82\
-\x00\x00\x06>\x00\x00\x00\x00\x00\x01\x00\x06\xedW\
+\x00\x00\x06V\x00\x00\x00\x00\x00\x01\x00\x06\xee\xe8\
\x00\x00\x01\x8aE\xfa\xa6`\
-\x00\x00\x09d\x00\x00\x00\x00\x00\x01\x00\x07r\xb2\
+\x00\x00\x09\xa6\x00\x00\x00\x00\x00\x01\x00\x07vV\
\x00\x00\x01\x8aE\xfa\xa6`\
-\x00\x00\x07^\x00\x00\x00\x00\x00\x01\x00\x07\x19\xa3\
+\x00\x00\x07v\x00\x00\x00\x00\x00\x01\x00\x07\x1b4\
\x00\x00\x01\x8aE\xfa\xa6`\
-\x00\x00\x0a\x86\x00\x00\x00\x00\x00\x01\x00\x07\x97y\
+\x00\x00\x0a\xc8\x00\x00\x00\x00\x00\x01\x00\x07\x9b\x1d\
\x00\x00\x01\x8aE\xfa\xa6q\
-\x00\x00\x06\x02\x00\x00\x00\x00\x00\x01\x00\x06\xe8\xdf\
+\x00\x00\x06\x1a\x00\x00\x00\x00\x00\x01\x00\x06\xeap\
\x00\x00\x01\x8aE\xfa\xa6\x82\
-\x00\x00\x06\x98\x00\x00\x00\x00\x00\x01\x00\x06\xf5g\
+\x00\x00\x06\xb0\x00\x00\x00\x00\x00\x01\x00\x06\xf6\xf8\
\x00\x00\x01\x8aE\xfa\xa6`\
-\x00\x00\x07\xfa\x00\x00\x00\x00\x00\x01\x00\x07!x\
+\x00\x00\x08\x12\x00\x00\x00\x00\x00\x01\x00\x07#\x09\
\x00\x00\x01\x8aE\xfa\xa6`\
-\x00\x00\x06\xfe\x00\x00\x00\x00\x00\x01\x00\x07\x13\x93\
+\x00\x00\x07\x16\x00\x00\x00\x00\x00\x01\x00\x07\x15$\
\x00\x00\x01\x8aE\xfa\xa6`\
-\x00\x00\x0a\xd0\x00\x00\x00\x00\x00\x01\x00\x07\x9b;\
+\x00\x00\x0b\x12\x00\x00\x00\x00\x00\x01\x00\x07\x9e\xdf\
\x00\x00\x01\x8aE\xfa\xa6q\
-\x00\x00\x0aV\x00\x00\x00\x00\x00\x01\x00\x07\x96t\
+\x00\x00\x0a\x98\x00\x00\x00\x00\x00\x01\x00\x07\x9a\x18\
\x00\x00\x01\x8aE\xfa\xa6\x81\
-\x00\x00\x05\xe6\x00\x00\x00\x00\x00\x01\x00\x06\xe5\xba\
+\x00\x00\x05\xfe\x00\x00\x00\x00\x00\x01\x00\x06\xe7K\
\x00\x00\x01\x8aE\xfa\xa6q\
-\x00\x00\x07\x80\x00\x00\x00\x00\x00\x01\x00\x07\x1a\xd0\
+\x00\x00\x07\x98\x00\x00\x00\x00\x00\x01\x00\x07\x1ca\
\x00\x00\x01\x8aE\xfa\xa6`\
-\x00\x00\x09N\x00\x00\x00\x00\x00\x01\x00\x07p\xff\
+\x00\x00\x09\x90\x00\x00\x00\x00\x00\x01\x00\x07t\xa3\
\x00\x00\x01\x8aE\xfa\xa6`\
-\x00\x00\x0a\xf8\x00\x00\x00\x00\x00\x01\x00\x07\x9d\x96\
+\x00\x00\x0b:\x00\x00\x00\x00\x00\x01\x00\x07\xa1:\
\x00\x00\x01\x8aE\xfa\xa6`\
-\x00\x00\x09\xb8\x00\x00\x00\x00\x00\x01\x00\x07\x82E\
+\x00\x00\x09\xfa\x00\x00\x00\x00\x00\x01\x00\x07\x85\xe9\
\x00\x00\x01\x8aE\xfa\xa6\x82\
-\x00\x00\x08\xda\x00\x00\x00\x00\x00\x01\x00\x07S\x8c\
+\x00\x00\x09\x1c\x00\x00\x00\x00\x00\x01\x00\x07W0\
\x00\x00\x01\x8aE\xfa\xa6\x82\
-\x00\x00\x098\x00\x00\x00\x00\x00\x01\x00\x07d\xdb\
+\x00\x00\x09z\x00\x00\x00\x00\x00\x01\x00\x07h\x7f\
\x00\x00\x01\x8aE\xfa\xa6\x82\
-\x00\x00\x06\x84\x00\x00\x00\x00\x00\x01\x00\x06\xf0\xcd\
+\x00\x00\x06\x9c\x00\x00\x00\x00\x00\x01\x00\x06\xf2^\
\x00\x00\x01\x8aE\xfa\xa6`\
-\x00\x00\x09\xe4\x00\x00\x00\x00\x00\x01\x00\x07\x85\x07\
+\x00\x00\x0a&\x00\x00\x00\x00\x00\x01\x00\x07\x88\xab\
\x00\x00\x01\x8aE\xfa\xa6q\
-\x00\x00\x09\x88\x00\x00\x00\x00\x00\x01\x00\x07\x80\xaf\
+\x00\x00\x09\xca\x00\x00\x00\x00\x00\x01\x00\x07\x84S\
\x00\x00\x01\x8aE\xfa\xa6q\
-\x00\x00\x070\x00\x00\x00\x00\x00\x01\x00\x07\x15a\
+\x00\x00\x07H\x00\x00\x00\x00\x00\x01\x00\x07\x16\xf2\
\x00\x00\x01\x8aE\xfa\xa6`\
-\x00\x00\x09\xfc\x00\x00\x00\x00\x00\x01\x00\x07\x87Q\
+\x00\x00\x0a>\x00\x00\x00\x00\x00\x01\x00\x07\x8a\xf5\
\x00\x00\x01\x8aE\xfa\xa6`\
-\x00\x00\x06n\x00\x00\x00\x00\x00\x01\x00\x06\xef#\
+\x00\x00\x06\x86\x00\x00\x00\x00\x00\x01\x00\x06\xf0\xb4\
\x00\x00\x01\x8aE\xfa\xa6\x82\
-\x00\x00\x0a\x14\x00\x00\x00\x00\x00\x01\x00\x07\x88\xb7\
+\x00\x00\x0aV\x00\x00\x00\x00\x00\x01\x00\x07\x8c[\
\x00\x00\x01\x8aE\xfa\xa6`\
-\x00\x00\x07\xcc\x00\x01\x00\x00\x00\x01\x00\x07\x1f\x00\
+\x00\x00\x07\xe4\x00\x01\x00\x00\x00\x01\x00\x07 \x91\
\x00\x00\x01\x8aE\xfa\xa6\x82\
-\x00\x00\x07\xe6\x00\x00\x00\x00\x00\x01\x00\x07\x1f\xda\
+\x00\x00\x07\xfe\x00\x00\x00\x00\x00\x01\x00\x07!k\
\x00\x00\x01\x8aE\xfa\xa6q\
-\x00\x00\x0a\xaa\x00\x00\x00\x00\x00\x01\x00\x07\x99\x5c\
+\x00\x00\x0a\xec\x00\x00\x00\x00\x00\x01\x00\x07\x9d\x00\
\x00\x00\x01\x8aE\xfa\xa6p\
-\x00\x00\x04\xd8\x00\x00\x00\x00\x00\x01\x00\x07\x06\xaf\
+\x00\x00\x04\xf0\x00\x00\x00\x00\x00\x01\x00\x07\x08@\
\x00\x00\x01\x8aE\xfa\xa6q\
-\x00\x00\x05@\x00\x00\x00\x00\x00\x01\x00\x071X\
+\x00\x00\x05X\x00\x00\x00\x00\x00\x01\x00\x072\xe9\
\x00\x00\x01\x8aE\xfa\xa6`\
-\x00\x00\x05l\x00\x00\x00\x00\x00\x01\x00\x07f/\
+\x00\x00\x05\x84\x00\x00\x00\x00\x00\x01\x00\x07i\xd3\
\x00\x00\x01\x8aE\xfa\xa6`\
-\x00\x00\x05\x98\x00\x00\x00\x00\x00\x01\x00\x06\xe1\xa9\
+\x00\x00\x05\xb0\x00\x00\x00\x00\x00\x01\x00\x06\xe3:\
\x00\x00\x01\x8aE\xfa\xa6\x92\
-\x00\x00\x04\xf6\x00\x00\x00\x00\x00\x01\x00\x06\xc90\
+\x00\x00\x05\x0e\x00\x00\x00\x00\x00\x01\x00\x06\xca\xc1\
\x00\x00\x01\x8aE\xfa\xa6\x92\
-\x00\x00\x02\x80\x00\x00\x00\x00\x00\x01\x00\x06\xc5\x1e\
+\x00\x00\x02\x80\x00\x00\x00\x00\x00\x01\x00\x06\xc6\xaf\
\x00\x00\x01\x8aE\xfa\xa6\x92\
-\x00\x00\x04\xb6\x00\x00\x00\x00\x00\x01\x00\x06\xc3\x0b\
+\x00\x00\x04\xce\x00\x00\x00\x00\x00\x01\x00\x06\xc4\x9c\
\x00\x00\x01\x8aE\xfa\xa6\x92\
-\x00\x00\x05\xca\x00\x00\x00\x00\x00\x01\x00\x06\xe3{\
+\x00\x00\x05\xe2\x00\x00\x00\x00\x00\x01\x00\x06\xe5\x0c\
\x00\x00\x01\x8aE\xfa\xa6\x92\
-\x00\x00\x05\x10\x00\x00\x00\x00\x00\x01\x00\x06\xcb\xba\
+\x00\x00\x05(\x00\x00\x00\x00\x00\x01\x00\x06\xcdK\
\x00\x00\x01\x8aE\xfa\xa6\x92\
-\x00\x00\x04\xd8\x00\x00\x00\x00\x00\x01\x00\x06\xc6\xff\
+\x00\x00\x04\xf0\x00\x00\x00\x00\x00\x01\x00\x06\xc8\x90\
\x00\x00\x01\x8aE\xfa\xa6\x92\
-\x00\x00\x05@\x00\x00\x00\x00\x00\x01\x00\x06\xcem\
+\x00\x00\x05X\x00\x00\x00\x00\x00\x01\x00\x06\xcf\xfe\
\x00\x00\x01\x8aE\xfa\xa6\x92\
-\x00\x00\x05l\x00\x00\x00\x00\x00\x01\x00\x06\xd8'\
+\x00\x00\x05\x84\x00\x00\x00\x00\x00\x01\x00\x06\xd9\xb8\
\x00\x00\x01\x8aE\xfa\xa6\x92\
\x00\x00\x01&\x00\x01\x00\x00\x00\x01\x00\x03\x04\x82\
\x00\x00\x01\x8aE\xfa\xa6P\
diff --git a/spinetoolbox/resources_logos_rc.py b/spinetoolbox/resources_logos_rc.py
index a72f0e616..a4342862e 100644
--- a/spinetoolbox/resources_logos_rc.py
+++ b/spinetoolbox/resources_logos_rc.py
@@ -1,6 +1,7 @@
# Resource object code (Python 3)
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -8709,15 +8710,15 @@
\x00\x00\x00\x00\x00\x02\x00\x00\x00\x05\x00\x00\x00\x02\
\x00\x00\x00\x00\x00\x00\x00\x00\
\x00\x00\x00\x9a\x00\x00\x00\x00\x00\x01\x00\x00\x94\x9a\
-\x00\x00\x01y\x13P\x1f\xc5\
+\x00\x00\x01\x8aE\xfa\xa6?\
\x00\x00\x00p\x00\x00\x00\x00\x00\x01\x00\x00\x86\x0d\
-\x00\x00\x01y\x13P\x1f\xc4\
+\x00\x00\x01\x8aE\xfa\xa6/\
\x00\x00\x00 \x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\
-\x00\x00\x01y\x13P\x1f\xc3\
+\x00\x00\x01\x8aE\xfa\xa6/\
\x00\x00\x00\xc6\x00\x00\x00\x00\x00\x01\x00\x00\xd6\x82\
-\x00\x00\x01y#!\xbfm\
+\x00\x00\x01\x8aE\xfa\xa6?\
\x00\x00\x00R\x00\x00\x00\x00\x00\x01\x00\x00E\xca\
-\x00\x00\x01y\x13P\x1f\xc3\
+\x00\x00\x01\x8aE\xfa\xa6/\
"
def qInitResources():
diff --git a/spinetoolbox/server/__init__.py b/spinetoolbox/server/__init__.py
index 23c78291f..5d2780281 100644
--- a/spinetoolbox/server/__init__.py
+++ b/spinetoolbox/server/__init__.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Engine is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser
# General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your
@@ -9,6 +10,4 @@
# this program. If not, see .
######################################################################################################################
-"""
-Package for handling the client part of executing projects on Spine Engine Server.
-"""
+"""Package for handling the client part of executing projects on Spine Engine Server."""
diff --git a/spinetoolbox/server/engine_client.py b/spinetoolbox/server/engine_client.py
index fab6583db..018868f35 100644
--- a/spinetoolbox/server/engine_client.py
+++ b/spinetoolbox/server/engine_client.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Engine is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,10 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-Client for exchanging messages between the toolbox and the Spine Engine Server.
-"""
-
+"""Client for exchanging messages between the toolbox and the Spine Engine Server."""
import os
import time
import random
@@ -56,9 +54,9 @@ def __init__(self, host, port, sec_model, sec_folder, ping=True):
# implementation below based on https://github.com/zeromq/pyzmq/blob/main/examples/security/stonehouse.py
# prepare folders
base_dir = sec_folder
- secret_keys_dir = os.path.join(base_dir, 'private_keys')
- keys_dir = os.path.join(base_dir, 'certificates')
- public_keys_dir = os.path.join(base_dir, 'public_keys')
+ secret_keys_dir = os.path.join(base_dir, "private_keys")
+ keys_dir = os.path.join(base_dir, "certificates")
+ public_keys_dir = os.path.join(base_dir, "public_keys")
# We need two certificates, one for the client and one for
# the server. The client must know the server's public key
# to make a CURVE connection.
@@ -190,15 +188,15 @@ def stop_execution(self, job_id):
response_server_message = ServerMessage.parse(response[1])
return response_server_message.getData()
- def answer_prompt(self, job_id, item_name, accepted):
+ def answer_prompt(self, job_id, prompter_id, answer):
"""Sends a request to answer a prompt from the DAG that is managed by this client.
Args:
job_id (str): Job Id on server to stop
- item_name (str)
- accepted (Bool)
+ prompter_id (int)
+ answer
"""
- req = ServerMessage("answer_prompt", job_id, json.dumps((item_name, True)), None)
+ req = ServerMessage("answer_prompt", job_id, json.dumps((prompter_id, answer)), None)
self.socket.send_multipart([req.to_bytes()])
def download_files(self, q):
diff --git a/spinetoolbox/spine_db_commands.py b/spinetoolbox/spine_db_commands.py
index 7a9eacbd7..014002645 100644
--- a/spinetoolbox/spine_db_commands.py
+++ b/spinetoolbox/spine_db_commands.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,22 +10,12 @@
# this program. If not, see .
######################################################################################################################
-"""
-QUndoCommand subclasses for modifying the db.
-"""
-
+"""QUndoCommand subclasses for modifying the db."""
import time
-import uuid
-from collections import defaultdict
-
from PySide6.QtGui import QUndoCommand, QUndoStack
class AgedUndoStack(QUndoStack):
- def __init__(self, *args, **kwargs):
- super().__init__(*args, **kwargs)
- self._command_backup = []
-
@property
def redo_age(self):
if self.canRedo():
@@ -37,79 +28,47 @@ def undo_age(self):
return self.command(self.index() - 1).age
return -1
- def commands(self):
- return [self.command(i) for i in range(self.index())]
-
- def push(self, cmd):
- if self.cleanIndex() > self.index() and not self._command_backup:
- # Pushing the command will delete all undone commands.
- # We need to save all commands till the clean index.
- self._command_backup = [self.command(i).clone() for i in range(self.cleanIndex())]
- super().push(cmd)
-
- def commit(self):
- if self._command_backup:
- # Find index where backup and stack branch away
- branching_idx = next(
- (i for i in range(self.index()) if not self._command_backup[i].is_clone(self.command(i))), None
- )
- # Undo all backup commands from last till branching index
- for cmd in reversed(self._command_backup[branching_idx:]):
- cmd.undo()
- # Redo all commands from branching index till stack index
- for i in range(branching_idx, self.index()):
- self.command(i).redo()
- return
- if self.index() > self.cleanIndex():
- for i in range(self.cleanIndex(), self.index()):
- self.command(i).redo()
- elif self.index() < self.cleanIndex():
- for i in reversed(range(self.index(), self.cleanIndex())):
- self.command(i).undo()
-
- def setClean(self):
- self._command_backup = []
- super().setClean()
-
class AgedUndoCommand(QUndoCommand):
- def __init__(self, parent=None):
+ def __init__(self, parent=None, identifier=-1):
"""
Args:
parent (QUndoCommand, optional): The parent command, used for defining macros.
"""
super().__init__(parent=parent)
self._age = -1
- self.identifier = uuid.uuid4()
-
- def clone(self):
- """Clones the command.
+ self._id = identifier
+ self._buddies = []
+ self.merged = False
- Returns:
- AgedUndoCommand: cloned command
- """
- clone = self._do_clone()
- clone.identifier = self.identifier
- return clone
-
- def _do_clone(self):
- """Clones the command.
+ def id(self):
+ """override"""
+ return self._id
- Subclasses should reimplement this to clone their internal state.
+ def ours(self):
+ yield self
+ yield from self._buddies
- Returns:
- AgedUndoCommand: cloned command
- """
- raise NotImplementedError()
-
- def is_clone(self, other):
- return other.identifier == self.identifier
+ def mergeWith(self, command):
+ if not isinstance(command, AgedUndoCommand):
+ return False
+ self._buddies += [x for x in command.ours() if not x.isObsolete()]
+ command.merged = True
+ return True
def redo(self):
+ if self.merged:
+ return
super().redo()
+ for cmd in self._buddies:
+ cmd.redo()
self._age = time.time()
def undo(self):
+ if self.merged:
+ return
+ for cmd in reversed(self._buddies):
+ cmd.undo()
super().undo()
self._age = time.time()
@@ -118,309 +77,164 @@ def age(self):
return self._age
-class SpineDBMacro(AgedUndoCommand):
- """A command that just runs a series of SpineDBCommand's one after another, *waiting* for each one to finish
- before starting the next."""
-
- def __init__(self, cmd_iter, parent=None):
- super().__init__(parent=parent)
- self._cmd_iter = cmd_iter
- self._reverse_cmd_iter = None
- self._cmds = []
- self._completed_once = False
-
- def _do_clone(self):
- clone = SpineDBMacro([])
- clone._cmd_iter = self._cmd_iter
- clone._reverse_cmd_iter = self._reverse_cmd_iter
- clone._cmds = self._cmds
- clone._completed_once = self._completed_once
- return clone
-
- def redo(self):
- super().redo()
- if self._completed_once:
- self._cmd_iter = iter(self._cmds)
- self._redo_next()
-
- def _redo_next(self):
- child = next(self._cmd_iter, None)
- if child is None:
- self._completed_once = True
- return
- if not self._completed_once:
- self._cmds.append(child)
- child.redo_complete_callback = self._redo_next
- child.redo()
-
- def undo(self):
- super().undo()
- self._reverse_cmd_iter = reversed(self._cmds)
- self._undo_next()
-
- def _undo_next(self):
- child = next(self._reverse_cmd_iter, None)
- if child is None:
- return
- child.undo_complete_callback = self._undo_next
- child.undo()
-
-
class SpineDBCommand(AgedUndoCommand):
"""Base class for all commands that modify a Spine DB."""
- def __init__(self, db_mngr, db_map, parent=None):
+ def __init__(self, db_mngr, db_map, **kwargs):
"""
Args:
db_mngr (SpineDBManager): SpineDBManager instance
db_map (DiffDatabaseMapping): DiffDatabaseMapping instance
- parent (QUndoCommand, optional): The parent command, used for defining macros.
"""
- super().__init__(parent=parent)
+ super().__init__(**kwargs)
self.db_mngr = db_mngr
self.db_map = db_map
- self._done_once = False
- self.redo_complete_callback = lambda: None
- self.undo_complete_callback = lambda: None
-
- def handle_undo_complete(self, db_map_data):
- """Calls the undo complete callback with the data from undo().
-
- Subclasses need to pass this as the callback to the function that modifies the db in undo().
-
- Args:
- db_map_data (dict): mapping from database map to list of original cache items
- """
- self.undo_complete_callback()
-
- def handle_redo_complete(self, db_map_data):
- """Calls the redo complete callback with the data from redo().
-
- Subclasses need to pass this as the callback to the function that modifies the db in redo().
-
- Args:
- db_map_data (dict): mapping from database map to list of cache items
- """
- self.redo_complete_callback()
- if self._done_once:
- return
- self._done_once = True
- self._handle_first_redo_complete(db_map_data)
-
- def _handle_first_redo_complete(self, db_map_data):
- """Reimplement in subclasses to do stuff with the data from running redo() the first time.
-
- Args:
- db_map_data (dict): mapping from database map to list of original cache items
- """
- raise NotImplementedError()
class AddItemsCommand(SpineDBCommand):
- _add_command_name = {
- "object_class": "add object classes",
- "object": "add objects",
- "relationship_class": "add relationship classes",
- "relationship": "add relationships",
- "entity_group": "add entity groups",
- "parameter_definition": "add parameter definitions",
- "parameter_value": "add parameter values",
- "parameter_value_list": "add parameter value lists",
- "list_value": "add parameter value list values",
- "alternative": "add alternative",
- "scenario": "add scenario",
- "scenario_alternative": "add scenario alternative",
- "feature": "add feature",
- "tool": "add tool",
- "tool_feature": "add tool features",
- "tool_feature_method": "add tool feature methods",
- "metadata": "add metadata",
- "entity_metadata": "add entity metadata",
- "parameter_value_metadata": "add parameter value metadata",
- }
-
- def __init__(self, db_mngr, db_map, data, item_type, parent=None, check=True):
+ def __init__(self, db_mngr, db_map, item_type, data, check=True, **kwargs):
"""
Args:
db_mngr (SpineDBManager): SpineDBManager instance
db_map (DiffDatabaseMapping): DiffDatabaseMapping instance
data (list): list of dict-items to add
item_type (str): the item type
- parent (QUndoCommand, optional): The parent command, used for defining macros.
"""
- super().__init__(db_mngr, db_map, parent=parent)
+ super().__init__(db_mngr, db_map, **kwargs)
if not data:
self.setObsolete(True)
- self.redo_db_map_data = {db_map: data}
self.item_type = item_type
- self.undo_db_map_ids = None
- self._readd = False
+ self.redo_data = data
+ self.undo_ids = None
self._check = check
- self.setText(self._add_command_name.get(item_type, "add item") + f" to '{db_map.codename}'")
-
- def _do_clone(self):
- clone = AddItemsCommand(self.db_mngr, self.db_map, [], self.item_type)
- clone.redo_db_map_data = self.redo_db_map_data
- clone.undo_db_map_ids = self.undo_db_map_ids
- clone._readd = self._readd
- clone._check = self._check
- return clone
+ self.setText(f"add {item_type} items to {db_map.codename}")
def redo(self):
super().redo()
- successful = self.db_mngr.add_items(
- self.redo_db_map_data,
- self.item_type,
- readd=self._readd,
- cascade=False,
- check=self._check,
- callback=self.handle_redo_complete,
- )
- if not successful:
+ if self.undo_ids:
+ self.db_mngr.do_restore_items(self.db_map, self.item_type, self.undo_ids)
+ return
+ data = self.db_mngr.do_add_items(self.db_map, self.item_type, self.redo_data, check=self._check)
+ if not data:
self.setObsolete(True)
+ return
+ self.undo_ids = {x["id"] for x in data}
def undo(self):
super().undo()
- self.db_mngr.do_remove_items(self.item_type, self.undo_db_map_ids, callback=self.handle_undo_complete)
- self._readd = True
-
- def _handle_first_redo_complete(self, db_map_data):
- if self.db_map not in db_map_data:
- self.setObsolete(True)
- return
- self.redo_db_map_data = {db_map: [x.deepcopy() for x in data] for db_map, data in db_map_data.items()}
- self.undo_db_map_ids = {db_map: {x["id"] for x in data} for db_map, data in db_map_data.items()}
+ self.db_mngr.do_remove_items(self.db_map, self.item_type, self.undo_ids, check=False)
class UpdateItemsCommand(SpineDBCommand):
- _update_command_name = {
- "object_class": "update object classes",
- "object": "update objects",
- "relationship_class": "update relationship classes",
- "relationship": "update relationships",
- "parameter_definition": "update parameter definitions",
- "parameter_value": "update parameter values",
- "parameter_value_list": "update parameter value lists",
- "list_value": "update parameter value list values",
- "alternative": "update alternatives",
- "scenario": "update scenarios",
- "scenario_alternative": "update scenario alternative",
- "feature": "update features",
- "tool": "update tools",
- "tool_feature": "update tool features",
- "tool_feature_method": "update tool feature methods",
- "metadata": "update metadata",
- "entity_metadata": "update entity metadata",
- "parameter_value_metadata": "update parameter value metadata",
- }
-
- def __init__(self, db_mngr, db_map, data, item_type, parent=None, check=True):
+ def __init__(self, db_mngr, db_map, item_type, data, check=True, **kwargs):
"""
Args:
db_mngr (SpineDBManager): SpineDBManager instance
db_map (DiffDatabaseMapping): DiffDatabaseMapping instance
- data (list): list of dict-items to update
item_type (str): the item type
- parent (QUndoCommand, optional): The parent command, used for defining macros.
+ data (list): list of dict-items to update
"""
- super().__init__(db_mngr, db_map, parent=parent)
+ super().__init__(db_mngr, db_map, **kwargs)
if not data:
self.setObsolete(True)
- undo_data = [self.db_mngr.get_item(self.db_map, item_type, item["id"]).copy() for item in data]
- redo_data = [{**undo_item, **item} for undo_item, item in zip(undo_data, data)]
- if undo_data == redo_data:
- self.setObsolete(True)
- self.redo_db_map_data = {db_map: redo_data}
- self.undo_db_map_data = {db_map: undo_data}
self.item_type = item_type
+ self.redo_data = data
+ self.undo_data = [self.db_mngr.get_item(self.db_map, item_type, item["id"])._asdict() for item in data]
+ if self.redo_data == self.undo_data:
+ self.setObsolete(True)
self._check = check
- self.setText(self._update_command_name.get(item_type, "update item") + f" in '{db_map.codename}'")
-
- def _do_clone(self):
- clone = UpdateItemsCommand(self.db_mngr, self.db_map, [], self.item_type)
- clone.redo_db_map_data = self.redo_db_map_data
- clone.undo_db_map_data = self.undo_db_map_data
- clone._check = self._check
- return clone
+ self.setText(f"update {item_type} items in {db_map.codename}")
def redo(self):
super().redo()
- successful = self.db_mngr.update_items(
- self.redo_db_map_data, self.item_type, check=self._check, callback=self.handle_redo_complete
- )
- if not successful:
+ self.redo_data = [
+ x._asdict()
+ for x in self.db_mngr.do_update_items(self.db_map, self.item_type, self.redo_data, check=self._check)
+ ]
+ if not self.redo_data:
self.setObsolete(True)
+ return
+ self._check = False
def undo(self):
super().undo()
- self.db_mngr.update_items(
- self.undo_db_map_data, self.item_type, check=False, callback=self.handle_undo_complete
- )
+ self.db_mngr.do_update_items(self.db_map, self.item_type, self.undo_data, check=False)
+
- def _handle_first_redo_complete(self, db_map_data):
- if self.db_map not in db_map_data:
+class AddUpdateItemsCommand(SpineDBCommand):
+ def __init__(self, db_mngr, db_map, item_type, data, check=True, **kwargs):
+ """
+ Args:
+ db_mngr (SpineDBManager): SpineDBManager instance
+ db_map (DiffDatabaseMapping): DiffDatabaseMapping instance
+ item_type (str): the item type
+ data (list): list of dict-items to add-update
+ """
+ super().__init__(db_mngr, db_map, **kwargs)
+ if not data:
+ self.setObsolete(True)
+ self.item_type = item_type
+ self.new_data = data
+ old_data = [x._asdict() for item in data if (x := self.db_map.get_item(item_type, **item))]
+ if self.new_data == old_data:
self.setObsolete(True)
+ self.old_data = {x["id"]: x for x in old_data}
+ self.redo_restore_ids = None
+ self.redo_update_data = None
+ self.undo_remove_ids = None
+ self.undo_update_data = None
+ self.setText(f"update {item_type} items in {db_map.codename}")
+
+ def redo(self):
+ super().redo()
+ if self.redo_restore_ids is None:
+ added, updated = self.db_mngr.do_add_update_items(self.db_map, self.item_type, self.new_data)
+ if not added and not updated:
+ self.setObsolete(True)
+ return
+ self.redo_restore_ids = {x["id"] for x in added}
+ self.redo_update_data = [x._asdict() for x in updated]
+ self.undo_remove_ids = {x["id"] for x in added}
+ self.undo_update_data = [self.old_data[id_] for id_ in {x["id"] for x in updated}]
return
- self.redo_db_map_data = db_map_data
- self._check = False
+ if self.redo_restore_ids:
+ self.db_mngr.do_restore_items(self.db_map, self.item_type, self.redo_restore_ids)
+ if self.redo_update_data:
+ self.db_mngr.do_update_items(self.db_map, self.item_type, self.redo_update_data, check=False)
+
+ def undo(self):
+ super().undo()
+ if self.undo_remove_ids:
+ self.db_mngr.do_remove_items(self.db_map, self.item_type, self.undo_remove_ids, check=False)
+ if self.undo_update_data:
+ self.db_mngr.do_update_items(self.db_map, self.item_type, self.undo_update_data, check=False)
class RemoveItemsCommand(SpineDBCommand):
- def __init__(self, db_mngr, db_map, ids, item_type, parent=None):
+ def __init__(self, db_mngr, db_map, item_type, ids, check=True, **kwargs):
"""
Args:
db_mngr (SpineDBManager): SpineDBManager instance
db_map (DiffDatabaseMapping): DiffDatabaseMapping instance
- ids (set): set of ids to remove
item_type (str): the item type
- parent (QUndoCommand, optional): The parent command, used for defining macros.
+ ids (set): set of ids to remove
"""
- super().__init__(db_mngr, db_map, parent=parent)
+ super().__init__(db_mngr, db_map, **kwargs)
if not ids:
self.setObsolete(True)
- self.redo_db_map_ids = {db_map: ids}
- self.undo_data = {}
self.item_type = item_type
- self.setText(f"remove {item_type} items from '{db_map.codename}'")
-
- def _do_clone(self):
- clone = RemoveItemsCommand(self.db_mngr, self.db_map, set(), self.item_type)
- clone.redo_db_map_ids = self.redo_db_map_ids
- clone.undo_data = self.undo_data
- return clone
+ self.ids = ids
+ self._check = check
+ self.setText(f"remove {item_type} items from {db_map.codename}")
def redo(self):
super().redo()
- self.db_mngr.do_remove_items(
- self.item_type,
- self.redo_db_map_ids,
- callback=self.handle_redo_complete,
- committing_callback=self._update_undo_data,
- )
+ items = self.db_mngr.do_remove_items(self.db_map, self.item_type, self.ids, check=self._check)
+ if not items:
+ self.setObsolete(True)
+ self.ids = {x["id"] for x in items}
+ self._check = False
def undo(self):
super().undo()
- operations = list(self.undo_data.items())
- for item_type, items in operations[:-1]:
- self.db_mngr.add_items({self.db_map: items}, item_type, readd=True)
- item_type, items = operations[-1]
- self.db_mngr.add_items({self.db_map: items}, item_type, readd=True, callback=self.handle_undo_complete)
-
- def _handle_first_redo_complete(self, db_map_data):
- undo_data = defaultdict(list)
- for db_map, data in db_map_data.items():
- if db_map is not self.db_map:
- continue
- for item in data:
- undo_data[item.item_type].append(item)
- self.undo_data = undo_data
-
- def _update_undo_data(self, db_map_data):
- all_existing_ids = {item_type: {item["id"] for item in items} for item_type, items in self.undo_data.items()}
- for db_map, data in db_map_data.items():
- if db_map is not self.db_map:
- continue
- for item in data:
- existing_ids = all_existing_ids.get(item.item_type)
- if existing_ids is None or item["id"] not in existing_ids:
- self.undo_data[item.item_type].append(item)
+ self.db_mngr.do_restore_items(self.db_map, self.item_type, self.ids)
diff --git a/spinetoolbox/spine_db_editor/__init__.py b/spinetoolbox/spine_db_editor/__init__.py
index 5468070d5..bf113c065 100644
--- a/spinetoolbox/spine_db_editor/__init__.py
+++ b/spinetoolbox/spine_db_editor/__init__.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,6 +10,4 @@
# this program. If not, see .
######################################################################################################################
-"""
-This subpackage contains GUI files for the Spine db editor.
-"""
+"""This subpackage contains GUI files for the Spine db editor."""
diff --git a/spinetoolbox/spine_db_editor/graphics_items.py b/spinetoolbox/spine_db_editor/graphics_items.py
index 5ee5dc29c..9e309ce7c 100644
--- a/spinetoolbox/spine_db_editor/graphics_items.py
+++ b/spinetoolbox/spine_db_editor/graphics_items.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,10 +10,9 @@
# this program. If not, see .
######################################################################################################################
-"""
-Classes for drawing graphics items on graph view's QGraphicsScene.
-"""
-from PySide6.QtCore import Qt, Signal, Slot, QLineF
+"""Classes for drawing graphics items on graph view's QGraphicsScene."""
+from enum import Enum, auto
+from PySide6.QtCore import Qt, Signal, Slot, QLineF, QRectF, QPointF, QObject, QByteArray
from PySide6.QtSvgWidgets import QGraphicsSvgItem
from PySide6.QtWidgets import (
QGraphicsItem,
@@ -24,45 +24,14 @@
QApplication,
QMenu,
)
-from PySide6.QtGui import QPen, QBrush, QPainterPath, QPalette, QGuiApplication, QAction
-from matplotlib.figure import Figure
-from matplotlib.backends.backend_qt5agg import FigureCanvas # pylint: disable=no-name-in-module
-
-from spinetoolbox.helpers import DB_ITEM_SEPARATOR
+from PySide6.QtSvg import QSvgRenderer
+from PySide6.QtGui import QPen, QBrush, QPainterPath, QPalette, QGuiApplication, QAction, QColor
+from spinetoolbox.helpers import DB_ITEM_SEPARATOR, color_from_index
from spinetoolbox.widgets.custom_qwidgets import TitleWidgetAction
-def make_figure_graphics_item(scene, z=0, static=True):
- """Creates a FigureCanvas and adds it to the given scene.
- Used for creating heatmaps and associated colorbars.
-
- Args:
- scene (QGraphicsScene)
- z (int, optional): z value. Defaults to 0.
- static (bool, optional): if True (the default) the figure canvas is not movable
-
- Returns:
- QGraphicsProxyWidget: the graphics item that represents the canvas
- Figure: the figure in the canvas
- """
- figure = Figure(tight_layout={"pad": 0})
- axes = figure.gca(xmargin=0, ymargin=0, frame_on=None)
- axes.get_xaxis().set_visible(False)
- axes.get_yaxis().set_visible(False)
- canvas = FigureCanvas(figure)
- if static:
- proxy_widget = scene.addWidget(canvas)
- proxy_widget.setAcceptedMouseButtons(Qt.NoButton)
- else:
- proxy_widget = scene.addWidget(canvas, Qt.Window)
- proxy_widget.setZValue(z)
- return proxy_widget, figure
-
-
class EntityItem(QGraphicsRectItem):
- """Base class for ObjectItem and RelationshipItem."""
-
- def __init__(self, spine_db_editor, x, y, extent, db_map_ids):
+ def __init__(self, spine_db_editor, x, y, extent, db_map_ids, offset=None):
"""
Args:
spine_db_editor (SpineDBEditor): 'owner'
@@ -74,22 +43,23 @@ def __init__(self, spine_db_editor, x, y, extent, db_map_ids):
super().__init__()
self._spine_db_editor = spine_db_editor
self.db_mngr = spine_db_editor.db_mngr
+ self._given_extent = extent
self._db_map_ids = db_map_ids
+ self._offset = offset
+ self._dx = self._dy = 0
self._removed_db_map_ids = ()
- self.arc_items = list()
- self._extent = extent
- self.setRect(-0.5 * self._extent, -0.5 * self._extent, self._extent, self._extent)
+ self.arc_items = []
+ self._circle_item = QGraphicsEllipseItem(self)
+ self._circle_item.setPen(Qt.NoPen)
+ self.set_pos(x, y)
self.setPen(Qt.NoPen)
self._svg_item = QGraphicsSvgItem(self)
self._svg_item.setZValue(100)
self._svg_item.setCacheMode(QGraphicsItem.CacheMode.NoCache) # Needed for the exported pdf to be vector
self._renderer = None
- self.refresh_icon()
- self.setPos(x, y)
self._moved_on_scene = False
self._bg = None
- self._bg_brush = Qt.NoBrush
- self._init_bg()
+ self._bg_brush = None
self.setZValue(0)
self.setFlag(QGraphicsItem.ItemIsSelectable, enabled=True)
self.setFlag(QGraphicsItem.ItemIsMovable, enabled=True)
@@ -98,17 +68,27 @@ def __init__(self, spine_db_editor, x, y, extent, db_map_ids):
self.setAcceptHoverEvents(True)
self.setCursor(Qt.ArrowCursor)
self.setToolTip(self._make_tool_tip())
- self._highligh_color = Qt.transparent
-
- def _make_tool_tip(self):
- raise NotImplementedError()
-
- def default_parameter_data(self):
- raise NotImplementedError()
+ self._highlight_color = Qt.transparent
+ self._db_map_entity_class_lists = {}
+ self.label_item = EntityLabelItem(self)
+ self.label_item.setVisible(not self.has_dimensions)
+ self.setZValue(0.5 if not self.has_dimensions else 0.25)
+ self._extent = None
+ self.set_up()
+
+ def clone(self):
+ return type(self)(
+ self._spine_db_editor,
+ self.pos().x(),
+ self.pos().y(),
+ self._given_extent,
+ self._db_map_ids,
+ offset=self._offset,
+ )
@property
- def entity_type(self):
- raise NotImplementedError()
+ def has_dimensions(self):
+ return bool(self.element_id_list(self.first_db_map))
@property
def db_map_ids(self):
@@ -119,23 +99,46 @@ def original_db_map_ids(self):
return self._db_map_ids
@property
- def entity_class_type(self):
- return {"relationship": "relationship_class", "object": "object_class"}[self.entity_type]
-
- @property
- def entity_name(self):
- return self.db_mngr.get_item(self.first_db_map, self.entity_type, self.first_id).get("name", "")
+ def name(self):
+ return self.db_mngr.get_item(self.first_db_map, "entity", self.first_id).get("name", "")
@property
def first_entity_class_id(self):
- return self.db_mngr.get_item(self.first_db_map, self.entity_type, self.first_id).get("class_id")
+ return self.db_mngr.get_item(self.first_db_map, "entity", self.first_id).get("class_id")
@property
def entity_class_name(self):
- return self.db_mngr.get_item(self.first_db_map, self.entity_class_type, self.first_entity_class_id).get(
- "name", ""
+ return self.db_mngr.get_item(self.first_db_map, "entity_class", self.first_entity_class_id).get("name", "")
+
+ @property
+ def dimension_id_list(self):
+ # FIXME: is this used?
+ return self.db_mngr.get_item(self.first_db_map, "entity_class", self.first_entity_class_id).get(
+ "dimension_id_list", ()
+ )
+
+ @property
+ def dimension_name_list(self):
+ return self.db_mngr.get_item(self.first_db_map, "entity_class", self.first_entity_class_id).get(
+ "dimension_name_list", ()
)
+ @property
+ def byname(self):
+ return self.db_mngr.get_item(self.first_db_map, "entity", self.first_id).get("entity_byname", ())
+
+ @property
+ def element_name_list(self):
+ return self.db_mngr.get_item(self.first_db_map, "entity", self.first_id).get("element_name_list", ())
+
+ def element_id_list(self, db_map):
+ return self.db_mngr.get_item(db_map, "entity", self.entity_id(db_map)).get("element_id_list", ())
+
+ @property
+ def element_byname_list(self):
+ # NOTE: Needed by EditEntitiesDialog
+ return self.db_mngr.get_item(self.first_db_map, "entity", self.first_id).get("element_byname_list", ())
+
@property
def first_db_map_id(self):
return next(iter(self.db_map_ids), (None, None))
@@ -150,7 +153,7 @@ def first_db_map(self):
@property
def display_data(self):
- return self.entity_name
+ return self.name
@property
def display_database(self):
@@ -161,59 +164,225 @@ def db_maps(self):
return list(db_map for db_map, _id in self.db_map_ids)
def entity_class_id(self, db_map):
- return self.db_mngr.get_item(db_map, self.entity_type, self.entity_id(db_map)).get("class_id")
+ return self.db_mngr.get_item(db_map, "entity", self.entity_id(db_map)).get("class_id")
+
+ def entity_class_ids(self, db_map):
+ return {self.entity_class_id(db_map)} | {
+ x["superclass_id"]
+ for x in db_map.get_items("superclass_subclass", subclass_id=self.entity_class_id(db_map))
+ }
def entity_id(self, db_map):
return dict(self.db_map_ids).get(db_map)
def db_map_data(self, db_map):
- # NOTE: Needed by EditObjectsDialog and EditRelationshipsDialog
- return self.db_mngr.get_item(db_map, self.entity_type, self.entity_id(db_map))
+ # NOTE: Needed by EditEntitiesDialog
+ return self.db_mngr.get_item(db_map, "entity", self.entity_id(db_map))
def db_map_id(self, db_map):
- # NOTE: Needed by EditObjectsDialog and EditRelationshipsDialog
+ # NOTE: Needed by EditEntitiesDialog
return self.entity_id(db_map)
+ def db_items(self, db_map):
+ for db_map_, id_ in self.db_map_ids:
+ if db_map_ == db_map:
+ yield dict(class_id=self.entity_class_id(db_map), id=id_)
+
def boundingRect(self):
return super().boundingRect() | self.childrenBoundingRect()
- def moveBy(self, dx, dy):
- super().moveBy(dx, dy)
+ def set_pos(self, x, y):
+ x, y = self._snap(x, y)
+ self.setPos(x, y)
self.update_arcs_line()
- def _init_bg(self):
- self._bg = QGraphicsRectItem(self.boundingRect(), self)
- self._bg.setFlag(QGraphicsItem.ItemStacksBehindParent, enabled=True)
+ def move_by(self, dx, dy):
+ self._dx += dx
+ self._dy += dy
+ dx, dy = self._snap(self._dx, self._dy)
+ if dx == dy == 0:
+ return
+ self.moveBy(dx, dy)
+ self._dx -= dx
+ self._dy -= dy
+ self.update_arcs_line()
+ ent_items = {arc_item.ent_item for arc_item in self.arc_items}
+ for ent_item in ent_items:
+ ent_item.update_entity_pos()
+
+ def _snap(self, x, y):
+ if self._spine_db_editor.qsettings.value("appSettings/snapEntities", defaultValue="false") != "true":
+ return (x, y)
+ grid_size = self._given_extent
+ x = round(x / grid_size) * grid_size
+ y = round(y / grid_size) * grid_size
+ return (x, y)
+
+ def has_unique_key(self):
+ """Returns whether or not the item still has a single key in all the databases it represents.
+
+ Returns:
+ bool
+ """
+ db_map_ids_by_key = {}
+ for db_map_id in self.db_map_ids:
+ key = self._spine_db_editor.get_entity_key(db_map_id)
+ db_map_ids_by_key.setdefault(key, []).append(db_map_id)
+ if len(db_map_ids_by_key) == 1:
+ return True
+ first_key = next(iter(db_map_ids_by_key))
+ self._db_map_ids = tuple(db_map_ids_by_key[first_key])
+ return False
+
+ def _get_name(self):
+ for db_map, id_ in self.db_map_ids:
+ name = self._spine_db_editor.get_item_name(db_map, id_)
+ if isinstance(name, str):
+ return name
+
+ def _get_prop(self, getter, index):
+ values = {getter(db_map, id_, index) for db_map, id_ in self.db_map_ids}
+ values.discard(None)
+ if not values:
+ return None
+ values.discard(self._spine_db_editor.NOT_SPECIFIED)
+ if not values:
+ return self._spine_db_editor.NOT_SPECIFIED
+ return next(iter(values))
+
+ def _get_color(self, index=None):
+ color = self._get_prop(self._spine_db_editor.get_item_color, index)
+ if color in (None, self._spine_db_editor.NOT_SPECIFIED):
+ return color
+ min_val, val, max_val = color
+ count = max(1, max_val - min_val)
+ k = val - min_val
+ return color_from_index(k, count)
+
+ def _get_arc_width(self, index=None):
+ arc_width = self._get_prop(self._spine_db_editor.get_arc_width, index)
+ if arc_width in (None, self._spine_db_editor.NOT_SPECIFIED):
+ return arc_width
+ min_val, val, max_val = arc_width
+ range_ = max_val - min_val
+ if range_ == 0:
+ return None
+ if val > 0:
+ return val / max_val, 1
+ return val / min_val, -1
+
+ def _get_vertex_radius(self, index=None):
+ vertex_radius = self._get_prop(self._spine_db_editor.get_vertex_radius, index)
+ if vertex_radius in (None, self._spine_db_editor.NOT_SPECIFIED):
+ return None
+ min_val, val, max_val = vertex_radius
+ range_ = max_val - min_val
+ if range_ == 0:
+ return 0
+ return (val - min_val) / range_
+
+ def _has_name(self):
+ return True
+
+ def set_up(self):
+ if self._has_name():
+ name = self._get_name()
+ if not name:
+ self.label_item.hide()
+ self._extent = 0.2 * self._given_extent
+ else:
+ if not self.has_dimensions:
+ self.label_item.show()
+ self.label_item.setPlainText(name)
+ self._extent = self._given_extent
+ else:
+ self.label_item.hide()
+ self._extent = 0.5 * self._given_extent
+ else:
+ self.label_item.hide()
+ self._extent = self._given_extent
+ self.setRect(-0.5 * self._extent, -0.5 * self._extent, self._extent, self._extent)
+ self._update_bg()
+ self.refresh_icon()
+ self.update_entity_pos()
+
+ def update_props(self, index):
+ color = self._get_color(index)
+ arc_width = self._get_arc_width(index)
+ vertex_radius = self._get_vertex_radius(index)
+ self._update_renderer(color, resize=True)
+ self._update_arcs(color, arc_width)
+ self._update_circle(color, vertex_radius)
+
+ def _update_bg(self):
+ bg_rect = QRectF(-0.5 * self._extent, -0.5 * self._extent, self._extent, self._extent)
+ if self._bg is not None:
+ self._bg.setRect(bg_rect)
+ self._bg.prepareGeometryChange()
+ self._bg.update()
+ return
+ if not self.has_dimensions:
+ self._bg = QGraphicsRectItem(bg_rect, self)
+ self._bg_brush = Qt.NoBrush
+ else:
+ self._bg = QGraphicsEllipseItem(bg_rect, self)
+ self._bg_brush = QGuiApplication.palette().button()
pen = self._bg.pen()
pen.setColor(Qt.transparent)
self._bg.setPen(pen)
+ self._bg.setFlag(QGraphicsItem.ItemStacksBehindParent, enabled=True)
def refresh_icon(self):
"""Refreshes the icon."""
- renderer = self.db_mngr.entity_class_renderer(
- self.first_db_map, self.entity_class_type, self.first_entity_class_id
- )
- self._set_renderer(renderer)
-
- def _set_renderer(self, renderer):
- self._renderer = renderer
- self._svg_item.setSharedRenderer(renderer)
- size = renderer.defaultSize()
+ color = self._get_color()
+ self._update_renderer(color)
+
+ def _update_renderer(self, color, resize=True):
+ if color is self._spine_db_editor.NOT_SPECIFIED:
+ color = color_from_index(0, 1, value=0)
+ self._renderer = self.db_mngr.entity_class_renderer(self.first_db_map, self.first_entity_class_id, color=color)
+ self._install_renderer()
+
+ def _install_renderer(self, resize=True):
+ self._svg_item.setSharedRenderer(self._renderer)
+ if not resize:
+ return
+ size = self._renderer.defaultSize()
scale = self._extent / max(size.width(), size.height())
self._svg_item.setScale(scale)
rect = self._svg_item.boundingRect()
self._svg_item.setTransformOriginPoint(rect.center())
self._svg_item.setPos(-rect.center())
+ def _make_tool_tip(self):
+ if not self.first_id:
+ return None
+ return (
+ f"""{self.entity_class_name}
"""
+ f"""{DB_ITEM_SEPARATOR.join(self.byname)}
"""
+ f"""@{self.display_database}
"""
+ )
+
+ def default_parameter_data(self):
+ """Return data to put as default in a parameter table when this item is selected."""
+ if not self.db_map_ids:
+ return {}
+ return dict(
+ entity_class_name=self.entity_class_name,
+ entity_byname=DB_ITEM_SEPARATOR.join(self.byname),
+ database=self.first_db_map.codename,
+ )
+
def shape(self):
"""Returns a shape containing the entire bounding rect, to work better with icon transparency."""
path = QPainterPath()
path.setFillRule(Qt.WindingFill)
path.addRect(self._bg.boundingRect())
+ path.addPolygon(self.label_item.mapToItem(self, self.label_item.boundingRect()))
return path
- def set_highligh_color(self, color):
- self._highligh_color = color
+ def set_highlight_color(self, color):
+ self._highlight_color = color
def paint(self, painter, option, widget=None):
"""Shows or hides the selection halo."""
@@ -223,8 +392,8 @@ def paint(self, painter, option, widget=None):
else:
self._paint_as_deselected()
pen = self._bg.pen()
- pen.setColor(self._highligh_color)
- width = 10 / self.scale()
+ pen.setColor(self._highlight_color)
+ width = max(1, 10 / self.scale())
pen.setWidth(width)
self._bg.setPen(pen)
super().paint(painter, option, widget)
@@ -242,7 +411,34 @@ def add_arc_item(self, arc_item):
arc_item (ArcItem)
"""
self.arc_items.append(arc_item)
- arc_item.update_line()
+ self._rotate_svg_item()
+ self.update_entity_pos()
+
+ def update_entity_pos(self):
+ for arc_item in self.arc_items:
+ arc_item.ent_item.do_update_entity_pos()
+ self.do_update_entity_pos()
+
+ def do_update_entity_pos(self):
+ el_items = sorted(
+ (arc_item.el_item for arc_item in self.arc_items if arc_item.el_item is not self),
+ key=lambda x: x.entity_id(x.first_db_map) or 0,
+ )
+ dim_count = len(el_items)
+ if not dim_count:
+ return
+ new_pos_x = sum(el_item.pos().x() for el_item in el_items) / dim_count
+ new_pos_y = sum(el_item.pos().y() for el_item in el_items) / dim_count
+ offset = self._offset.value() if self._offset is not None else None
+ if offset:
+ el_item = el_items[0]
+ line = QLineF(QPointF(new_pos_x, new_pos_y), el_item.pos()).normalVector()
+ if offset < 0:
+ line.setAngle(line.angle() + 180)
+ line.setLength(3 * abs(offset) * self._extent)
+ new_pos_x, new_pos_y = line.x2(), line.y2()
+ self.setPos(new_pos_x, new_pos_y)
+ self.update_arcs_line()
def apply_zoom(self, factor):
"""Applies zoom.
@@ -250,8 +446,7 @@ def apply_zoom(self, factor):
Args:
factor (float): The zoom factor.
"""
- if factor > 1:
- factor = 1
+ factor = min(factor, 1)
self.setScale(factor)
def apply_rotation(self, angle, center):
@@ -263,11 +458,8 @@ def apply_rotation(self, angle, center):
"""
line = QLineF(center, self.pos())
line.setAngle(line.angle() + angle)
- self.setPos(line.p2())
- self.update_arcs_line()
-
- def block_move_by(self, dx, dy):
- self.moveBy(dx, dy)
+ pos = line.p2()
+ self.set_pos(pos.x(), pos.y())
def mouseMoveEvent(self, event):
"""Moves the item and all connected arcs.
@@ -278,20 +470,48 @@ def mouseMoveEvent(self, event):
if event.buttons() & Qt.LeftButton == 0:
super().mouseMoveEvent(event)
return
- move_by = event.scenePos() - event.lastScenePos()
+ delta = event.scenePos() - event.lastScenePos()
# Move selected items together
for item in self.scene().selectedItems():
if isinstance(item, (EntityItem)):
- item.block_move_by(move_by.x(), move_by.y())
+ item.move_by(delta.x(), delta.y())
def update_arcs_line(self):
"""Moves arc items."""
for item in self.arc_items:
item.update_line()
+ color = self._get_color()
+ arc_width = self._get_arc_width()
+ self._update_arcs(color, arc_width)
+
+ def _update_arcs(self, color, arc_width):
+ if color not in (None, self._spine_db_editor.NOT_SPECIFIED):
+ for item in self.arc_items:
+ item.update_color(color)
+ if arc_width not in (None, self._spine_db_editor.NOT_SPECIFIED):
+ width, sign = arc_width
+ factor = 0.75 * (0.5 + 0.5 * width) * self._extent
+ switched = False
+ for item in self.arc_items:
+ item.apply_value(factor, sign)
+ if not switched:
+ switched = True
+ sign = -sign
+
+ def _update_circle(self, color, vertex_radius):
+ if color is self._spine_db_editor.NOT_SPECIFIED:
+ color = color_from_index(0, 1, value=0)
+ else:
+ color = QColor(color)
+ circle_extent = 2 * (0.5 + 0.5 * vertex_radius) * self._extent if vertex_radius is not None else 0
+ self._circle_item.setRect(-circle_extent / 2, -circle_extent / 2, circle_extent, circle_extent)
+ color.setAlphaF(0.5)
+ self._circle_item.setBrush(color)
def itemChange(self, change, value):
"""
- Keeps track of item's movements on the scene.
+ Keeps track of item's movements on the scene. Rotates svg item if the relationship is 2D.
+ This makes it possible to define e.g. an arow icon for relationships that express direction.
Args:
change (GraphicsItemChange): a flag signalling the type of the change
@@ -302,7 +522,8 @@ def itemChange(self, change, value):
"""
if change == QGraphicsItem.ItemScenePositionHasChanged:
self._moved_on_scene = True
- return value
+ self._rotate_svg_item()
+ return super().itemChange(change, value)
def setVisible(self, on):
"""Sets visibility status for this item and all arc items.
@@ -312,10 +533,27 @@ def setVisible(self, on):
"""
super().setVisible(on)
for arc_item in self.arc_items:
- arc_item.setVisible(arc_item.obj_item.isVisible() and arc_item.rel_item.isVisible())
+ arc_item.setVisible(arc_item.el_item.isVisible() and arc_item.ent_item.isVisible())
def _make_menu(self):
- return self._spine_db_editor.ui.graphicsView.make_items_menu()
+ menu = self._spine_db_editor.ui.graphicsView.make_items_menu()
+ expand_menu = QMenu("Expand", menu)
+ expand_menu.triggered.connect(self._expand)
+ collapse_menu = QMenu("Collapse", menu)
+ collapse_menu.triggered.connect(self._collapse)
+ connect_entities_menu = QMenu("Connect entities", menu)
+ connect_entities_menu.triggered.connect(self._start_connecting_entities)
+ self._refresh_db_map_entity_class_lists()
+ self._populate_expand_collapse_menu(expand_menu)
+ self._populate_expand_collapse_menu(collapse_menu)
+ self._populate_connect_entities_menu(connect_entities_menu)
+ first = menu.actions()[0]
+ first = menu.insertSeparator(first)
+ first = menu.insertMenu(first, connect_entities_menu)
+ first = menu.insertMenu(first, collapse_menu)
+ menu.insertMenu(first, expand_menu)
+ menu.addAction("Duplicate", self._duplicate)
+ return menu
def contextMenuEvent(self, e):
"""Shows context menu.
@@ -343,217 +581,49 @@ def add_db_map_ids(self, db_map_ids):
self._removed_db_map_ids = tuple(x for x in self._removed_db_map_ids if x != db_map_id)
self.setToolTip(self._make_tool_tip())
-
-class RelationshipItem(EntityItem):
- """Represents a relationship in the Entity graph."""
-
- def __init__(self, spine_db_editor, x, y, extent, db_map_ids):
- """Initializes the item.
-
- Args:
- spine_db_editor (GraphViewForm): 'owner'
- x (float): x-coordinate of central point
- y (float): y-coordinate of central point
- extent (int): preferred extent
- db_map_ids (tuple): tuple of (db_map, id) tuples
- """
- super().__init__(spine_db_editor, x, y, extent, db_map_ids=db_map_ids)
-
- def default_parameter_data(self):
- """Return data to put as default in a parameter table when this item is selected."""
- if not self.db_map_ids:
- return {}
- return dict(
- relationship_class_name=self.entity_class_name,
- object_name_list=DB_ITEM_SEPARATOR.join(self.object_name_list),
- database=self.first_db_map.codename,
- )
-
- @property
- def entity_type(self):
- return "relationship"
-
- @property
- def object_class_id_list(self):
- # FIXME: where is this used?
- return self.db_mngr.get_item(self.first_db_map, "relationship_class", self.first_entity_class_id).get(
- "object_class_id_list"
- )
-
- @property
- def object_name_list(self):
- return self.db_mngr.get_item(self.first_db_map, "relationship", self.first_id).get("object_name_list", "")
-
- def object_id_list(self, db_map):
- return self.db_mngr.get_item(db_map, "relationship", self.entity_id(db_map)).get("object_id_list")
-
- def db_representation(self, db_map):
- return dict(
- class_id=self.entity_class_id(db_map),
- id=self.entity_id(db_map),
- object_id_list=self.object_id_list(db_map),
- object_name_list=self.object_name_list,
- )
-
- def _make_tool_tip(self):
- if not self.first_id:
- return None
- return (
- f"""{self.entity_class_name}
"""
- f"""{DB_ITEM_SEPARATOR.join(self.object_name_list)}
"""
- f"""@{self.display_database}
"""
- )
-
- def _init_bg(self):
- extent = self._extent
- self._bg = QGraphicsEllipseItem(-0.5 * extent, -0.5 * extent, extent, extent, self)
- self._bg.setPen(Qt.NoPen)
- self._bg_brush = QGuiApplication.palette().button()
-
- def follow_object_by(self, dx, dy):
- factor = 1.0 / len(set(arc.obj_item for arc in self.arc_items))
- self.moveBy(factor * dx, factor * dy)
-
- def add_arc_item(self, arc_item):
- super().add_arc_item(arc_item)
- self._rotate_svg_item()
-
- def itemChange(self, change, value):
- """Rotates svg item if the relationship is 2D.
- This makes it possible to define e.g. an arow icon for relationships that express direction.
- """
- if change == QGraphicsItem.ItemScenePositionHasChanged:
- self._rotate_svg_item()
- return super().itemChange(change, value)
-
def _rotate_svg_item(self):
- if len(self.arc_items) != 2:
+ arc_items_as_ent = [x for x in self.arc_items if x.ent_item is self]
+ if len(arc_items_as_ent) != 2 or self.first_id is None:
self._svg_item.setRotation(0)
return
- arc1, arc2 = self.arc_items # pylint: disable=unbalanced-tuple-unpacking
- obj1, obj2 = arc1.obj_item, arc2.obj_item
- line = QLineF(obj1.pos(), obj2.pos())
+ first_dimension = self.dimension_name_list[0]
+ element1 = arc_items_as_ent[0].el_item
+ element2 = arc_items_as_ent[1].el_item
+ if element1.entity_class_name == first_dimension:
+ start = element1.pos()
+ end = element2.pos()
+ else:
+ start = element2.pos()
+ end = element1.pos()
+ line = QLineF(start, end)
self._svg_item.setRotation(-line.angle())
-
-class ObjectItem(EntityItem):
- """Represents an object in the Entity graph."""
-
- def __init__(self, spine_db_editor, x, y, extent, db_map_ids):
- """Initializes the item.
-
- Args:
- spine_db_editor (GraphViewForm): 'owner'
- x (float): x-coordinate of central point
- y (float): y-coordinate of central point
- extent (int): preferred extent
- db_map_ids (tuple): tuple of (db_map, id) tuples
- """
- super().__init__(spine_db_editor, x, y, extent, db_map_ids=db_map_ids)
- self._db_map_relationship_class_lists = {}
- self.label_item = ObjectLabelItem(self)
- self.setZValue(0.5)
- self.update_name()
-
- def default_parameter_data(self):
- """Return data to put as default in a parameter table when this item is selected."""
- if not self.db_map_ids:
- return {}
- return dict(
- object_class_name=self.entity_class_name, object_name=self.entity_name, database=self.first_db_map.codename
- )
-
- @property
- def entity_type(self):
- return "object"
-
- def db_representation(self, db_map):
- return dict(class_id=self.entity_class_id(db_map), id=self.entity_id(db_map), name=self.entity_name)
-
- def shape(self):
- path = super().shape()
- path.addPolygon(self.label_item.mapToItem(self, self.label_item.boundingRect()))
- return path
-
- def update_name(self):
- """Refreshes the name."""
- db_map_ids_by_name = dict()
- for db_map, id_ in self.db_map_ids:
- name = self.db_mngr.get_item(db_map, self.entity_type, id_)["name"]
- db_map_ids_by_name.setdefault(name, list()).append((db_map, id_))
- if len(db_map_ids_by_name) == 1:
- name = next(iter(db_map_ids_by_name))
- self.label_item.setPlainText(name)
- return True
- current_name = self.label_item.toPlainText()
- self._db_map_ids = tuple(db_map_ids_by_name.get(current_name, ()))
- return False
-
- def _make_tool_tip(self):
- if not self.first_id:
- return None
- return f"{self.entity_name}
@{self.display_database}"
-
- def block_move_by(self, dx, dy):
- super().block_move_by(dx, dy)
- rel_items_follow = self._spine_db_editor.qsettings.value(
- "appSettings/relationshipItemsFollow", defaultValue="true"
- )
- if rel_items_follow == "false":
- return
- rel_items = {arc_item.rel_item for arc_item in self.arc_items}
- for rel_item in rel_items:
- if rel_item.isSelected():
- # The item will move with the selection, so no need to follow the objects
- continue
- rel_item.follow_object_by(dx, dy)
-
def mouseDoubleClickEvent(self, e):
- add_relationships_menu = QMenu(self._spine_db_editor)
- title = TitleWidgetAction("Add relationships", self._spine_db_editor)
- add_relationships_menu.addAction(title)
- add_relationships_menu.triggered.connect(self._start_relationship)
- self._refresh_relationship_classes()
- self._populate_add_relationships_menu(add_relationships_menu)
- add_relationships_menu.popup(e.screenPos())
-
- def _make_menu(self):
- menu = super()._make_menu()
- expand_menu = QMenu("Expand", menu)
- expand_menu.triggered.connect(self._expand)
- collapse_menu = QMenu("Collapse", menu)
- collapse_menu.triggered.connect(self._collapse)
- add_relationships_menu = QMenu("Add relationships", menu)
- add_relationships_menu.triggered.connect(self._start_relationship)
- self._refresh_relationship_classes()
- self._populate_expand_collapse_menu(expand_menu)
- self._populate_expand_collapse_menu(collapse_menu)
- self._populate_add_relationships_menu(add_relationships_menu)
- first = menu.actions()[0]
- first = menu.insertSeparator(first)
- first = menu.insertMenu(first, add_relationships_menu)
- first = menu.insertMenu(first, collapse_menu)
- menu.insertMenu(first, expand_menu)
- menu.addAction("Duplicate", self._duplicate)
- return menu
+ connect_entities_menu = QMenu(self._spine_db_editor)
+ title = TitleWidgetAction("Connect entities", self._spine_db_editor)
+ connect_entities_menu.addAction(title)
+ connect_entities_menu.triggered.connect(self._start_connecting_entities)
+ self._refresh_db_map_entity_class_lists()
+ self._populate_connect_entities_menu(connect_entities_menu)
+ connect_entities_menu.popup(e.screenPos())
def _duplicate(self):
- self._spine_db_editor.duplicate_object(self)
-
- def _refresh_relationship_classes(self):
- self._db_map_relationship_class_lists.clear()
- db_map_object_ids = {db_map: {id_} for db_map, id_ in self.db_map_ids}
- relationship_ids_per_class = {}
- for db_map, rels in self.db_mngr.find_cascading_relationships(db_map_object_ids).items():
- for rel in rels:
- relationship_ids_per_class.setdefault((db_map, rel["class_id"]), set()).add(rel["id"])
- db_map_object_class_ids = {db_map: {self.entity_class_id(db_map)} for db_map in self.db_maps}
- for db_map, rel_clss in self.db_mngr.find_cascading_relationship_classes(db_map_object_class_ids).items():
- for rel_cls in rel_clss:
- rel_cls = rel_cls.copy()
- rel_cls["object_class_id_list"] = list(rel_cls["object_class_id_list"])
- rel_cls["relationship_ids"] = relationship_ids_per_class.get((db_map, rel_cls["id"]), set())
- self._db_map_relationship_class_lists.setdefault(rel_cls["name"], []).append((db_map, rel_cls))
+ self._spine_db_editor.duplicate_entity(self)
+
+ def _refresh_db_map_entity_class_lists(self):
+ self._db_map_entity_class_lists.clear()
+ db_map_entity_ids = {db_map: {id_} for db_map, id_ in self.db_map_ids}
+ entity_ids_per_class = {}
+ for db_map, ents in self.db_mngr.find_cascading_entities(db_map_entity_ids).items():
+ for ent in ents:
+ entity_ids_per_class.setdefault((db_map, ent["class_id"]), set()).add(ent["id"])
+ db_map_entity_class_ids = {db_map: self.entity_class_ids(db_map) for db_map in self.db_maps}
+ for db_map, ent_clss in self.db_mngr.find_cascading_entity_classes(db_map_entity_class_ids).items():
+ for ent_cls in ent_clss:
+ ent_cls = ent_cls._extended()
+ ent_cls["dimension_id_list"] = list(ent_cls["dimension_id_list"])
+ ent_cls["entity_ids"] = entity_ids_per_class.get((db_map, ent_cls["id"]), set())
+ self._db_map_entity_class_lists.setdefault(ent_cls["name"], []).append((db_map, ent_cls))
def _populate_expand_collapse_menu(self, menu):
"""
@@ -562,102 +632,110 @@ def _populate_expand_collapse_menu(self, menu):
Args:
menu (QMenu)
"""
- if not self._db_map_relationship_class_lists:
+ if not self._db_map_entity_class_lists:
menu.setEnabled(False)
return
menu.setEnabled(True)
menu.addAction("All")
menu.addSeparator()
- for name, db_map_rel_cls_lst in sorted(self._db_map_relationship_class_lists.items()):
- db_map, rel_cls = next(iter(db_map_rel_cls_lst))
- icon = self.db_mngr.entity_class_icon(db_map, "relationship_class", rel_cls["id"])
- menu.addAction(icon, name).setEnabled(
- any(rel_cls["relationship_ids"] for (db_map, rel_cls) in db_map_rel_cls_lst)
- )
+ for name, db_map_ent_clss in sorted(self._db_map_entity_class_lists.items()):
+ db_map, ent_cls = next(iter(db_map_ent_clss))
+ icon = self.db_mngr.entity_class_icon(db_map, ent_cls["id"])
+ menu.addAction(icon, name).setEnabled(any(rel_cls["entity_ids"] for (db_map, rel_cls) in db_map_ent_clss))
- def _populate_add_relationships_menu(self, menu):
+ def _populate_connect_entities_menu(self, menu):
"""
Populates the 'Add relationships' menu.
Args:
menu (QMenu)
"""
- object_class_ids_in_graph = {}
+ entity_class_ids_in_graph = {}
for item in self._spine_db_editor.ui.graphicsView.entity_items:
- if not isinstance(item, ObjectItem):
+ if not isinstance(item, EntityItem):
continue
for db_map in item.db_maps:
- object_class_ids_in_graph.setdefault(db_map, set()).add(item.entity_class_id(db_map))
+ entity_class_ids_in_graph.setdefault(db_map, set()).update(item.entity_class_ids(db_map))
action_name_icon_enabled = []
- for name, db_map_rel_cls_lst in self._db_map_relationship_class_lists.items():
- for db_map, rel_cls in db_map_rel_cls_lst:
- icon = self.db_mngr.entity_class_icon(db_map, "relationship_class", rel_cls["id"])
+ for name, db_map_ent_clss in self._db_map_entity_class_lists.items():
+ for db_map, ent_cls in db_map_ent_clss:
+ icon = self.db_mngr.entity_class_icon(db_map, ent_cls["id"])
action_name = name + "@" + db_map.codename
- enabled = set(rel_cls["object_class_id_list"]) <= object_class_ids_in_graph.get(db_map, set())
+ enabled = set(ent_cls["dimension_id_list"]) <= entity_class_ids_in_graph.get(db_map, set())
action_name_icon_enabled.append((action_name, icon, enabled))
for action_name, icon, enabled in sorted(action_name_icon_enabled):
menu.addAction(icon, action_name).setEnabled(enabled)
- menu.setEnabled(bool(self._db_map_relationship_class_lists))
-
- def _get_db_map_relationship_ids_to_expand_or_collapse(self, action):
- db_map_rel_clss = self._db_map_relationship_class_lists.get(action.text())
- if db_map_rel_clss is not None:
- return {(db_map, id_) for db_map, rel_cls in db_map_rel_clss for id_ in rel_cls["relationship_ids"]}
- return {
- (db_map, id_)
- for class_list in self._db_map_relationship_class_lists.values()
- for db_map, rel_cls in class_list
- for id_ in rel_cls["relationship_ids"]
- }
+ menu.setEnabled(bool(self._db_map_entity_class_lists))
+
+ def _get_db_map_entity_ids_to_expand_or_collapse(self, action):
+ if action.text() == "All":
+ return {
+ (db_map, id_)
+ for db_map_ent_clss in self._db_map_entity_class_lists.values()
+ for db_map, ent_cls in db_map_ent_clss
+ for id_ in ent_cls["entity_ids"]
+ }
+ db_map_ent_clss = self._db_map_entity_class_lists.get(action.text())
+ if db_map_ent_clss is not None:
+ return {(db_map, id_) for db_map, ent_cls in db_map_ent_clss for id_ in ent_cls["entity_ids"]}
+ return ()
@Slot(QAction)
def _expand(self, action):
- db_map_relationship_ids = self._get_db_map_relationship_ids_to_expand_or_collapse(action)
- self._spine_db_editor.added_db_map_relationship_ids.update(db_map_relationship_ids)
- self._spine_db_editor.build_graph(persistent=True)
+ db_map_entity_ids = self._get_db_map_entity_ids_to_expand_or_collapse(action)
+ self._spine_db_editor.expand_graph(db_map_entity_ids)
@Slot(QAction)
def _collapse(self, action):
- db_map_relationship_ids = self._get_db_map_relationship_ids_to_expand_or_collapse(action)
- self._spine_db_editor.added_db_map_relationship_ids.difference_update(db_map_relationship_ids)
- self._spine_db_editor.build_graph(persistent=True)
+ db_map_entity_ids = self._get_db_map_entity_ids_to_expand_or_collapse(action)
+ self._spine_db_editor.collapse_graph(db_map_entity_ids)
@Slot(QAction)
- def _start_relationship(self, action):
+ def _start_connecting_entities(self, action):
class_name, db_name = action.text().split("@")
- db_map_rel_cls_lst = self._db_map_relationship_class_lists[class_name]
- db_map, rel_cls = next(
- iter((db_map, rel_cls) for db_map, rel_cls in db_map_rel_cls_lst if db_map.codename == db_name)
+ db_map_ent_cls_lst = self._db_map_entity_class_lists[class_name]
+ db_map, ent_cls = next(
+ iter((db_map, ent_cls) for db_map, ent_cls in db_map_ent_cls_lst if db_map.codename == db_name)
)
- self._spine_db_editor.start_relationship(db_map, rel_cls, self)
+ self._spine_db_editor.start_connecting_entities(db_map, ent_cls, self)
class ArcItem(QGraphicsPathItem):
- """Connects a RelationshipItem to an ObjectItem."""
-
- def __init__(self, rel_item, obj_item, width):
- """Initializes item.
+ """Connects two EntityItems."""
+ def __init__(self, ent_item, el_item, width):
+ """
Args:
- rel_item (spinetoolbox.widgets.graph_view_graphics_items.RelationshipItem): relationship item
- obj_item (spinetoolbox.widgets.graph_view_graphics_items.ObjectItem): object item
+ ent_item (spinetoolbox.widgets.graph_view_graphics_items.EntityItem): entity item
+ el_item (spinetoolbox.widgets.graph_view_graphics_items.EntityItem): element item
width (float): Preferred line width
"""
super().__init__()
- self.rel_item = rel_item
- self.obj_item = obj_item
- self._width = float(width)
+ self.ent_item = ent_item
+ self.el_item = el_item
+ self._original_width = float(width)
self._pen = self._make_pen()
self.setPen(self._pen)
self.setZValue(-2)
- rel_item.add_arc_item(self)
- obj_item.add_arc_item(self)
+ self._scaling_factor = 1
+ self._gradient = QGraphicsPathItem(self)
+ self._gradient.setPen(Qt.NoPen)
+ self._gradient_position = 0.5
+ self._gradient_width = 1
+ self._gradient_sign = 1
+ ent_item.add_arc_item(self)
+ el_item.add_arc_item(self)
self.setCursor(Qt.ArrowCursor)
self.update_line()
+ def clone(self, entity_items):
+ ent_item = entity_items[self.ent_item.db_map_ids]
+ el_item = entity_items[self.el_item.db_map_ids]
+ return type(self)(ent_item, el_item, self._original_width)
+
def _make_pen(self):
pen = QPen()
- pen.setWidth(self._width)
+ pen.setWidthF(self._original_width)
color = QGuiApplication.palette().color(QPalette.Normal, QPalette.WindowText)
color.setAlphaF(0.8)
pen.setColor(color)
@@ -669,29 +747,28 @@ def moveBy(self, dx, dy):
"""Does nothing. This item is not moved the regular way, but follows the EntityItems it connects."""
def update_line(self):
- overlapping_arcs = [arc for arc in self.rel_item.arc_items if arc.obj_item == self.obj_item]
- count = len(overlapping_arcs)
- path = QPainterPath(self.rel_item.pos())
- if count == 1:
- path.lineTo(self.obj_item.pos())
- else:
- rank = overlapping_arcs.index(self)
- line = QLineF(self.rel_item.pos(), self.obj_item.pos())
- line.setP1(line.center())
- line = line.normalVector()
- line.setLength(self._width * count)
- line.setP1(2 * line.p1() - line.p2())
- t = rank / (count - 1)
- ctrl_point = line.pointAt(t)
- path.quadTo(ctrl_point, self.obj_item.pos())
+ path = QPainterPath(self.ent_item.pos())
+ path.lineTo(self.el_item.pos())
self.setPath(path)
+ self._do_move_gradient()
+
+ def update_color(self, color):
+ self._pen.setColor(color)
+ self.setPen(self._pen)
+ color = QColor(color)
+ color.setAlphaF(0.5)
+ self._gradient.setBrush(color)
+
+ def apply_value(self, factor, sign):
+ self._update_width()
+ self._move_gradient(factor, sign)
def mousePressEvent(self, event):
"""Accepts the event so it's not propagated."""
event.accept()
def other_item(self, item):
- return {self.rel_item: self.obj_item, self.obj_item: self.rel_item}.get(item)
+ return {self.ent_item: self.el_item, self.el_item: self.ent_item}.get(item)
def apply_zoom(self, factor):
"""Applies zoom.
@@ -699,14 +776,42 @@ def apply_zoom(self, factor):
Args:
factor (float): The zoom factor.
"""
- if factor < 1:
- factor = 1
- scaled_width = self._width / factor
- self._pen.setWidthF(scaled_width)
- self.setPen(self._pen)
+ self._scaling_factor = max(factor, 1)
+ self._update_width()
+ def _update_width(self):
+ width = self._original_width / self._scaling_factor
+ self._pen.setWidthF(width)
+ self.setPen(self._pen)
-class CrossHairsItem(RelationshipItem):
+ def _move_gradient(self, factor, sign):
+ self._gradient_sign = sign
+ self._gradient_width = max(1, factor)
+ self._gradient_position += 0.1 * self._gradient_sign / self._scaling_factor
+ if self._gradient_position > 1:
+ self._gradient_position -= 1
+ elif self._gradient_position < 0:
+ self._gradient_position += 1
+ self._do_move_gradient()
+
+ def _do_move_gradient(self):
+ width = self._original_width * self._gradient_width / self._scaling_factor
+ init_pos, final_pos = self.ent_item.pos(), self.el_item.pos()
+ line = QLineF(init_pos, final_pos)
+ line.translate(self._gradient_position * line.dx(), self._gradient_position * line.dy())
+ line.setLength(width)
+ line.translate(-line.dx() / 2, -line.dy() / 2)
+ if self._gradient_sign < 0:
+ line.setPoints(line.p2(), line.p1())
+ normal = line.normalVector()
+ normal.translate(-normal.dx() / 2, -normal.dy() / 2)
+ path = QPainterPath(line.p2())
+ path.lineTo(normal.p1())
+ path.lineTo(normal.p2())
+ self._gradient.setPath(path)
+
+
+class CrossHairsItem(EntityItem):
"""Creates new relationships directly in the graph."""
def __init__(self, *args, **kwargs):
@@ -720,15 +825,22 @@ def entity_class_name(self):
return None
@property
- def entity_name(self):
+ def name(self):
return None
+ @property
+ def has_dimensions(self):
+ return False
+
def _make_tool_tip(self):
return "
Click on an object to add it to the relationship.
"
+ def _has_name(self):
+ return False
+
def refresh_icon(self):
- renderer = self.db_mngr.get_icon_mngr(self.first_db_map).icon_renderer("\uf05b", 0)
- self._set_renderer(renderer)
+ self._renderer = self.db_mngr.get_icon_mngr(self.first_db_map).icon_renderer("\uf05b", 0)
+ self._install_renderer()
def set_plus_icon(self):
self.set_icon("\uf067", Qt.blue)
@@ -746,52 +858,54 @@ def set_icon(self, unicode, color=0):
"""Refreshes the icon."""
if (unicode, color) == self._current_icon:
return
- renderer = self.db_mngr.get_icon_mngr(self.first_db_map).icon_renderer(unicode, color)
- self._set_renderer(renderer)
+ self._renderer = self.db_mngr.get_icon_mngr(self.first_db_map).icon_renderer(unicode, color)
+ self._install_renderer()
self._current_icon = (unicode, color)
- def mouseMoveEvent(self, event):
- move_by = event.scenePos() - self.scenePos()
- self.block_move_by(move_by.x(), move_by.y())
+ def _snap(self, x, y):
+ return (x, y)
- def block_move_by(self, dx, dy):
- self.moveBy(dx, dy)
- rel_items = {arc_item.rel_item for arc_item in self.arc_items}
- for rel_item in rel_items:
- rel_item.follow_object_by(dx, dy)
+ def mouseMoveEvent(self, event):
+ delta = event.scenePos() - self.scenePos()
+ self.move_by(delta.x(), delta.y())
def contextMenuEvent(self, e):
e.accept()
-class CrossHairsRelationshipItem(RelationshipItem):
+class CrossHairsEntityItem(EntityItem):
"""Represents the relationship that's being created using the CrossHairsItem."""
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.setFlag(QGraphicsItem.ItemIsSelectable, enabled=False)
+ @property
+ def has_dimensions(self):
+ return True
+
def _make_tool_tip(self):
return None
+ def _has_name(self):
+ return False
+
def refresh_icon(self):
"""Refreshes the icon."""
- obj_items = [arc_item.obj_item for arc_item in self.arc_items]
- object_class_name_list = tuple(
- obj_item.entity_class_name for obj_item in obj_items if not isinstance(obj_item, CrossHairsItem)
+ el_items = [arc_item.el_item for arc_item in self.arc_items]
+ dimension_name_list = tuple(
+ el_item.entity_class_name for el_item in el_items if not isinstance(el_item, CrossHairsItem)
)
- renderer = self.db_mngr.get_icon_mngr(self.first_db_map).relationship_class_renderer(
- None, object_class_name_list
- )
- self._set_renderer(renderer)
+ self._renderer = self.db_mngr.get_icon_mngr(self.first_db_map).multi_class_renderer(dimension_name_list)
+ self._install_renderer()
def contextMenuEvent(self, e):
e.accept()
class CrossHairsArcItem(ArcItem):
- """Connects a CrossHairsRelationshipItem with the CrossHairsItem,
- and with all the ObjectItem's in the relationship so far.
+ """Connects a CrossHairsEntityItem with the CrossHairsItem,
+ and with all the EntityItem's in the relationship so far.
"""
def _make_pen(self):
@@ -803,8 +917,8 @@ def _make_pen(self):
return pen
-class ObjectLabelItem(QGraphicsTextItem):
- """Provides a label for ObjectItem's."""
+class EntityLabelItem(QGraphicsTextItem):
+ """Provides a label for EntityItem."""
entity_name_edited = Signal(str)
@@ -828,6 +942,11 @@ def __init__(self, entity_item):
self.setFlag(QGraphicsItem.ItemIsSelectable, enabled=False)
self.setAcceptHoverEvents(False)
+ def boundingRect(self):
+ if not self.isVisible():
+ return QRectF()
+ return super().boundingRect()
+
def setPlainText(self, text):
"""Set texts and resets position.
@@ -844,3 +963,154 @@ def reset_position(self):
y = rectf.height() + 4
self.setPos(x, y)
self.bg.setRect(self.boundingRect())
+
+
+class BgItem(QGraphicsRectItem):
+ class Anchor(Enum):
+ TL = auto()
+ TR = auto()
+ BL = auto()
+ BR = auto()
+
+ _getter_setter = {
+ Anchor.TL: ("topLeft", "setTopLeft"),
+ Anchor.TR: ("topRight", "setTopRight"),
+ Anchor.BL: ("bottomLeft", "setBottomLeft"),
+ Anchor.BR: ("bottomRight", "setBottomRight"),
+ }
+
+ _cursors = {
+ Anchor.TL: Qt.SizeFDiagCursor,
+ Anchor.TR: Qt.SizeBDiagCursor,
+ Anchor.BL: Qt.SizeBDiagCursor,
+ Anchor.BR: Qt.SizeFDiagCursor,
+ }
+
+ def __init__(self, svg, parent=None):
+ super().__init__(parent)
+ self._renderer = QSvgRenderer()
+ self._svg_item = _ResizableQGraphicsSvgItem(self)
+ self.svg = svg
+ _loading_ok = self._renderer.load(QByteArray(self.svg))
+ self._svg_item.setCacheMode(QGraphicsItem.CacheMode.NoCache) # Needed for the exported pdf to be vector
+ self._svg_item.setSharedRenderer(self._renderer)
+ self._scaling_factor = 1
+ size = self._renderer.defaultSize()
+ self.setRect(0, 0, size.width(), size.height())
+ self.setZValue(-1000)
+ self.setPen(Qt.NoPen)
+ self.setAcceptHoverEvents(True)
+ self.setFlag(QGraphicsItem.ItemIsMovable, True)
+ self._resizers = {anchor: _Resizer(parent=self) for anchor in self.Anchor}
+ for anchor, resizer in self._resizers.items():
+ resizer.resized.connect(lambda delta, strong, anchor=anchor: self._resize(anchor, delta, strong))
+ resizer.setCursor(self._cursors[anchor])
+ resizer.hide()
+
+ def clone(self):
+ other = type(self)(self.svg)
+ other.fit_rect(self.scene_rect())
+ return other
+
+ def hoverEnterEvent(self, ev):
+ super().hoverEnterEvent(ev)
+ for resizer in self._resizers.values():
+ resizer.show()
+
+ def hoverLeaveEvent(self, ev):
+ super().hoverLeaveEvent(ev)
+ for resizer in self._resizers.values():
+ resizer.hide()
+
+ def apply_zoom(self, factor):
+ self._scaling_factor = factor
+ self._place_resizers()
+
+ def _place_resizers(self):
+ for anchor, resizer in self._resizers.items():
+ getter, _ = self._getter_setter[anchor]
+ resizer.setPos(
+ getattr(self.rect(), getter)() - getattr(resizer.rect(), getter)() / self.scale() / self._scaling_factor
+ )
+
+ def _resize(self, anchor, delta, strong):
+ delta /= self.scale() * self._scaling_factor
+ rect = self.rect()
+ getter, setter = self._getter_setter[anchor]
+ get_point = getattr(rect, getter)
+ set_point = getattr(rect, setter)
+ set_point(get_point() + delta)
+ self._do_resize(rect, strong)
+
+ def _do_resize(self, rect, strong):
+ if strong:
+ self._svg_item.resize(rect.width(), rect.height())
+ self._svg_item.setPos(rect.topLeft())
+ self.setPen(Qt.NoPen)
+ else:
+ self.setPen(QPen(Qt.DashLine))
+ self.setRect(rect)
+ self.prepareGeometryChange()
+ self.update()
+ self._place_resizers()
+
+ def fit_rect(self, rect):
+ if not isinstance(rect, QRectF):
+ rect = QRectF(*rect)
+ self._do_resize(rect, True)
+
+ def scene_rect(self):
+ return self.mapToScene(self.rect()).boundingRect()
+
+
+class _ResizableQGraphicsSvgItem(QGraphicsSvgItem):
+ def __init__(self, *args, **kwargs):
+ super().__init__(*args, **kwargs)
+ self._width = 0
+ self._height = 0
+ self.setFlag(QGraphicsItem.ItemStacksBehindParent, True)
+
+ def resize(self, width, height):
+ self._width = width
+ self._height = height
+ self.prepareGeometryChange()
+ self.update()
+
+ def setSharedRenderer(self, renderer):
+ super().setSharedRenderer(renderer)
+ self._width = renderer.defaultSize().width()
+ self._height = renderer.defaultSize().height()
+
+ def boundingRect(self):
+ return QRectF(0, 0, self._width, self._height)
+
+ def paint(self, painter, options, widget):
+ self.renderer().render(painter, self.boundingRect())
+
+
+class _Resizer(QGraphicsRectItem):
+ class SignalsProvider(QObject):
+ resized = Signal(QPointF, bool)
+
+ def __init__(self, rect=QRectF(0, 0, 20, 20), parent=None):
+ super().__init__(rect, parent)
+ self._original_rect = self.rect()
+ self._press_pos = None
+ self.setFlag(QGraphicsItem.ItemIsMovable, True)
+ self.setFlag(QGraphicsItem.ItemIgnoresTransformations, True)
+ self._signal_provider = self.SignalsProvider()
+ self.resized = self._signal_provider.resized
+
+ def mousePressEvent(self, ev):
+ super().mousePressEvent(ev)
+ self._press_pos = ev.pos()
+
+ def mouseMoveEvent(self, ev):
+ super().mouseMoveEvent(ev)
+ delta = ev.pos() - self._press_pos
+ self._signal_provider.resized.emit(delta, False)
+
+ def mouseReleaseEvent(self, ev):
+ super().mouseReleaseEvent(ev)
+ delta = ev.pos() - self._press_pos
+ self._signal_provider.resized.emit(delta, True)
diff --git a/spinetoolbox/widgets/upgrade_notification.py b/spinetoolbox/spine_db_editor/helpers.py
similarity index 56%
rename from spinetoolbox/widgets/upgrade_notification.py
rename to spinetoolbox/spine_db_editor/helpers.py
index e6fb62a66..19945f6ec 100644
--- a/spinetoolbox/widgets/upgrade_notification.py
+++ b/spinetoolbox/spine_db_editor/helpers.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -8,22 +9,38 @@
# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
# this program. If not, see .
######################################################################################################################
-"""Contains widget and utils to notify users of the 0.8 update."""
-from PySide6.QtCore import Qt
-from PySide6.QtWidgets import QDialog
-
-
-class UpgradeNotificationDialog(QDialog):
- def __init__(self, parent):
- """
- Args:
- parent (QWidget): parent widget
- """
- super().__init__(parent)
- from ..ui.upgrade_notification import Ui_Form
-
- self._ui = Ui_Form()
- self._ui.setupUi(self)
- self.setAttribute(Qt.WidgetAttribute.WA_DeleteOnClose, True)
- self.setWindowTitle("Toolbox 0.8 upgrade information")
- self._ui.button_box.rejected.connect(self.close)
+
+"""Helpers and utilities for Spine Database editor."""
+
+
+def string_to_display_icon(x):
+ """Converts a 'foreign' string (from e.g. Excel) to entity class display icon.
+
+ Args:
+ x (str): string to convert
+
+ Returns:
+ int: display icon or None if conversion failed
+ """
+ try:
+ return int(x)
+ except ValueError:
+ return None
+
+
+TRUE_STRING = "true"
+FALSE_STRING = "false"
+GENERIC_TRUE = TRUE_STRING.casefold()
+GENERIC_FALSE = FALSE_STRING.casefold()
+
+
+def string_to_bool(x):
+ """Converts a 'foreign' string (from e.g. Excel) to boolean.
+
+ Args:
+ x (str): string to convert
+
+ Returns:
+ bool: boolean value
+ """
+ return x.casefold() == GENERIC_TRUE
diff --git a/spinetoolbox/spine_db_editor/main.py b/spinetoolbox/spine_db_editor/main.py
index 64c74eaf0..e41a92efe 100644
--- a/spinetoolbox/spine_db_editor/main.py
+++ b/spinetoolbox/spine_db_editor/main.py
@@ -23,7 +23,7 @@ def main():
status = QFontDatabase.addApplicationFont(":/fonts/fontawesome5-solid-webfont.ttf")
if status < 0:
logging.warning("Could not load fonts from resources file. Some icons may not render properly.")
- locale.setlocale(locale.LC_NUMERIC, 'C')
+ locale.setlocale(locale.LC_NUMERIC, "C")
settings = QSettings("SpineProject", "Spine Toolbox")
db_mngr = SpineDBManager(settings, None)
editor = MultiSpineDBEditor(db_mngr)
@@ -49,5 +49,5 @@ def _make_argument_parser():
return parser
-if __name__ == '__main__':
+if __name__ == "__main__":
sys.exit(main())
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/__init__.py b/spinetoolbox/spine_db_editor/mvcmodels/__init__.py
index 8b96d2413..336d85acc 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/__init__.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/__init__.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/alternative_item.py b/spinetoolbox/spine_db_editor/mvcmodels/alternative_item.py
index 82e5e11c1..07bfd7de2 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/alternative_item.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/alternative_item.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -28,10 +29,10 @@ def fetch_item_type(self):
return "alternative"
def empty_child(self):
- return AlternativeItem()
+ return AlternativeItem(self._model)
def _make_child(self, id_):
- return AlternativeItem(id_)
+ return AlternativeItem(self._model, id_)
class AlternativeItem(GrayIfLastMixin, EditableMixin, LeafItem):
@@ -45,10 +46,10 @@ def item_type(self):
def icon_code(self):
return _ALTERNATIVE_ICON
- @property
- def tool_tip(self):
- if self.id:
- return "Drag this item it onto a scenario item in Scenario tree to add it to that scenario.
"
+ def tool_tip(self, column):
+ if column == 0 and self.id:
+ return "Drag this item on a scenario item in Scenario tree to add it to that scenario.
"
+ return super().tool_tip(column)
def add_item_to_db(self, db_item):
self.db_mngr.add_alternatives({self.db_map: [db_item]})
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/alternative_model.py b/spinetoolbox/spine_db_editor/mvcmodels/alternative_model.py
index 7e5f2495e..36297c182 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/alternative_model.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/alternative_model.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -8,12 +9,11 @@
# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
# this program. If not, see .
######################################################################################################################
+
"""Contains alternative tree model."""
-import csv
import pickle
-from io import StringIO
-
-from PySide6.QtCore import QMimeData
+from collections import defaultdict
+from PySide6.QtCore import QMimeData, QByteArray
from .tree_model_base import TreeModelBase
from .alternative_item import DBItem
from .utils import two_column_as_csv
@@ -23,13 +23,8 @@
class AlternativeModel(TreeModelBase):
"""A model to display alternatives in a tree view."""
- @staticmethod
- def _make_db_item(db_map):
- return DBItem(db_map)
-
- @staticmethod
- def _top_children():
- return []
+ def _make_db_item(self, db_map):
+ return DBItem(self, db_map)
def mimeData(self, indexes):
"""Stores selected indexes into MIME data.
@@ -45,17 +40,17 @@ def mimeData(self, indexes):
Returns:
QMimeData: MIME data
"""
- d = {}
+ d = defaultdict(list)
# We have two columns and consequently usually twice the same item per row.
# Make items unique without losing order using a dictionary trick.
items = list(dict.fromkeys(self.item_from_index(ind) for ind in indexes))
for item in items:
db_item = item.parent_item
db_key = self.db_mngr.db_map_key(db_item.db_map)
- d.setdefault(db_key, []).append(item.id)
+ d[db_key].append(item.name)
mime = QMimeData()
mime.setText(two_column_as_csv(indexes))
- mime.setData(mime_types.ALTERNATIVE_DATA, pickle.dumps(d))
+ mime.setData(mime_types.ALTERNATIVE_DATA, QByteArray(pickle.dumps(d)))
return mime
def paste_alternative_mime_data(self, mime_data, database_item):
@@ -65,15 +60,13 @@ def paste_alternative_mime_data(self, mime_data, database_item):
mime_data (QMimeData): mime data
database_item (alternative_item.DBItem): target database item
"""
- alternative_data = pickle.loads(mime_data.data(mime_types.ALTERNATIVE_DATA))
+ alternative_data = pickle.loads(mime_data.data(mime_types.ALTERNATIVE_DATA).data())
names_to_descriptions = {}
- for db_key, alternative_ids in alternative_data.items():
+ for db_key in alternative_data:
db_map = self.db_mngr.db_map_from_key(db_key)
- items = self.db_mngr.get_items(db_map, "alternative", only_visible=False)
- names_to_descriptions.update({i.name: i.description for i in items})
- existing_names = {
- item.name for item in self.db_mngr.get_items(database_item.db_map, "alternative", only_visible=False)
- }
+ items = self.db_mngr.get_items(db_map, "alternative")
+ names_to_descriptions.update({i["name"]: i["description"] for i in items})
+ existing_names = {item["name"] for item in self.db_mngr.get_items(database_item.db_map, "alternative")}
alternative_db_items = []
for name, description in names_to_descriptions.items():
if name in existing_names:
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/colors.py b/spinetoolbox/spine_db_editor/mvcmodels/colors.py
index b22633949..6fae16acc 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/colors.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/colors.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -8,12 +9,10 @@
# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
# this program. If not, see .
######################################################################################################################
-"""
-Color constants for models.
-"""
+
+"""Color constants for models."""
from PySide6.QtGui import QColor
PIVOT_TABLE_HEADER_COLOR = QColor("#efefef")
-
FIXED_FIELD_COLOR = QColor("lightGray")
SELECTED_COLOR = QColor.fromString("paleturquoise")
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/compound_parameter_models.py b/spinetoolbox/spine_db_editor/mvcmodels/compound_models.py
similarity index 65%
rename from spinetoolbox/spine_db_editor/mvcmodels/compound_parameter_models.py
rename to spinetoolbox/spine_db_editor/mvcmodels/compound_models.py
index 516a1ade8..0fbb0e27f 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/compound_parameter_models.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/compound_models.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,42 +10,27 @@
# this program. If not, see .
######################################################################################################################
-"""
-Compound models for object parameter definitions and values.
-These models concatenate several 'single' models and one 'empty' model.
-"""
+""" Compound models. These models concatenate several 'single' models and one 'empty' model. """
from PySide6.QtCore import Qt, Slot, QTimer, QModelIndex
from PySide6.QtGui import QFont
from spinedb_api.parameter_value import join_value_and_type
-from ...helpers import rows_to_row_count_tuples, parameter_identifier
+from ...helpers import parameter_identifier, rows_to_row_count_tuples
from ...fetch_parent import FlexibleFetchParent
-from ..widgets.custom_menus import ParameterViewFilterMenu
from ...mvcmodels.compound_table_model import CompoundWithEmptyTableModel
-from .empty_parameter_models import (
- EmptyObjectParameterDefinitionModel,
- EmptyObjectParameterValueModel,
- EmptyRelationshipParameterDefinitionModel,
- EmptyRelationshipParameterValueModel,
-)
-from .single_parameter_models import (
- SingleObjectParameterDefinitionModel,
- SingleObjectParameterValueModel,
- SingleRelationshipParameterDefinitionModel,
- SingleRelationshipParameterValueModel,
-)
-
-
-class CompoundParameterModel(CompoundWithEmptyTableModel):
- """A model that concatenates several single parameter models
- and one empty parameter model.
- """
+from ..widgets.custom_menus import AutoFilterMenu
+from .empty_models import EmptyParameterDefinitionModel, EmptyParameterValueModel, EmptyEntityAlternativeModel
+from .single_models import SingleParameterDefinitionModel, SingleParameterValueModel, SingleEntityAlternativeModel
+
+
+class CompoundModelBase(CompoundWithEmptyTableModel):
+ """A base model for all models that show data in stacked format."""
def __init__(self, parent, db_mngr, *db_maps):
"""
Args:
parent (SpineDBEditor): the parent object
db_mngr (SpineDBManager): the database manager
- *db_maps (DiffDatabaseMapping): the database maps included in the model
+ *db_maps (DatabaseMapping): the database maps included in the model
"""
super().__init__(parent=parent, header=self._make_header())
self._parent = parent
@@ -59,7 +45,6 @@ def __init__(self, parent, db_mngr, *db_maps):
self._filter_timer.timeout.connect(self.refresh)
self._fetch_parent = FlexibleFetchParent(
self.item_type,
- accepts_item=self.accepts_item,
shows_item=self.shows_item,
handle_items_added=self.handle_items_added,
handle_items_removed=self.handle_items_removed,
@@ -67,37 +52,16 @@ def __init__(self, parent, db_mngr, *db_maps):
owner=self,
)
- def canFetchMore(self, _parent):
- result = False
- for db_map in self.db_maps:
- result |= self.db_mngr.can_fetch_more(db_map, self._fetch_parent)
- return result
-
- def fetchMore(self, _parent):
- for db_map in self.db_maps:
- self.db_mngr.fetch_more(db_map, self._fetch_parent)
-
- def accepts_item(self, item, db_map):
- return item.get(self.entity_class_id_key) is not None
-
- def shows_item(self, item, db_map):
- return any(m.db_map == db_map and m.filter_accepts_item(item) for m in self.accepted_single_models())
-
def _make_header(self):
raise NotImplementedError()
@property
- def entity_class_type(self):
- """Returns the entity_class type, either 'object_class' or 'relationship_class'.
-
- Returns:
- str
- """
- raise NotImplementedError()
+ def field_map(self):
+ return {}
@property
def item_type(self):
- """Returns the parameter item type, either 'parameter_definition' or 'parameter_value'.
+ """Returns the DB item type, e.g., 'parameter_value'.
Returns:
str
@@ -112,16 +76,7 @@ def _single_model_type(self):
Returns:
SingleParameterModel
"""
- return {
- "object_class": {
- "parameter_definition": SingleObjectParameterDefinitionModel,
- "parameter_value": SingleObjectParameterValueModel,
- },
- "relationship_class": {
- "parameter_definition": SingleRelationshipParameterDefinitionModel,
- "parameter_value": SingleRelationshipParameterValueModel,
- },
- }[self.entity_class_type][self.item_type]
+ raise NotImplementedError()
@property
def _empty_model_type(self):
@@ -131,32 +86,27 @@ def _empty_model_type(self):
Returns:
EmptyParameterModel
"""
- return {
- "object_class": {
- "parameter_definition": EmptyObjectParameterDefinitionModel,
- "parameter_value": EmptyObjectParameterValueModel,
- },
- "relationship_class": {
- "parameter_definition": EmptyRelationshipParameterDefinitionModel,
- "parameter_value": EmptyRelationshipParameterValueModel,
- },
- }[self.entity_class_type][self.item_type]
+ raise NotImplementedError()
- @property
- def entity_class_id_key(self):
- """
- Returns the key corresponding to the entity_class id (either "object_class_id" or "relationship_class_id")
+ def canFetchMore(self, _parent):
+ result = False
+ for db_map in self.db_maps:
+ result |= self.db_mngr.can_fetch_more(db_map, self._fetch_parent)
+ return result
- Returns:
- str
- """
- return {"object_class": "object_class_id", "relationship_class": "relationship_class_id"}[
- self.entity_class_type
- ]
+ def fetchMore(self, _parent):
+ for db_map in self.db_maps:
+ self.db_mngr.fetch_more(db_map, self._fetch_parent)
- @property
- def parameter_definition_id_key(self):
- return {"parameter_definition": "id", "parameter_value": "parameter_id"}[self.item_type]
+ def shows_item(self, item, db_map):
+ return any(m.db_map == db_map and m.filter_accepts_item(item) for m in self.accepted_single_models())
+
+ def reset_db_maps(self, db_maps):
+ if set(db_maps) == set(self.db_maps):
+ return
+ self.db_maps = db_maps
+ self._fetch_parent.set_obsolete(False)
+ self._fetch_parent.reset()
def init_model(self):
"""Initializes the model."""
@@ -166,7 +116,7 @@ def init_model(self):
self.empty_model.fetchMore(QModelIndex())
while self._auto_filter_menus:
_, menu = self._auto_filter_menus.popitem()
- menu.wipe_out()
+ menu.deleteLater()
def get_auto_filter_menu(self, logical_index):
"""Returns auto filter menu for given logical index from header view.
@@ -175,32 +125,29 @@ def get_auto_filter_menu(self, logical_index):
logical_index (int)
Returns:
- ParameterViewFilterMenu
+ AutoFilterMenu
"""
return self._make_auto_filter_menu(self.header[logical_index])
def _make_auto_filter_menu(self, field):
+ field = self.field_map.get(field, field)
if field not in self._auto_filter_menus:
- self._auto_filter_menus[field] = menu = ParameterViewFilterMenu(
- self._parent,
- self.db_mngr,
- self.db_maps,
- self.item_type,
- self.entity_class_id_key,
- field,
- show_empty=False,
+ self._auto_filter_menus[field] = menu = AutoFilterMenu(
+ self._parent, self.db_mngr, self.db_maps, self.item_type, field, show_empty=False
)
menu.filterChanged.connect(self.set_auto_filter)
return self._auto_filter_menus[field]
def headerData(self, section, orientation=Qt.Orientation.Horizontal, role=Qt.ItemDataRole.DisplayRole):
"""Returns an italic font in case the given column has an autofilter installed."""
+ field = self.header[section]
+ real_field = self.field_map.get(field, field)
italic_font = QFont()
italic_font.setItalic(True)
if (
role == Qt.ItemDataRole.FontRole
and orientation == Qt.Orientation.Horizontal
- and self._auto_filter.get(self.header[section], {}) != {}
+ and self._auto_filter.get(real_field, {}) != {}
):
return italic_font
return super().headerData(section, orientation, role)
@@ -211,13 +158,13 @@ def _create_empty_model(self):
Returns:
EmptyParameterModel
"""
- return self._empty_model_type(self, self.header, self.db_mngr)
+ return self._empty_model_type(self)
def filter_accepts_model(self, model):
"""Returns a boolean indicating whether the given model passes the filter for compound model.
Args:
- model (SingleParameterModel, EmptyParameterModel)
+ model (SingleModelBase or EmptyModelBase)
Returns:
bool
@@ -233,7 +180,8 @@ def filter_accepts_model(self, model):
def _class_filter_accepts_model(self, model):
if not self._filter_class_ids:
return True
- return model.entity_class_id in self._filter_class_ids.get(model.db_map, set())
+ class_ids = self._filter_class_ids.get(model.db_map, set())
+ return model.entity_class_id in class_ids or bool(set(model.dimension_id_list) & class_ids)
def _auto_filter_accepts_model(self, model):
if None in self._auto_filter.values():
@@ -331,14 +279,15 @@ def _models_with_db_map(self, db_map):
"""Returns a collection of single models with given db_map.
Args:
- db_map (DiffDatabaseMapping)
+ db_map (DatabaseMapping)
Returns:
list
"""
return [m for m in self.single_models if m.db_map == db_map]
- def _items_per_class(self, items):
+ @staticmethod
+ def _items_per_class(items):
"""Returns a dict mapping entity_class ids to a set of items.
Args:
@@ -347,12 +296,12 @@ def _items_per_class(self, items):
Returns:
dict
"""
- d = dict()
+ d = {}
for item in items:
- entity_class_id = item.get(self.entity_class_id_key)
+ entity_class_id = item.get("entity_class_id")
if not entity_class_id:
continue
- d.setdefault(entity_class_id, list()).append(item)
+ d.setdefault(entity_class_id, []).append(item)
return d
def handle_items_added(self, db_map_data):
@@ -361,26 +310,27 @@ def handle_items_added(self, db_map_data):
Also notifies the empty model so it can remove rows that are already in.
Args:
- db_map_data (dict): list of added dict-items keyed by DiffDatabaseMapping
+ db_map_data (dict): list of added dict-items keyed by DatabaseMapping
"""
for db_map, items in db_map_data.items():
+ if db_map not in self.db_maps:
+ continue
db_map_single_models = [m for m in self.single_models if m.db_map is db_map]
existing_ids = set().union(*(m.item_ids() for m in db_map_single_models))
items_per_class = self._items_per_class(items)
for entity_class_id, class_items in items_per_class.items():
- ids_committed = list()
- ids_uncommitted = list()
+ ids_committed = []
+ ids_uncommitted = []
for item in class_items:
- is_committed = db_map.commit_id() is None or item["commit_id"] != db_map.commit_id()
item_id = item["id"]
if item_id in existing_ids:
continue
- if is_committed:
+ if item.is_committed():
ids_committed.append(item_id)
else:
ids_uncommitted.append(item_id)
- self._add_parameter_data(db_map, entity_class_id, ids_committed, committed=True)
- self._add_parameter_data(db_map, entity_class_id, ids_uncommitted, committed=False)
+ self._add_items(db_map, entity_class_id, ids_committed, committed=True)
+ self._add_items(db_map, entity_class_id, ids_uncommitted, committed=False)
self.empty_model.handle_items_added(db_map_data)
def _get_insert_position(self, model):
@@ -389,17 +339,17 @@ def _get_insert_position(self, model):
return len(self.single_models)
def _create_single_model(self, db_map, entity_class_id, committed):
- model = self._single_model_type(self.header, self.db_mngr, db_map, entity_class_id, committed)
+ model = self._single_model_type(self, db_map, entity_class_id, committed)
self._connect_single_model(model)
for field in self._auto_filter:
self._set_single_auto_filter(model, field)
return model
- def _add_parameter_data(self, db_map, entity_class_id, ids, committed):
+ def _add_items(self, db_map, entity_class_id, ids, committed):
"""Creates new single model and resets it with the given parameter ids.
Args:
- db_map (DiffDatabaseMapping): database map
+ db_map (DatabaseMapping): database map
entity_class_id (int): parameter's entity class id
ids (list of int): parameter ids
committed (bool): True if the ids have been committed, False otherwise
@@ -421,46 +371,51 @@ def handle_items_updated(self, db_map_data):
Emits dataChanged so the parameter_name column is refreshed.
Args:
- db_map_data (dict): list of updated dict-items keyed by DiffDatabaseMapping
+ db_map_data (dict): list of updated dict-items keyed by DatabaseMapping
"""
- self._emit_data_changed_for_column("parameter_name")
- # NOTE: parameter_definition names aren't refreshed unless we emit dataChanged,
- # whereas entity and class names are. Why?
+ if all(db_map not in self.db_maps for db_map in db_map_data):
+ return
+ self.dataChanged.emit(
+ self.index(0, 0), self.index(self.rowCount() - 1, self.columnCount() - 1), [Qt.ItemDataRole.DisplayRole]
+ )
def handle_items_removed(self, db_map_data):
"""Runs when either parameter definitions or values are removed from the dbs.
Removes the affected rows from the corresponding single models.
Args:
- db_map_data (dict): list of removed dict-items keyed by DiffDatabaseMapping
+ db_map_data (dict): list of removed dict-items keyed by DatabaseMapping
"""
self.layoutAboutToBeChanged.emit()
for db_map, items in db_map_data.items():
+ if db_map not in self.db_maps:
+ continue
items_per_class = self._items_per_class(items)
- for model in self._models_with_db_map(db_map):
- removed_ids = [x["id"] for x in items_per_class.get(model.entity_class_id, {})]
+ emptied_single_model_indexes = []
+ for model_index, model in enumerate(self.single_models):
+ if model.db_map != db_map:
+ continue
+ removed_ids = {x["id"] for x in items_per_class.get(model.entity_class_id, {})}
if not removed_ids:
continue
- removed_rows = [row for row in range(model.rowCount()) if model._main_data[row] in removed_ids]
+ removed_rows = []
+ for row in range(model.rowCount()):
+ id_ = model._main_data[row]
+ if id_ in removed_ids:
+ removed_rows.append(row)
+ removed_ids.remove(id_)
+ if not removed_ids:
+ break
for row, count in sorted(rows_to_row_count_tuples(removed_rows), reverse=True):
del model._main_data[row : row + count]
+ if model.rowCount() == 0:
+ emptied_single_model_indexes.append(model_index)
+ for model_index in reversed(emptied_single_model_indexes):
+ model = self.sub_models.pop(model_index)
+ model.deleteLater()
self._do_refresh()
self.layoutChanged.emit()
- def _emit_data_changed_for_column(self, field):
- """Lazily emits data changed for an entire column.
-
- Args:
- field (str): the column header
- """
- try:
- column = self.header.index(field)
- except ValueError:
- return
- self.dataChanged.emit(
- self.index(0, column), self.index(self.rowCount() - 1, column), [Qt.ItemDataRole.DisplayRole]
- )
-
def db_item(self, index):
sub_index = self.map_to_sub(index)
return sub_index.model().db_item(sub_index)
@@ -472,58 +427,9 @@ def db_map_id(self, index):
return None, None
return sub_model.db_map, sub_model.item_id(sub_index.row())
- def index_name(self, index):
- """Generates a name for data at given index.
-
- Args:
- index (QModelIndex): index to model
-
- Returns:
- str: label identifying the data
- """
- item = self.db_item(index)
- if item is None:
- return ""
- database = self.index(index.row(), self.columnCount() - 1).data()
- name_key = {
- "parameter_definition": {
- "object_class": "object_class_name",
- "relationship_class": "relationship_class_name",
- },
- "parameter_value": {"object_class": "object_name", "relationship_class": "object_name_list"},
- }[self.item_type][self.entity_class_type]
- name = item[name_key]
- names = [name] if not isinstance(name, tuple) else list(name)
- alternative_name = {"parameter_definition": lambda x: None, "parameter_value": lambda x: x["alternative_name"]}[
- self.item_type
- ](item)
- return parameter_identifier(database, item["parameter_name"], names, alternative_name)
-
- def get_set_data_delayed(self, index):
- """Returns a function that ParameterValueEditor can call to set data for the given index at any later time,
- even if the model changes.
-
- Args:
- index (QModelIndex)
-
- Returns:
- function
- """
- sub_model = self.sub_model_at_row(index.row())
- if sub_model == self.empty_model:
- return lambda value_and_type, index=index: self.setData(index, join_value_and_type(*value_and_type))
- id_ = self.item_at_row(index.row())
- value_field = {"parameter_value": "value", "parameter_definition": "default_value"}[self.item_type]
- return lambda value_and_type, sub_model=sub_model, id_=id_: sub_model.update_items_in_db(
- [{"id": id_, value_field: join_value_and_type(*value_and_type)}]
- )
-
def get_entity_class_id(self, index, db_map):
- entity_class_name_key = {"object_class": "object_class_name", "relationship_class": "relationship_class_name"}[
- self.entity_class_type
- ]
- entity_class_name = index.sibling(index.row(), self.header.index(entity_class_name_key)).data()
- entity_class = self.db_mngr.get_item_by_field(db_map, self.entity_class_type, "name", entity_class_name)
+ entity_class_name = index.sibling(index.row(), self.header.index("entity_class_name")).data()
+ entity_class = db_map.get_item("entity_class", name=entity_class_name)
return entity_class.get("id")
def filter_by(self, rows_per_column):
@@ -541,56 +447,18 @@ def filter_excluding(self, rows_per_column):
menu.set_filter_rejected_values(rejected_values)
-class CompoundObjectParameterMixin:
- """Implements the interface for populating and filtering a compound object parameter model."""
-
- @property
- def entity_class_type(self):
- return "object_class"
-
-
-class CompoundRelationshipParameterMixin:
- """Implements the interface for populating and filtering a compound relationship parameter model."""
-
- @property
- def entity_class_type(self):
- return "relationship_class"
-
-
-class CompoundParameterDefinitionMixin:
- """Handles signals from db mngr for parameter_definition models."""
-
- @property
- def item_type(self):
- return "parameter_definition"
-
-
-class CompoundParameterValueMixin:
- """Handles signals from db mngr for parameter_value models."""
+class FilterEntityAlternativeMixin:
+ """Provides the interface to filter by entity and alternative."""
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
- self._filter_entity_ids = dict()
- self._filter_alternative_ids = dict()
+ self._filter_entity_ids = {}
+ self._filter_alternative_ids = {}
def init_model(self):
super().init_model()
- self._filter_entity_ids = dict()
- self._filter_alternative_ids = dict()
-
- @property
- def item_type(self):
- return "parameter_value"
-
- @property
- def entity_type(self):
- """Returns the entity type, either 'object' or 'relationship'
- Used by update_single_main_filter.
-
- Returns:
- str
- """
- raise NotImplementedError()
+ self._filter_entity_ids = {}
+ self._filter_alternative_ids = {}
def set_filter_entity_ids(self, entity_ids):
self._filter_entity_ids = entity_ids
@@ -611,28 +479,67 @@ def _create_single_model(self, db_map, entity_class_id, committed):
return model
-class CompoundObjectParameterDefinitionModel(
- CompoundObjectParameterMixin, CompoundParameterDefinitionMixin, CompoundParameterModel
-):
- """A model that concatenates several single object parameter_definition models
- and one empty object parameter_definition model.
- """
+class EditParameterValueMixin:
+ """Provides the interface to edit values via ParameterValueEditor."""
- def _make_header(self):
- return ["object_class_name", "parameter_name", "value_list_name", "default_value", "description", "database"]
+ def index_name(self, index):
+ """Generates a name for data at given index.
+
+ Args:
+ index (QModelIndex): index to model
+
+ Returns:
+ str: label identifying the data
+ """
+ item = self.db_item(index)
+ if item is None:
+ return ""
+ database = self.index(index.row(), self.columnCount() - 1).data()
+ if self.item_type == "parameter_definition":
+ parameter_name = item["name"]
+ names = [item["entity_class_name"]]
+ elif self.item_type == "parameter_value":
+ parameter_name = item["parameter_name"]
+ names = list(item["entity_byname"])
+ else:
+ raise ValueError(
+ f"invalid item_type: expected parameter_definition or parameter_value, got {self.item_type}"
+ )
+ alternative_name = {"parameter_definition": lambda x: None, "parameter_value": lambda x: x["alternative_name"]}[
+ self.item_type
+ ](item)
+ return parameter_identifier(database, parameter_name, names, alternative_name)
+
+ def get_set_data_delayed(self, index):
+ """Returns a function that ParameterValueEditor can call to set data for the given index at any later time,
+ even if the model changes.
+
+ Args:
+ index (QModelIndex)
+
+ Returns:
+ function
+ """
+ sub_model = self.sub_model_at_row(index.row())
+ if sub_model == self.empty_model:
+ return lambda value_and_type, index=index: self.setData(index, join_value_and_type(*value_and_type))
+ id_ = self.item_at_row(index.row())
+ value_field = {"parameter_value": "value", "parameter_definition": "default_value"}[self.item_type]
+ return lambda value_and_type, sub_model=sub_model, id_=id_: sub_model.update_items_in_db(
+ [{"id": id_, value_field: join_value_and_type(*value_and_type)}]
+ )
-class CompoundRelationshipParameterDefinitionModel(
- CompoundRelationshipParameterMixin, CompoundParameterDefinitionMixin, CompoundParameterModel
-):
- """A model that concatenates several single relationship parameter_definition models
- and one empty relationship parameter_definition model.
- """
+class CompoundParameterDefinitionModel(EditParameterValueMixin, CompoundModelBase):
+ """A model that concatenates several single parameter_definition models and one empty parameter_definition model."""
+
+ @property
+ def item_type(self):
+ return "parameter_definition"
def _make_header(self):
return [
- "relationship_class_name",
- "object_class_name_list",
+ "entity_class_name",
"parameter_name",
"value_list_name",
"default_value",
@@ -640,33 +547,30 @@ def _make_header(self):
"database",
]
+ @property
+ def field_map(self):
+ return {"parameter_name": "name", "value_list_name": "parameter_value_list_name"}
-class CompoundObjectParameterValueModel(
- CompoundObjectParameterMixin, CompoundParameterValueMixin, CompoundParameterModel
-):
- """A model that concatenates several single object parameter_value models
- and one empty object parameter_value model.
- """
-
- def _make_header(self):
- return ["object_class_name", "object_name", "parameter_name", "alternative_name", "value", "database"]
+ @property
+ def _single_model_type(self):
+ return SingleParameterDefinitionModel
@property
- def entity_type(self):
- return "object"
+ def _empty_model_type(self):
+ return EmptyParameterDefinitionModel
+
+class CompoundParameterValueModel(FilterEntityAlternativeMixin, EditParameterValueMixin, CompoundModelBase):
+ """A model that concatenates several single parameter_value models and one empty parameter_value model."""
-class CompoundRelationshipParameterValueModel(
- CompoundRelationshipParameterMixin, CompoundParameterValueMixin, CompoundParameterModel
-):
- """A model that concatenates several single relationship parameter_value models
- and one empty relationship parameter_value model.
- """
+ @property
+ def item_type(self):
+ return "parameter_value"
def _make_header(self):
return [
- "relationship_class_name",
- "object_name_list",
+ "entity_class_name",
+ "entity_byname",
"parameter_name",
"alternative_name",
"value",
@@ -674,5 +578,36 @@ def _make_header(self):
]
@property
- def entity_type(self):
- return "relationship"
+ def field_map(self):
+ return {"parameter_name": "parameter_definition_name"}
+
+ @property
+ def _single_model_type(self):
+ return SingleParameterValueModel
+
+ @property
+ def _empty_model_type(self):
+ return EmptyParameterValueModel
+
+
+class CompoundEntityAlternativeModel(FilterEntityAlternativeMixin, CompoundModelBase):
+ @property
+ def item_type(self):
+ return "entity_alternative"
+
+ def _make_header(self):
+ return [
+ "entity_class_name",
+ "entity_byname",
+ "alternative_name",
+ "active",
+ "database",
+ ]
+
+ @property
+ def _single_model_type(self):
+ return SingleEntityAlternativeModel
+
+ @property
+ def _empty_model_type(self):
+ return EmptyEntityAlternativeModel
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/empty_models.py b/spinetoolbox/spine_db_editor/mvcmodels/empty_models.py
new file mode 100644
index 000000000..26c2ffa05
--- /dev/null
+++ b/spinetoolbox/spine_db_editor/mvcmodels/empty_models.py
@@ -0,0 +1,296 @@
+######################################################################################################################
+# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
+# This file is part of Spine Toolbox.
+# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
+# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
+# any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+# without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
+# this program. If not, see .
+######################################################################################################################
+
+"""Empty models for parameter definitions and values."""
+from PySide6.QtCore import Qt
+from ...mvcmodels.empty_row_model import EmptyRowModel
+from .single_and_empty_model_mixins import SplitValueAndTypeMixin, MakeEntityOnTheFlyMixin
+from ...mvcmodels.shared import PARSED_ROLE, DB_MAP_ROLE
+from ...helpers import rows_to_row_count_tuples, DB_ITEM_SEPARATOR
+
+
+class EmptyModelBase(EmptyRowModel):
+ """Base class for all empty models that go in a CompoundModelBase subclass."""
+
+ def __init__(self, parent):
+ """
+ Args:
+ parent (CompoundModelBase): the parent model
+ """
+ super().__init__(parent, parent.header)
+ self.db_mngr = parent.db_mngr
+ self.db_map = None
+ self.entity_class_id = None
+
+ @property
+ def item_type(self):
+ raise NotImplementedError()
+
+ @property
+ def field_map(self):
+ return self._parent.field_map
+
+ def add_items_to_db(self, db_map_data):
+ """Add items to db.
+
+ Args:
+ db_map_data (dict): mapping DiffDatabaseMapping instance to list of items
+ """
+ db_map_items = {}
+ db_map_error_log = {}
+ for db_map, items in db_map_data.items():
+ for item in items:
+ item_to_add, errors = self._convert_to_db(item)
+ self._autocomplete_row(db_map, item_to_add)
+ if self._check_item(item_to_add):
+ db_map_items.setdefault(db_map, []).append(item_to_add)
+ if errors:
+ db_map_error_log.setdefault(db_map, []).extend(errors)
+ if any(db_map_items.values()):
+ self._do_add_items_to_db(db_map_items)
+ if db_map_error_log:
+ self.db_mngr.error_msg.emit(db_map_error_log)
+
+ def _make_unique_id(self, item):
+ """Returns a unique id for the given model item (name-based). Used by handle_items_added to identify
+ which rows have been added and thus need to be removed."""
+ raise NotImplementedError()
+
+ @property
+ def can_be_filtered(self):
+ return False
+
+ def accepted_rows(self):
+ return range(self.rowCount())
+
+ def db_item(self, _index): # pylint: disable=no-self-use
+ return None
+
+ def item_id(self, _row): # pylint: disable=no-self-use
+ return None
+
+ def handle_items_added(self, db_map_data):
+ """Runs when parameter definitions or values are added.
+ Finds and removes model items that were successfully added to the db."""
+ added_ids = set()
+ for db_map, items in db_map_data.items():
+ for item in items:
+ database = db_map.codename
+ unique_id = (database, *self._make_unique_id(item))
+ added_ids.add(unique_id)
+ removed_rows = []
+ for row in range(self.rowCount()):
+ item = self._make_item(row)
+ database = item.get("database")
+ unique_id = (database, *self._make_unique_id(self._convert_to_db(item)[0]))
+ if unique_id in added_ids:
+ removed_rows.append(row)
+ for row, count in sorted(rows_to_row_count_tuples(removed_rows), reverse=True):
+ self.removeRows(row, count)
+
+ def batch_set_data(self, indexes, data):
+ """Sets data for indexes in batch. If successful, add items to db."""
+ if not super().batch_set_data(indexes, data):
+ return False
+ rows = {ind.row() for ind in indexes}
+ db_map_data = self._make_db_map_data(rows)
+ self.add_items_to_db(db_map_data)
+ return True
+
+ def _autocomplete_row(self, db_map, item):
+ """Fills in entity_class_name whenever other selections make it obvious."""
+ candidates = self._entity_class_name_candidates(db_map, item)
+ row = item.pop("row", None)
+ if len(candidates) == 1:
+ entity_class_name = candidates[0]
+ item["entity_class_name"] = entity_class_name
+ self._main_data[row][self.header.index("entity_class_name")] = entity_class_name
+
+ def _entity_class_name_candidates(self, db_map, item):
+ raise NotImplementedError()
+
+ def _make_item(self, row):
+ return dict(zip(self.header, self._main_data[row]), row=row)
+
+ def _make_db_map_data(self, rows):
+ """
+ Returns model data grouped by database map.
+
+ Args:
+ rows (set): group data from these rows
+
+ Returns:
+ dict: mapping DiffDatabaseMapping instance to list of items
+ """
+ items = [self._make_item(row) for row in rows]
+ db_map_data = {}
+ for item in items:
+ database = item.pop("database")
+ db_map = next(iter(x for x in self.db_mngr.db_maps if x.codename == database), None)
+ if not db_map:
+ continue
+ item = {k: v for k, v in item.items() if v is not None}
+ db_map_data.setdefault(db_map, []).append(item)
+ return db_map_data
+
+ def data(self, index, role=Qt.ItemDataRole.DisplayRole):
+ if role == DB_MAP_ROLE:
+ database = self.data(index, Qt.ItemDataRole.DisplayRole)
+ return next(iter(x for x in self.db_mngr.db_maps if x.codename == database), None)
+ return super().data(index, role)
+
+
+class ParameterMixin:
+ @property
+ def value_field(self):
+ return {"parameter_value": "value", "parameter_definition": "default_value"}[self.item_type]
+
+ def data(self, index, role=Qt.ItemDataRole.DisplayRole):
+ if self.header[index.column()] == self.value_field and role in (
+ Qt.ItemDataRole.DisplayRole,
+ Qt.ItemDataRole.ToolTipRole,
+ Qt.ItemDataRole.TextAlignmentRole,
+ PARSED_ROLE,
+ ):
+ data = super().data(index, role=Qt.ItemDataRole.EditRole)
+ return self.db_mngr.get_value_from_data(data, role)
+ return super().data(index, role)
+
+ @staticmethod
+ def _entity_class_name_candidates_by_parameter(db_map, item):
+ return [
+ x["entity_class_name"]
+ for x in db_map.get_items("parameter_definition", name=item.get("parameter_definition_name"))
+ ]
+
+
+class EntityMixin:
+ def _do_add_items_to_db(self, db_map_items):
+ raise NotImplementedError()
+
+ def add_items_to_db(self, db_map_data):
+ """Overriden to add entities on the fly first."""
+ db_map_entities = {}
+ db_map_error_log = {}
+ for db_map, items in db_map_data.items():
+ for item in items:
+ item_to_add, _ = self._convert_to_db(item)
+ self._autocomplete_row(db_map, item_to_add)
+ entity, errors = self._make_entity_on_the_fly(item, db_map)
+ if entity:
+ entities = db_map_entities.setdefault(db_map, [])
+ if entity not in entities:
+ entities.append(entity)
+ if errors:
+ db_map_error_log.setdefault(db_map, []).extend(errors)
+ if any(db_map_entities.values()):
+ self.db_mngr.add_entities(db_map_entities)
+ if db_map_error_log:
+ self.db_mngr.error_msg.emit(db_map_error_log)
+ super().add_items_to_db(db_map_data)
+
+ def _make_item(self, row):
+ item = super()._make_item(row)
+ byname = item["entity_byname"]
+ item["entity_byname"] = tuple(byname.split(DB_ITEM_SEPARATOR)) if byname else ()
+ return item
+
+ @staticmethod
+ def _entity_class_name_candidates_by_entity(db_map, item):
+ return [x["entity_class_name"] for x in db_map.get_items("entity", entity_byname=item.get("entity_byname"))]
+
+
+class EmptyParameterDefinitionModel(SplitValueAndTypeMixin, ParameterMixin, EmptyModelBase):
+ """An empty parameter_definition model."""
+
+ @property
+ def item_type(self):
+ return "parameter_definition"
+
+ def _make_unique_id(self, item):
+ return tuple(item.get(x) for x in ("entity_class_name", "name"))
+
+ @staticmethod
+ def _check_item(item):
+ """Checks if a db item is ready to be inserted."""
+ return item.get("entity_class_name") and item.get("name")
+
+ def _entity_class_name_candidates(self, db_map, item):
+ return []
+
+ def _do_add_items_to_db(self, db_map_items):
+ self.db_mngr.add_parameter_definitions(db_map_items)
+
+
+class EmptyParameterValueModel(
+ MakeEntityOnTheFlyMixin, SplitValueAndTypeMixin, ParameterMixin, EntityMixin, EmptyModelBase
+):
+ """An empty parameter_value model."""
+
+ @property
+ def item_type(self):
+ return "parameter_value"
+
+ @staticmethod
+ def _check_item(item):
+ """Checks if a db item is ready to be inserted."""
+ return all(
+ key in item
+ for key in (
+ "entity_class_name",
+ "entity_byname",
+ "parameter_definition_name",
+ "alternative_name",
+ "value",
+ "type",
+ )
+ )
+
+ def _make_unique_id(self, item):
+ return tuple(
+ item.get(x) for x in ("entity_class_name", "entity_byname", "parameter_definition_name", "alternative_name")
+ )
+
+ def _do_add_items_to_db(self, db_map_items):
+ self.db_mngr.add_parameter_values(db_map_items)
+
+ def _entity_class_name_candidates(self, db_map, item):
+ candidates_by_parameter = self._entity_class_name_candidates_by_parameter(db_map, item)
+ candidates_by_entity = self._entity_class_name_candidates_by_entity(db_map, item)
+ if not candidates_by_parameter:
+ return candidates_by_entity
+ if not candidates_by_entity:
+ return candidates_by_parameter
+ return list(
+ set(self._entity_class_name_candidates_by_parameter(db_map, item))
+ & set(self._entity_class_name_candidates_by_entity(db_map, item))
+ )
+
+
+class EmptyEntityAlternativeModel(MakeEntityOnTheFlyMixin, EntityMixin, EmptyModelBase):
+ @property
+ def item_type(self):
+ return "entity_alternative"
+
+ @staticmethod
+ def _check_item(item):
+ """Checks if a db item is ready to be inserted."""
+ return all(key in item for key in ("entity_class_name", "entity_byname", "alternative_name", "active"))
+
+ def _make_unique_id(self, item):
+ return tuple(item.get(x) for x in ("entity_class_name", "entity_byname", "alternative_name"))
+
+ def _do_add_items_to_db(self, db_map_items):
+ self.db_mngr.add_entity_alternatives(db_map_items)
+
+ def _entity_class_name_candidates(self, db_map, item):
+ return self._entity_class_name_candidates_by_entity(db_map, item)
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/empty_parameter_models.py b/spinetoolbox/spine_db_editor/mvcmodels/empty_parameter_models.py
deleted file mode 100644
index 30203c79a..000000000
--- a/spinetoolbox/spine_db_editor/mvcmodels/empty_parameter_models.py
+++ /dev/null
@@ -1,349 +0,0 @@
-######################################################################################################################
-# Copyright (C) 2017-2022 Spine project consortium
-# This file is part of Spine Toolbox.
-# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
-# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
-# any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
-# without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
-# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
-# this program. If not, see .
-######################################################################################################################
-
-"""
-Empty models for parameter definitions and values.
-"""
-from PySide6.QtCore import Qt
-from ...mvcmodels.empty_row_model import EmptyRowModel
-from .parameter_mixins import (
- FillInParameterNameMixin,
- MakeRelationshipOnTheFlyMixin,
- InferEntityClassIdMixin,
- FillInAlternativeIdMixin,
- FillInParameterDefinitionIdsMixin,
- FillInEntityIdsMixin,
- FillInEntityClassIdMixin,
- FillInValueListIdMixin,
-)
-from ...mvcmodels.shared import PARSED_ROLE, DB_MAP_ROLE
-from ...helpers import rows_to_row_count_tuples, DB_ITEM_SEPARATOR
-
-
-class EmptyParameterModel(EmptyRowModel):
- """An empty parameter model."""
-
- def __init__(self, parent, header, db_mngr):
- """Initialize class.
-
- Args:
- parent (Object): the parent object, typically a CompoundParameterModel
- header (list): list of field names for the header
- db_mngr (SpineDBManager)
- """
- super().__init__(parent, header)
- self.db_mngr = db_mngr
- self.db_map = None
- self.entity_class_id = None
-
- @property
- def item_type(self):
- """The item type, either 'parameter_value' or 'parameter_definition', required by the value_field property."""
- raise NotImplementedError()
-
- @property
- def entity_class_type(self):
- """Either 'object_class' or 'relationship_class'."""
- raise NotImplementedError()
-
- @property
- def entity_class_id_key(self):
- return {"object_class": "object_class_id", "relationship_class": "relationship_class_id"}[
- self.entity_class_type
- ]
-
- @property
- def entity_class_name_key(self):
- return {"object_class": "object_class_name", "relationship_class": "relationship_class_name"}[
- self.entity_class_type
- ]
-
- @property
- def can_be_filtered(self):
- return False
-
- @property
- def value_field(self):
- return {"parameter_definition": "default_value", "parameter_value": "value"}[self.item_type]
-
- def accepted_rows(self):
- return range(self.rowCount())
-
- def db_item(self, _index): # pylint: disable=no-self-use
- return None
-
- def item_id(self, _row): # pylint: disable=no-self-use
- return None
-
- def data(self, index, role=Qt.ItemDataRole.DisplayRole):
- if role == DB_MAP_ROLE:
- database = self.data(index, Qt.ItemDataRole.DisplayRole)
- return next(iter(x for x in self.db_mngr.db_maps if x.codename == database), None)
- if self.header[index.column()] == self.value_field and role in (
- Qt.ItemDataRole.DisplayRole,
- Qt.ItemDataRole.ToolTipRole,
- Qt.TextAlignmentRole,
- PARSED_ROLE,
- ):
- data = super().data(index, role=Qt.ItemDataRole.EditRole)
- return self.db_mngr.get_value_from_data(data, role)
- return super().data(index, role)
-
- def _make_unique_id(self, item):
- """Returns a unique id for the given model item (name-based). Used by handle_items_added."""
- return (item.get(self.entity_class_name_key), item.get("parameter_name"))
-
- def handle_items_added(self, db_map_data):
- """Runs when parameter definitions or values are added.
- Finds and removes model items that were successfully added to the db."""
- added_ids = set()
- for db_map, items in db_map_data.items():
- for item in items:
- database = db_map.codename
- unique_id = (database, *self._make_unique_id(item))
- added_ids.add(unique_id)
- removed_rows = []
- for row in range(self.rowCount()):
- item = self._make_item(row)
- database = item.get("database")
- unique_id = (database, *self._make_unique_id(item))
- if unique_id in added_ids:
- removed_rows.append(row)
- for row, count in sorted(rows_to_row_count_tuples(removed_rows), reverse=True):
- self.removeRows(row, count)
-
- def batch_set_data(self, indexes, data):
- """Sets data for indexes in batch. If successful, add items to db."""
- if not super().batch_set_data(indexes, data):
- return False
- rows = {ind.row() for ind in indexes}
- db_map_data = self._make_db_map_data(rows)
- self.add_items_to_db(db_map_data)
- return True
-
- def add_items_to_db(self, db_map_data):
- """Add items to db.
-
- Args:
- db_map_data (dict): mapping DiffDatabaseMapping instance to list of items
- """
- raise NotImplementedError()
-
- def _make_item(self, row):
- return dict(zip(self.header, self._main_data[row]), row=row)
-
- def _make_db_map_data(self, rows):
- """
- Returns model data grouped by database map.
-
- Args:
- rows (set): group data from these rows
-
- Returns:
- dict: mapping DiffDatabaseMapping instance to list of items
- """
- items = [self._make_item(row) for row in rows]
- db_map_data = dict()
- for item in items:
- database = item.pop("database")
- db_map = next(iter(x for x in self.db_mngr.db_maps if x.codename == database), None)
- if not db_map:
- continue
- item = {k: v for k, v in item.items() if v is not None}
- db_map_data.setdefault(db_map, []).append(item)
- return db_map_data
-
-
-class EmptyParameterDefinitionModel(
- FillInValueListIdMixin, FillInEntityClassIdMixin, FillInParameterNameMixin, EmptyParameterModel
-):
- """An empty parameter_definition model."""
-
- @property
- def item_type(self):
- return "parameter_definition"
-
- @property
- def entity_class_type(self):
- """See base class."""
- raise NotImplementedError()
-
- def add_items_to_db(self, db_map_data):
- """See base class."""
- self.build_lookup_dictionary(db_map_data)
- db_map_param_def = dict()
- db_map_error_log = dict()
- for db_map, items in db_map_data.items():
- for item in items:
- def_item, errors = self._convert_to_db(item, db_map)
- if self._check_item(def_item):
- db_map_param_def.setdefault(db_map, []).append(def_item)
- if errors:
- db_map_error_log.setdefault(db_map, []).extend(errors)
- if any(db_map_param_def.values()):
- self.db_mngr.add_parameter_definitions(db_map_param_def)
- if db_map_error_log:
- self.db_mngr.error_msg.emit(db_map_error_log)
-
- def _check_item(self, item):
- """Checks if a db item is ready to be inserted."""
- return self.entity_class_id_key in item and "name" in item
-
-
-class EmptyObjectParameterDefinitionModel(EmptyParameterDefinitionModel):
- """An empty object parameter_definition model."""
-
- @property
- def entity_class_type(self):
- return "object_class"
-
-
-class EmptyRelationshipParameterDefinitionModel(EmptyParameterDefinitionModel):
- """An empty relationship parameter_definition model."""
-
- @property
- def entity_class_type(self):
- return "relationship_class"
-
- def flags(self, index):
- """Additional hack to make the object_class_name_list column non-editable."""
- flags = super().flags(index)
- if self.header[index.column()] == "object_class_name_list":
- flags &= ~Qt.ItemIsEditable
- return flags
-
-
-class EmptyParameterValueModel(
- InferEntityClassIdMixin,
- FillInAlternativeIdMixin,
- FillInParameterDefinitionIdsMixin,
- FillInEntityIdsMixin,
- FillInEntityClassIdMixin,
- EmptyParameterModel,
-):
- """An empty parameter_value model."""
-
- @property
- def item_type(self):
- return "parameter_value"
-
- @property
- def entity_type(self):
- """Either 'object' or "relationship'."""
- raise NotImplementedError()
-
- @property
- def entity_id_key(self):
- return {"object": "object_id", "relationship": "relationship_id"}[self.entity_type]
-
- @property
- def entity_name_key(self):
- return {"object": "object_name", "relationship": "object_name_list"}[self.entity_type]
-
- @property
- def entity_name_key_in_cache(self):
- return {"object": "name", "relationship": "object_name_list"}[self.entity_type]
-
- def _make_unique_id(self, item):
- """Returns a unique id for the given model item (name-based). Used by handle_items_added."""
- return (*super()._make_unique_id(item), item.get("alternative_name"))
-
- def add_items_to_db(self, db_map_data):
- """See base class."""
- self.build_lookup_dictionary(db_map_data)
- db_map_param_val = dict()
- db_map_error_log = dict()
- for db_map, items in db_map_data.items():
- for item in items:
- param_val, errors = self._convert_to_db(item, db_map)
- if self._check_item(db_map, param_val):
- db_map_param_val.setdefault(db_map, []).append(param_val)
- if errors:
- db_map_error_log.setdefault(db_map, []).extend(errors)
- if any(db_map_param_val.values()):
- self.db_mngr.add_parameter_values(db_map_param_val)
- if db_map_error_log:
- self.db_mngr.error_msg.emit(db_map_error_log)
-
- def _check_item(self, db_map, item):
- """Checks if a db item is ready to be inserted."""
- return (
- self.entity_class_id_key in item
- and self.entity_id_key in item
- and "parameter_definition_id" in item
- and "alternative_id" in item
- and "value" in item
- )
-
-
-class EmptyObjectParameterValueModel(EmptyParameterValueModel):
- """An empty object parameter_value model."""
-
- @property
- def entity_class_type(self):
- return "object_class"
-
- @property
- def entity_type(self):
- return "object"
-
- def _make_unique_id(self, item):
- return (*super()._make_unique_id(item), item.get("name"))
-
-
-class EmptyRelationshipParameterValueModel(MakeRelationshipOnTheFlyMixin, EmptyParameterValueModel):
- """An empty relationship parameter_value model."""
-
- _add_entities_on_the_fly = True
-
- @property
- def entity_class_type(self):
- return "relationship_class"
-
- @property
- def entity_type(self):
- return "relationship"
-
- def _make_unique_id(self, item):
- object_name_list = item.get("object_name_list")
- return (
- *super()._make_unique_id(item),
- DB_ITEM_SEPARATOR.join(object_name_list) if object_name_list is not None else None,
- )
-
- def _make_item(self, row):
- item = super()._make_item(row)
- if item["object_name_list"]:
- item["object_name_list"] = tuple(item["object_name_list"].split(DB_ITEM_SEPARATOR))
- return item
-
- def add_items_to_db(self, db_map_data):
- """See base class."""
- # Call the super method to add whatever is ready.
- # This will fill the relationship_class_name as a side effect
- super().add_items_to_db(db_map_data)
- # Now we try to add relationships
- self.build_lookup_dictionaries(db_map_data)
- db_map_relationships = dict()
- db_map_error_log = dict()
- for db_map, items in db_map_data.items():
- for item in items:
- relationship, err = self._make_relationship_on_the_fly(item, db_map)
- if relationship:
- db_map_relationships.setdefault(db_map, []).append(relationship)
- if err:
- db_map_error_log.setdefault(db_map, []).extend(err)
- if any(db_map_relationships.values()):
- self.db_mngr.add_relationships(db_map_relationships)
- # Something might have become ready after adding the relationship(s), so we do one more pass
- super().add_items_to_db(db_map_data)
- if db_map_error_log:
- self.db_mngr.error_msg.emit(db_map_error_log)
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/entity_tree_item.py b/spinetoolbox/spine_db_editor/mvcmodels/entity_tree_item.py
index 046f81c6c..ee9b633cb 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/entity_tree_item.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/entity_tree_item.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,21 +10,44 @@
# this program. If not, see .
######################################################################################################################
-"""
-Classes to represent entities in a tree.
-"""
-
+"""Classes to represent entities in a tree."""
from PySide6.QtCore import Qt
from PySide6.QtGui import QFont, QBrush, QIcon
-
-from spinetoolbox.helpers import DB_ITEM_SEPARATOR
-from spinetoolbox.fetch_parent import FlexibleFetchParent
+from spinetoolbox.helpers import DB_ITEM_SEPARATOR, plain_to_tool_tip
+from spinetoolbox.fetch_parent import FlexibleFetchParent, FetchIndex
from .multi_db_tree_item import MultiDBTreeItem
-class EntityRootItem(MultiDBTreeItem):
+class EntityClassIndex(FetchIndex):
+ def process_item(self, item, db_map):
+ class_id = item["class_id"]
+ self.setdefault(db_map, {}).setdefault(class_id, []).append(item)
+
+
+class EntityGroupIndex(FetchIndex):
+ def process_item(self, item, db_map):
+ group_id = item["group_id"]
+ self.setdefault(db_map, {}).setdefault(group_id, []).append(item)
+
+
+class EntityIndex(FetchIndex):
+ def process_item(self, item, db_map):
+ element_id_list = item["element_id_list"]
+ for el_id in element_id_list:
+ self.setdefault(db_map, {}).setdefault(el_id, []).append(item)
+
+
+class EntityTreeRootItem(MultiDBTreeItem):
item_type = "root"
+ def __init__(self, *args, **kwargs):
+ super().__init__(*args, **kwargs)
+ self._has_children_initially = True
+
+ @property
+ def visible_children(self):
+ return [x for x in self.children if not x.is_hidden()]
+
@property
def display_id(self):
"""See super class."""
@@ -42,55 +66,80 @@ def set_data(self, column, value, role):
"""See base class."""
return False
-
-class ObjectTreeRootItem(EntityRootItem):
- """An object tree root item."""
-
- item_type = "root"
-
@property
def child_item_class(self):
"""Returns ObjectClassItem."""
- return ObjectClassItem
+ return EntityClassItem
+ def _polish_children(self, children):
+ """See base class."""
+ db_map_entity_class_ids = {
+ db_map: {x["class_id"] for x in self.db_mngr.get_items(db_map, "entity")} for db_map in self.db_maps
+ }
+ for child in children:
+ child.set_has_children_initially(
+ any(child.db_map_id(db_map) in db_map_entity_class_ids.get(db_map, ()) for db_map in child.db_maps)
+ )
-class RelationshipTreeRootItem(EntityRootItem):
- """A relationship tree root item."""
- item_type = "root"
+class EntityClassItem(MultiDBTreeItem):
+ """An entity_class item."""
+
+ visual_key = ["name", "dimension_name_list", "superclass_name"]
+ item_type = "entity_class"
+ _fetch_index = EntityClassIndex()
+
+ @property
+ def display_icon(self):
+ """Returns class icon."""
+ return self.db_mngr.entity_class_icon(self.first_db_map, self.db_map_id(self.first_db_map))
@property
def child_item_class(self):
- """Returns RelationshipClassItem."""
- return RelationshipClassItem
+ return EntityItem
+ def is_hidden(self):
+ return self.model.hide_empty_classes and not self.has_children()
-class EntityClassItem(MultiDBTreeItem):
- """An entity_class item."""
+ @property
+ def _children_sort_key(self):
+ """Reimplemented so groups are above non-groups."""
+ return lambda item: (not item.is_group, item.display_id)
+
+ def default_parameter_data(self):
+ """Return data to put as default in a parameter table when this item is selected."""
+ return dict(entity_class_name=self.name, database=self.first_db_map.codename)
@property
- def display_icon(self):
- """Returns class icon."""
- return self._display_icon()
+ def display_data(self):
+ """Returns the name for display."""
+ name = self.name
+ superclass_name = self.db_map_data_field(self.first_db_map, "superclass_name")
+ if superclass_name:
+ name += f"({superclass_name})"
+ return name
- def _display_icon(self, for_group=False):
- return self.db_mngr.entity_class_icon(
- self.first_db_map, self.item_type, self.db_map_id(self.first_db_map), for_group=for_group
- )
+ @property
+ def has_dimensions(self):
+ return bool(self.db_map_data_field(self.first_db_map, "dimension_id_list"))
def data(self, column, role=Qt.ItemDataRole.DisplayRole):
"""Returns data for given column and role."""
if role == Qt.ItemDataRole.ToolTipRole:
- return self.db_map_data_field(self.first_db_map, "description")
- if role == Qt.ItemDataRole.FontRole and column == 0:
- bold_font = QFont()
- bold_font.setBold(True)
- return bold_font
- if role == Qt.ForegroundRole and column == 0:
- if not self.has_children():
- return QBrush(Qt.gray)
+ return plain_to_tool_tip(self.db_map_data_field(self.first_db_map, "description"))
+ if column == 0:
+ if role == Qt.ItemDataRole.FontRole:
+ bold_font = QFont()
+ bold_font.setBold(True)
+ return bold_font
+ if role == Qt.ItemDataRole.ForegroundRole:
+ if not self.has_children():
+ return QBrush(Qt.gray)
return super().data(column, role)
+ def _key_for_index(self, db_map):
+ return self.db_map_id(db_map)
+
def accepts_item(self, item, db_map):
return item["class_id"] == self.db_map_id(db_map)
@@ -98,286 +147,181 @@ def set_data(self, column, value, role):
"""See base class."""
return False
+ def _polish_children(self, children):
+ """See base class."""
+ db_map_entity_element_ids = {
+ db_map: {el_id for ent in self.db_mngr.get_items(db_map, "entity") for el_id in ent["element_id_list"]}
+ for db_map in self.db_maps
+ }
+ for child in children:
+ child.set_has_children_initially(
+ any(child.db_map_id(db_map) in db_map_entity_element_ids.get(db_map, ()) for db_map in child.db_maps)
+ )
-class ObjectClassItem(EntityClassItem):
- """An object_class item."""
- item_type = "object_class"
+class EntityItem(MultiDBTreeItem):
+ """An entity item."""
- def __init__(self, *args, **kwargs):
+ visual_key = ["entity_class_name", "entity_byname"]
+ item_type = "entity"
+ _fetch_index = EntityIndex()
+ _entity_group_index = EntityGroupIndex()
+
+ def __init__(self, *args, is_member=False, **kwargs):
super().__init__(*args, **kwargs)
+ self._is_group = False
+ self._is_member = is_member
self._entity_group_fetch_parent = FlexibleFetchParent(
"entity_group",
accepts_item=self._accepts_entity_group_item,
handle_items_added=self._handle_entity_group_items_added,
- handle_items_updated=self._handle_entity_group_items_updated,
+ handle_items_removed=self._handle_entity_group_items_removed,
+ index=self._entity_group_index,
+ key_for_index=self._key_for_entity_group_index,
owner=self,
)
@property
- def child_item_class(self):
- """Returns ObjectItem."""
- return ObjectItem
-
- def default_parameter_data(self):
- """Return data to put as default in a parameter table when this item is selected."""
- return dict(object_class_name=self.display_data, database=self.first_db_map.codename)
-
- @property
- def _children_sort_key(self):
- """Reimplemented so groups are above non-groups."""
- return lambda item: (not item.is_group, item.display_id)
-
- def _can_fetch_more_entity_groups(self):
- result = False
- for db_map in self.db_maps:
- result |= self.db_mngr.can_fetch_more(db_map, self._entity_group_fetch_parent)
- return result
-
- def can_fetch_more(self):
- result = self._can_fetch_more_entity_groups()
- result |= super().can_fetch_more()
- return result
-
- def _fetch_more_entity_groups(self):
- for db_map in self.db_maps:
- self.db_mngr.fetch_more(db_map, self._entity_group_fetch_parent)
-
- def fetch_more(self):
- self._fetch_more_entity_groups()
- super().fetch_more()
-
- def _accepts_entity_group_item(self, item, db_map):
- return item["class_id"] == self.db_map_id(db_map)
-
- def _handle_entity_group_items_added(self, db_map_data):
- self._fetch_more_entity_groups()
- db_map_ids = {db_map: [x["group_id"] for x in data] for db_map, data in db_map_data.items()}
- self.update_children_by_id(db_map_ids, is_group=True)
-
- def _handle_entity_group_items_updated(self, db_map_data):
- db_map_ids = {db_map: [x["group_id"] for x in data] for db_map, data in db_map_data.items()}
- self.update_children_by_id(db_map_ids, is_group=True)
-
- def tear_down(self):
- super().tear_down()
- self._entity_group_fetch_parent.set_obsolete(True)
-
- def revitalize(self):
- """See base class"""
- super().revitalize()
- self._entity_group_fetch_parent.set_obsolete(False)
-
-
-class RelationshipClassItem(EntityClassItem):
- """A relationship_class item."""
-
- visual_key = ["name", "object_class_name_list"]
- item_type = "relationship_class"
+ def is_group(self):
+ if not self._is_group and self._can_fetch_more_entity_groups():
+ self._fetch_more_entity_groups()
+ return self._is_group
@property
def child_item_class(self):
- """Returns RelationshipItem."""
- return RelationshipItem
-
- def default_parameter_data(self):
- """Return data to put as default in a parameter table when this item is selected."""
- return dict(relationship_class_name=self.display_data, database=self.first_db_map.codename)
-
-
-class ObjectRelationshipClassItem(RelationshipClassItem):
- def set_data(self, column, value, role):
- """See base class."""
- return False
-
- def accepts_item(self, item, db_map):
- if not super().accepts_item(item, db_map):
- return False
- object_id = self.parent_item.db_map_id(db_map)
- return object_id in item["object_id_list"]
-
-
-class MembersItem(EntityClassItem):
- """An item to hold members of a group."""
-
- item_type = "members"
-
- @property
- def display_id(self):
- # Return an empty tuple so we never insert anything above this item (see _insert_children_sorted)
- return ()
+ """Child class is always :class:`EntityItem`."""
+ return EntityItem
@property
- def display_data(self):
- return "members"
-
- def db_map_data(self, db_map):
- """Returns data for this item as if it was indeed an object class."""
- id_ = self.db_map_id(db_map)
- return self.db_mngr.get_item(db_map, "object_class", id_)
-
- def _display_icon(self, for_group=False):
- """Returns icon for this item as if it was indeed an object class."""
+ def display_icon(self):
+ """Returns corresponding class icon."""
return self.db_mngr.entity_class_icon(
- self.first_db_map, "object_class", self.db_map_id(self.first_db_map), for_group=False
+ self.first_db_map, self.db_map_data_field(self.first_db_map, "class_id"), for_group=self.is_group
)
- def accepts_item(self, item, db_map):
- return item["group_id"] == self.parent_item.db_map_id(db_map)
-
@property
- def child_item_class(self):
- """Returns MemberObjectItem."""
- return MemberObjectItem
-
- def default_parameter_data(self):
- """Return data to put as default in a parameter table when this item is selected."""
- return dict()
-
- def data(self, column, role=Qt.ItemDataRole.DisplayRole):
- """Returns data for given column and role."""
- if role == Qt.ItemDataRole.FontRole and column == 0:
- bold_font = QFont()
- bold_font.setBold(True)
- return bold_font
- return super().data(column, role)
+ def element_name_list(self):
+ return self.db_map_data_field(self.first_db_map, "element_name_list", default=())
+ @property
+ def element_byname_list(self):
+ return self.db_map_data_field(self.first_db_map, "element_byname_list", default=())
-class EntityItem(MultiDBTreeItem):
- """An entity item."""
+ @property
+ def byname(self):
+ return self.db_map_data_field(self.first_db_map, "entity_byname", default=())
- def __init__(self, *args, is_group=False, **kwargs):
- super().__init__(*args, **kwargs)
- self.is_group = is_group
- self.has_members_item = False
+ @property
+ def entity_class_name(self):
+ return self.db_map_data_field(self.first_db_map, "entity_class_name", default="")
- def update(self, is_group=False):
- self.is_group = is_group
+ @property
+ def entity_class_key(self):
+ return tuple(
+ self.db_map_data_field(self.first_db_map, field) for field in ("entity_class_name", "dimension_name_list")
+ )
- def should_be_merged(self):
- return self.is_group
+ @property
+ def display_data(self):
+ element_byname_list = self.element_byname_list
+ if element_byname_list:
+ element_byname_list = [
+ x
+ if not isinstance(self.parent_item, EntityItem) or x != self.parent_item.byname
+ else ["\u066D"] * len(x)
+ for x in element_byname_list
+ ]
+ return DB_ITEM_SEPARATOR.join([DB_ITEM_SEPARATOR.join(x) for x in element_byname_list])
+ return self.name
@property
- def display_icon(self):
- """Returns corresponding class icon."""
- return self.parent_item._display_icon(for_group=self.is_group)
+ def edit_data(self):
+ return DB_ITEM_SEPARATOR.join(self.byname)
def data(self, column, role=Qt.ItemDataRole.DisplayRole):
if role == Qt.ItemDataRole.ToolTipRole:
- return self.db_map_data_field(self.first_db_map, "description")
+ return plain_to_tool_tip(self.db_map_data_field(self.first_db_map, "description"))
return super().data(column, role)
def set_data(self, column, value, role):
"""See base class."""
return False
- def _can_fetch_members_item(self):
- return self.is_group and not self.has_members_item
-
- def _fetch_members_item(self):
- if self._can_fetch_members_item():
- self.has_members_item = True
- # Insert members item. Note that we pass the db_map_ids of the parent object class item
- self.insert_children(0, [MembersItem(self.model, self.parent_item.db_map_ids.copy())])
-
- def can_fetch_more(self):
- return super().can_fetch_more() or self._can_fetch_members_item()
-
- def fetch_more(self):
- super().fetch_more()
- self._fetch_members_item()
-
-
-class ObjectItem(EntityItem):
- """An object item."""
-
- item_type = "object"
-
- @property
- def child_item_class(self):
- """Child class is always :class:`ObjectRelationshipClassItem`."""
- return ObjectRelationshipClassItem
-
def default_parameter_data(self):
"""Return data to put as default in a parameter table when this item is selected."""
return dict(
- object_class_name=self.db_map_data_field(self.first_db_map, "class_name"),
- object_name=self.display_data,
+ entity_class_name=self.db_map_data_field(self.first_db_map, "entity_class_name"),
+ entity_byname=DB_ITEM_SEPARATOR.join(self.db_map_data_field(self.first_db_map, "entity_byname")),
database=self.first_db_map.codename,
)
- def accepts_item(self, item, db_map):
- if not super().accepts_item(item, db_map):
- return False
- object_class_id = self.db_map_data_field(db_map, 'class_id')
- return object_class_id in item["object_class_id_list"]
-
-
-class MemberObjectItem(ObjectItem):
- """A member object item."""
-
- item_type = "entity_group"
- visual_key = ["member_name"]
-
- @property
- def display_icon(self):
- return self.parent_item.display_icon
+ def is_valid(self):
+ """See base class.
- @property
- def display_data(self):
- """ "Returns the name for display."""
- return self.db_map_data_field(self.first_db_map, "member_name")
+ Additionally, checks that the parent entity (if any) is still an element in this entity.
+ """
+ if not super().is_valid():
+ return False
+ if self.parent_item.item_type == "entity_class":
+ return True
+ if self._is_member:
+ return True
+ return self.parent_item.name in self.element_name_list
- def has_children(self):
- return False
+ def _can_fetch_more_entity_groups(self):
+ result = False
+ for db_map in self.db_maps:
+ result |= self.db_mngr.can_fetch_more(db_map, self._entity_group_fetch_parent)
+ return result
def can_fetch_more(self):
- return False
-
-
-class RelationshipItem(EntityItem):
- """A relationship item."""
-
- visual_key = ["name", "object_name_list"]
- item_type = "relationship"
+ result = self._can_fetch_more_entity_groups()
+ result |= super().can_fetch_more()
+ return result
- def __init__(self, *args, **kwargs):
- """Overridden method to make sure we never try to fetch this item."""
- super().__init__(*args, **kwargs)
- self._fetched = True
+ def _fetch_more_entity_groups(self):
+ for db_map in self.db_maps:
+ self.db_mngr.fetch_more(db_map, self._entity_group_fetch_parent)
- @property
- def object_name_list(self):
- return self.db_map_data_field(self.first_db_map, "object_name_list", default="")
+ def fetch_more(self):
+ self._fetch_more_entity_groups()
+ super().fetch_more()
- @property
- def display_data(self):
- """ "Returns the name for display."""
- return DB_ITEM_SEPARATOR.join(
- [x for x in self.object_name_list if x != self.parent_item.parent_item.display_data]
- )
+ def _key_for_index(self, db_map):
+ return self.db_map_id(db_map)
- @property
- def edit_data(self):
- return DB_ITEM_SEPARATOR.join(self.object_name_list)
+ def _key_for_entity_group_index(self, db_map):
+ return self.db_map_id(db_map)
- def default_parameter_data(self):
- """Return data to put as default in a parameter table when this item is selected."""
- return dict(
- relationship_class_name=self.parent_item.display_data,
- object_name_list=DB_ITEM_SEPARATOR.join(self.object_name_list),
- database=self.first_db_map.codename,
- )
+ def accepts_item(self, item, db_map):
+ return self.db_map_id(db_map) in item["element_id_list"]
- def has_children(self):
- return False
+ def _accepts_entity_group_item(self, item, db_map):
+ return item["group_id"] == self.db_map_id(db_map)
- def can_fetch_more(self):
- return False
+ def _handle_entity_group_items_added(self, db_map_data):
+ db_map_member_ids = {db_map: [x["member_id"] for x in data] for db_map, data in db_map_data.items()}
+ self.append_children_by_id(db_map_member_ids, is_member=True)
+ if not self._is_group:
+ self._is_group = True
+ self.parent_item.reposition_child(self.child_number())
+
+ def _handle_entity_group_items_removed(self, db_map_data):
+ db_map_ids = {db_map: [x["member_id"] for x in data] for db_map, data in db_map_data.items()}
+ self.remove_children_by_id(db_map_ids)
+ if not any(self.db_mngr.get_item(db_map, "entity", self.db_map_id(db_map)) for db_map in self.db_maps):
+ # Not an entity anymore
+ return
+ if self._is_group:
+ if any(
+ self.db_mngr.get_items_by_field(db_map, "entity_group", "group_id", self.db_map_id(db_map))
+ for db_map in self.db_maps
+ ):
+ # Still a group
+ return
+ self._is_group = False
+ self.parent_item.reposition_child(self.child_number())
- def is_valid(self):
- """Checks that the grand parent object is still in the relationship."""
- grand_parent = self.parent_item.parent_item
- if grand_parent.item_type == "root":
- return True
- return grand_parent.display_data in self.object_name_list
+ def tear_down(self):
+ super().tear_down()
+ self._entity_group_fetch_parent.set_obsolete(True)
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/entity_tree_models.py b/spinetoolbox/spine_db_editor/mvcmodels/entity_tree_models.py
index 4fc28b1d4..77736d944 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/entity_tree_models.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/entity_tree_models.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,56 +10,85 @@
# this program. If not, see .
######################################################################################################################
-"""
-Models to represent entities in a tree.
-"""
-
-from .entity_tree_item import ObjectTreeRootItem, RelationshipTreeRootItem
+"""Models to represent entities in a tree."""
+from .entity_tree_item import EntityTreeRootItem
+from .multi_db_tree_item import MultiDBTreeItem
from .multi_db_tree_model import MultiDBTreeModel
-class ObjectTreeModel(MultiDBTreeModel):
- """An 'object-oriented' tree model."""
+class EntityTreeModel(MultiDBTreeModel):
+ def __init__(self, *args, **kwargs):
+ super().__init__(*args, **kwargs)
+ self._hide_empty_classes = (
+ self.db_editor.qsettings.value("appSettings/hideEmptyClasses", defaultValue="false") == "true"
+ )
@property
def root_item_type(self):
- return ObjectTreeRootItem
+ return EntityTreeRootItem
- def find_next_relationship_index(self, index):
+ def find_next_entity_index(self, index):
"""Find and return next occurrence of relationship item."""
if not index.isValid():
return None
- rel_item = self.item_from_index(index)
- if not rel_item.item_type == "relationship":
+ ent_item = self.item_from_index(index)
+ if not (ent_item.item_type == "entity" and ent_item.element_name_list):
return None
# Get all ancestors
- rel_cls_item = rel_item.parent_item
- obj_item = rel_cls_item.parent_item
- for db_map in rel_item.db_maps:
+ el_item = ent_item.parent_item
+ if el_item.item_type != "entity":
+ return
+ for db_map in ent_item.db_maps:
# Get data from ancestors
- rel_data = rel_item.db_map_data(db_map)
- rel_cls_data = rel_cls_item.db_map_data(db_map)
- obj_data = obj_item.db_map_data(db_map)
+ ent_data = ent_item.db_map_data(db_map)
+ el_data = el_item.db_map_data(db_map)
# Get specific data for our searches
- rel_cls_id = rel_cls_data['id']
- obj_id = obj_data['id']
- object_ids = list(reversed(rel_data['object_id_list']))
- object_class_ids = list(reversed(rel_cls_data['object_class_id_list']))
- # Find position in the relationship of the (grand parent) object,
- # then use it to determine object_class and object id to look for
- pos = object_ids.index(obj_id) - 1
- object_id = object_ids[pos]
- object_class_id = object_class_ids[pos]
+ el_id = el_data["id"]
+ element_ids = list(reversed(ent_data["element_id_list"]))
+ dimension_ids = list(reversed(ent_data["dimension_id_list"]))
+ # Find position in the entity of the (grand parent) element,
+ # then use it to determine dimension and element id to look for
+ pos = element_ids.index(el_id) - 1
+ element_id = element_ids[pos]
+ dimension_id = dimension_ids[pos]
# Return first node that passes all cascade filters
- for parent_item in self.find_items(db_map, (object_class_id, object_id, rel_cls_id), fetch=True):
- for item in parent_item.find_children(lambda child: child.display_id == rel_item.display_id):
+ for parent_item in self.find_items(db_map, (dimension_id, element_id), fetch=True):
+ for item in parent_item.find_children(lambda child: child.display_id == ent_item.display_id):
return self.index_from_item(item)
- return None
-
-class RelationshipTreeModel(MultiDBTreeModel):
- """A relationship-oriented tree model."""
+ def save_hide_empty_classes(self):
+ hide_empty_classes = "true" if self.hide_empty_classes else "false"
+ self.db_editor.qsettings.setValue("appSettings/hideEmptyClasses", hide_empty_classes)
@property
- def root_item_type(self):
- return RelationshipTreeRootItem
+ def hide_empty_classes(self):
+ return self._hide_empty_classes
+
+ @hide_empty_classes.setter
+ def hide_empty_classes(self, hide_empty_classes):
+ if self._hide_empty_classes is hide_empty_classes:
+ return
+ self._hide_empty_classes = hide_empty_classes
+ self.root_item.refresh_child_map()
+
+
+def group_items_by_db_map(indexes):
+ """Groups items from given tree indexes by db map.
+
+ Args:
+ indexes (Iterable of QModelIndex): index to entity tree model
+
+ Returns:
+ dict: lists of dictionary items keyed by DatabaseMapping
+ """
+ d = {}
+ for index in indexes:
+ model = index.model()
+ if model is None:
+ continue
+ item = model.item_from_index(index)
+ if item.item_type == "root":
+ continue
+ for db_map in item.db_maps:
+ d.setdefault(db_map, []).append(item.db_map_data(db_map))
+ return d
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/frozen_table_model.py b/spinetoolbox/spine_db_editor/mvcmodels/frozen_table_model.py
index 432a5cf9f..0e6fa64a1 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/frozen_table_model.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/frozen_table_model.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,14 +10,11 @@
# this program. If not, see .
######################################################################################################################
-"""
-Contains FrozenTableModel class.
-"""
+"""Contains FrozenTableModel class."""
from itertools import product
-
from PySide6.QtCore import Qt, QModelIndex, QAbstractTableModel, Signal
from .colors import SELECTED_COLOR
-from ...helpers import rows_to_row_count_tuples
+from ...helpers import plain_to_tool_tip, rows_to_row_count_tuples
class FrozenTableModel(QAbstractTableModel):
@@ -42,13 +40,18 @@ def set_headers(self, headers):
Args:
headers (Iterable of str): headers
+
+ Returns:
+ bool: True if model was reset, False otherwise
"""
headers = list(headers)
if self._data and headers == self._data[0]:
- return
+ return False
self.beginResetModel()
self._data = [headers]
+ self._selected_row = None
self.endResetModel()
+ return True
def clear_model(self):
self.beginResetModel()
@@ -70,7 +73,8 @@ def add_values(self, data):
self.beginInsertRows(QModelIndex(), old_size, old_size + len(new_values) - 1)
self._data += new_values
self.endInsertRows()
- self._keep_sorted()
+ had_data_before = bool(unique_data)
+ self._keep_sorted(update_selected_row=had_data_before)
def remove_values(self, data):
"""Removes frozen values from the table.
@@ -78,29 +82,25 @@ def remove_values(self, data):
Args:
data (set of tuple): frozen values
"""
- removed_i = set()
- for removed_row in data:
- for i, row in enumerate(self._data[1:]):
- if row == removed_row:
- removed_i.add(i + 1)
- break
- if not removed_i:
+ removed_rows = {i + 1 for i, val in enumerate(self._data[1:]) if val in data}
+ if not removed_rows:
return
- frozen_value = self._data[self._selected_row]
- intervals = rows_to_row_count_tuples(removed_i)
- for interval in reversed(intervals):
- end = interval[0] + interval[1]
- self.beginRemoveRows(QModelIndex(), interval[0], end - 1)
- del self._data[interval[0] : end]
- self.endRemoveRows()
- if self._selected_row in removed_i:
- self._selected_row = min(self._selected_row, len(self._data) - 1)
- self.selected_row_changed.emit()
+ if self._selected_row is not None and self._selected_row not in removed_rows:
+ frozen_value = self._data[self._selected_row]
else:
+ frozen_value = None
+ for first, count in reversed(rows_to_row_count_tuples(removed_rows)):
+ last = first + count - 1
+ self.beginRemoveRows(QModelIndex(), first, last)
+ del self._data[first : last + 1]
+ self.endRemoveRows()
+ if frozen_value is not None:
selected_row = self._find_first(frozen_value)
- if selected_row != self._selected_row:
- self._selected_row = selected_row
- self.selected_row_changed.emit()
+ else:
+ selected_row = 1 if len(self._data) > 1 else None
+ if selected_row != self._selected_row:
+ self._selected_row = selected_row
+ self.selected_row_changed.emit()
def clear_selected(self):
"""Clears selected row."""
@@ -128,6 +128,14 @@ def set_selected(self, row):
self.dataChanged.emit(new_bottom_right, new_top_left, [Qt.ItemDataRole.BackgroundRole])
self.selected_row_changed.emit()
+ def get_selected(self):
+ """Returns selected row.
+
+ Returns:
+ int: row index or None if no row is selected
+ """
+ return self._selected_row
+
def get_frozen_value(self):
"""Return currently selected frozen value.
@@ -169,12 +177,12 @@ def insert_column_data(self, header, values, column):
self.endInsertColumns()
return
column_values = self._unique_values()
- new_data = [row for row in product(*column_values[:column], values, *column_values[column:])]
- previous_selected_value = self._data[self._selected_row] if self._selected_row is not None else None
+ new_data = list(product(*column_values[:column], values, *column_values[column:]))
+ previously_selected_value = self._data[self._selected_row] if self._selected_row is not None else None
self.beginResetModel()
self._data[0] = headers[:column] + [header] + headers[column:]
self._data[1:] = new_data
- self._selected_row = self._find_first(previous_selected_value, column)
+ self._selected_row = self._find_first(previously_selected_value, column)
self.endResetModel()
self._keep_sorted()
@@ -196,7 +204,7 @@ def remove_column(self, column):
self.endRemoveColumns()
return
column_values = self._unique_values()
- new_data = [row for row in product(*column_values[:column], *column_values[column + 1 :])]
+ new_data = list(product(*column_values[:column], *column_values[column + 1 :]))
selected_data = self._data[self._selected_row]
self.beginResetModel()
self._data[0] = headers[:column] + headers[column + 1 :]
@@ -220,7 +228,7 @@ def moveColumns(self, sourceParent, sourceColumn, count, destinationParent, dest
self._keep_sorted()
return True
- def _keep_sorted(self):
+ def _keep_sorted(self, update_selected_row=True):
"""Sorts the data table."""
if len(self._data) < 3:
return
@@ -235,11 +243,21 @@ def _keep_sorted(self):
key=lambda x: tuple(self._name_from_data(x[column], header[column]) for column in range(column_count)),
)
self._data[1:] = data
+ selected_row_changed = False
if frozen_value is not None:
- self._selected_row = self._find_first(frozen_value)
+ if update_selected_row:
+ candidate = self._find_first(frozen_value)
+ if self._selected_row != candidate:
+ self._selected_row = candidate
+ selected_row_changed = True
+ elif frozen_value != self.get_frozen_value():
+ # The row did not change but the frozen value did.
+ selected_row_changed = True
self.layoutChanged["QList", "QAbstractItemModel::LayoutChangeHint"].emit(
[], QAbstractTableModel.LayoutChangeHint.VerticalSortHint
)
+ if selected_row_changed:
+ self.selected_row_changed.emit()
def _unique_values(self):
"""Turns non-header data into sets of unique values on each column.
@@ -309,22 +327,26 @@ def _tooltip_from_data(self, row, column):
header = self._data[0][column]
if header == "parameter":
db_map, id_ = value
- return self.db_mngr.get_item(db_map, "parameter_definition", id_)["description"]
- if header == "alternative":
+ tool_tip = self.db_mngr.get_item(db_map, "parameter_definition", id_).get("description")
+ elif header == "alternative":
db_map, id_ = value
- return self.db_mngr.get_item(db_map, "alternative", id_)["description"]
- if header == "index":
- return str(value[1])
- if header == "database":
- return value.codename
- db_map, id_ = value
- return self.db_mngr.get_item(db_map, "object", id_)["description"]
+ tool_tip = self.db_mngr.get_item(db_map, "alternative", id_).get("description")
+ elif header == "index":
+ tool_tip = str(value[1])
+ elif header == "database":
+ tool_tip = value.codename
+ elif header == "entity":
+ db_map, id_ = value
+ tool_tip = self.db_mngr.get_item(db_map, "entity", id_).get("description")
+ else:
+ raise RuntimeError(f"Logic error: unknown header '{header}'")
+ return plain_to_tool_tip(tool_tip)
def _name_from_data(self, value, header):
"""Resolves item name.
Args:
- value (tuple or DatabaseMappingBase): cell value
+ value (tuple or DatabaseMapping): cell value
header (str): column header
Returns:
@@ -333,7 +355,7 @@ def _name_from_data(self, value, header):
if header == "parameter":
db_map, id_ = value
item = self.db_mngr.get_item(db_map, "parameter_definition", id_)
- return item.get("parameter_name")
+ return item.get("name")
if header == "alternative":
db_map, id_ = value
item = self.db_mngr.get_item(db_map, "alternative", id_)
@@ -343,7 +365,7 @@ def _name_from_data(self, value, header):
if header == "database":
return value.codename
db_map, id_ = value
- item = self.db_mngr.get_item(db_map, "object", id_)
+ item = self.db_mngr.get_item(db_map, "entity", id_)
return item.get("name")
@property
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/item_metadata_table_model.py b/spinetoolbox/spine_db_editor/mvcmodels/item_metadata_table_model.py
index 6e1f65ab8..e92300d58 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/item_metadata_table_model.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/item_metadata_table_model.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,14 +10,8 @@
# this program. If not, see .
######################################################################################################################
-"""
-Contains :class:`ItemMetadataTableModel` and associated functionality.
-"""
+"""Contains :class:`ItemMetadataTableModel` and associated functionality."""
from enum import auto, Enum, IntEnum, unique
-
-from PySide6.QtCore import QModelIndex
-
-from spinetoolbox.helpers import rows_to_row_count_tuples
from spinetoolbox.fetch_parent import FlexibleFetchParent
from .metadata_table_model_base import Column, FLAGS_EDITABLE, FLAGS_FIXED, MetadataTableModelBase
@@ -47,7 +42,7 @@ def __init__(self, db_mngr, db_maps, db_editor):
"""
Args:
db_mngr (SpineDBManager): database manager
- db_maps (Iterable of DatabaseMappingBase): database maps
+ db_maps (Iterable of DatabaseMapping): database maps
db_editor (SpineDBEditor): DB editor
"""
super().__init__(db_mngr, db_maps, db_editor)
@@ -125,7 +120,7 @@ def _reset_metadata(self, item_type, db_map_ids):
self.beginResetModel()
self._item_type = item_type
self._item_ids = dict(db_map_ids)
- self._db_maps = set(db_map_ids.keys())
+ self._db_maps = set(db_map_ids)
default_db_map = next(iter(self._db_maps)) if self._db_maps else None
self._adder_row = self._make_adder_row(default_db_map)
self._data = []
@@ -133,7 +128,7 @@ def _reset_metadata(self, item_type, db_map_ids):
def _reset_fetch_parents(self):
for parent in self._fetch_parents():
- parent.reset_fetching(None)
+ parent.reset()
if self.canFetchMore(None):
self.fetchMore(None)
@@ -141,36 +136,25 @@ def _add_data_to_db_mngr(self, name, value, db_map):
"""See base class."""
item_id = self._item_ids[db_map]
if self._item_type == ItemType.ENTITY:
- self._db_mngr.add_entity_metadata(
+ self._db_mngr.add_ext_entity_metadata(
{db_map: [{"entity_id": item_id, "metadata_name": name, "metadata_value": value}]}
)
else:
- self._db_mngr.add_parameter_value_metadata(
+ self._db_mngr.add_ext_parameter_value_metadata(
{db_map: [{"parameter_value_id": item_id, "metadata_name": name, "metadata_value": value}]}
)
def _update_data_in_db_mngr(self, id_, name, value, db_map):
"""See base class"""
if self._item_type == ItemType.ENTITY:
- self._db_mngr.update_entity_metadata(
+ self._db_mngr.update_ext_entity_metadata(
{db_map: [{"id": id_, "metadata_name": name, "metadata_value": value}]}
)
else:
- self._db_mngr.update_parameter_value_metadata(
+ self._db_mngr.update_ext_parameter_value_metadata(
{db_map: [{"id": id_, "metadata_name": name, "metadata_value": value}]}
)
- def rollback(self, _db_maps):
- """Rolls back changes in database.
-
- Args:
- db_maps (Iterable of DiffDatabaseMapping): database mappings that have been rolled back
- """
- self.beginResetModel()
- self._data = []
- self.endResetModel()
- self._reset_fetch_parents()
-
def flags(self, index):
row = index.row()
column = index.column()
@@ -217,13 +201,7 @@ def update_item_metadata(self, db_map_data):
Args:
db_map_data (dict): updated metadata records
"""
- for db_map, items in db_map_data.items():
- for item in items:
- for row in self._data:
- if db_map != row[Column.DB_MAP] or item["id"] != row[ExtraColumn.ITEM_METADATA_ID]:
- continue
- row[ExtraColumn.METADATA_ID] = item["metadata_id"]
- break
+ self._update_data(db_map_data, ExtraColumn.ITEM_METADATA_ID)
def remove_item_metadata(self, db_map_data):
"""Removes item metadata from model after it has been removed from databases.
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/metadata_table_model.py b/spinetoolbox/spine_db_editor/mvcmodels/metadata_table_model.py
index 1ab36cb45..c58ff1dff 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/metadata_table_model.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/metadata_table_model.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,12 +10,8 @@
# this program. If not, see .
######################################################################################################################
-"""
-Contains :class:`MetadataTableModel` and associated functionality.
-"""
+"""Contains :class:`MetadataTableModel` and associated functionality."""
from enum import IntEnum, unique
-from PySide6.QtCore import QModelIndex, Qt
-from spinetoolbox.helpers import rows_to_row_count_tuples
from spinetoolbox.fetch_parent import FlexibleFetchParent
from .metadata_table_model_base import Column, FLAGS_FIXED, FLAGS_EDITABLE, MetadataTableModelBase
@@ -36,7 +33,7 @@ def __init__(self, db_mngr, db_maps, db_editor):
"""
Args:
db_mngr (SpineDBManager): database manager
- db_maps (Iterable of DatabaseMappingBase): database maps
+ db_maps (Iterable of DatabaseMapping): database maps
db_editor (SpineDBEditor): DB editor
"""
super().__init__(db_mngr, db_maps, db_editor)
@@ -61,24 +58,6 @@ def _update_data_in_db_mngr(self, id_, name, value, db_map):
"""See base class"""
self._db_mngr.update_metadata({db_map: [{"id": id_, "name": name, "value": value}]})
- def rollback(self, db_maps):
- """Rolls back changes in database.
-
- Args:
- db_maps (Iterable of DiffDatabaseMapping): database mappings that have been rolled back
- """
- spans = rows_to_row_count_tuples(
- i for db_map in db_maps for i, row in enumerate(self._data) if row[Column.DB_MAP] == db_map
- )
- for span in spans:
- first = span[0]
- last = span[0] + span[1] - 1
- self.beginRemoveRows(QModelIndex(), first, last)
- self._data = self._data[:first] + self._data[last + 1 :]
- self.endRemoveRows()
- if self.canFetchMore(QModelIndex()):
- self.fetchMore(QModelIndex())
-
def _database_table_name(self):
"""See base class"""
return "metadata"
@@ -125,25 +104,7 @@ def update_metadata(self, db_map_data):
Args:
db_map_data (dict): updated metadata items keyed by database mapping
"""
- for items in db_map_data.values():
- items_by_id = {item["id"]: item for item in items}
- updated_rows = []
- for row_index, row in enumerate(self._data):
- if row[ExtraColumn.ID] is None:
- continue
- db_item = items_by_id.get(row[ExtraColumn.ID])
- if db_item is None:
- continue
- if row[Column.NAME] != db_item["name"]:
- row[Column.NAME] = db_item["name"]
- updated_rows.append(row_index)
- if row[Column.VALUE] != db_item["value"]:
- row[Column.VALUE] = db_item["value"]
- updated_rows.append(row_index)
- if updated_rows:
- top_left = self.index(updated_rows[0], 0)
- bottom_right = self.index(updated_rows[-1], Column.DB_MAP - 1)
- self.dataChanged.emit(top_left, bottom_right, [Qt.ItemDataRole.DisplayRole])
+ self._update_data(db_map_data, ExtraColumn.ID)
def remove_metadata(self, db_map_data):
"""Removes metadata from model after it has been removed from databases.
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/metadata_table_model_base.py b/spinetoolbox/spine_db_editor/mvcmodels/metadata_table_model_base.py
index 7bb99534f..9ed04cc88 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/metadata_table_model_base.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/metadata_table_model_base.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,12 +10,9 @@
# this program. If not, see .
######################################################################################################################
-"""
-Contains base class for metadata table models associated functionality.
-"""
+"""Contains base class for metadata table models associated functionality."""
from enum import IntEnum, unique
from operator import itemgetter
-
from PySide6.QtCore import QAbstractTableModel, QModelIndex, Qt, Signal
from spinetoolbox.helpers import rows_to_row_count_tuples
from .colors import FIXED_FIELD_COLOR
@@ -51,7 +49,7 @@ def __init__(self, db_mngr, db_maps, db_editor):
"""
Args:
db_mngr (SpineDBManager): database manager
- db_maps (Iterable of DatabaseMappingBase): database maps
+ db_maps (Iterable of DatabaseMapping): database maps
db_editor (SpineDBEditor): DB editor
"""
super().__init__(db_editor)
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/mime_types.py b/spinetoolbox/spine_db_editor/mvcmodels/mime_types.py
index 4ce28e831..3de2ac578 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/mime_types.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/mime_types.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -8,6 +9,7 @@
# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
# this program. If not, see .
######################################################################################################################
+
"""Contains mime types used by the models."""
ALTERNATIVE_DATA = "application/vnd.spinetoolbox.alternative"
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/multi_db_tree_item.py b/spinetoolbox/spine_db_editor/mvcmodels/multi_db_tree_item.py
index bd73a7cd0..c35f85b08 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/multi_db_tree_item.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/multi_db_tree_item.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,11 +10,8 @@
# this program. If not, see .
######################################################################################################################
-"""
-Base classes to represent items from multiple databases in a tree.
-"""
+"""Base classes to represent items from multiple databases in a tree."""
from operator import attrgetter
-
from PySide6.QtCore import Qt
from ...helpers import rows_to_row_count_tuples, bisect_chunks
from ...fetch_parent import FlexibleFetchParent
@@ -26,38 +24,65 @@ class MultiDBTreeItem(TreeItem):
item_type = None
"""Item type identifier string. Should be set to a meaningful value by subclasses."""
visual_key = ["name"]
+ _fetch_index = None
- def __init__(self, model=None, db_map_ids=None):
- """Init class.
-
+ def __init__(self, model, db_map_ids=None):
+ """
Args:
model (MinimalTreeModel, optional): item's model
- db_map_ids (dict, optional): maps instances of DiffDatabaseMapping to the id of the item in that db
+ db_map_ids (dict, optional): maps instances of DatabaseMapping to the id of the item in that db
"""
super().__init__(model)
if db_map_ids is None:
db_map_ids = {}
self._db_map_ids = db_map_ids
- self._child_map = dict() # Maps db_map to id to row number
+ self._child_map = {} # Maps db_map to id to row number
self._fetch_parent = FlexibleFetchParent(
self.fetch_item_type,
accepts_item=self.accepts_item,
handle_items_added=self.handle_items_added,
handle_items_removed=self.handle_items_removed,
handle_items_updated=self.handle_items_updated,
- will_have_children_change=self.will_have_children_change,
+ index=self._fetch_index,
+ key_for_index=self._key_for_index,
owner=self,
)
+ @property
+ def visible_children(self):
+ return self.children
+
+ def row_count(self):
+ """Overriden to use visible_children."""
+ return len(self.visible_children)
+
+ def child(self, row):
+ """Overriden to use visible_children."""
+ if 0 <= row < self.row_count():
+ return self.visible_children[row]
+ return None
+
def child_number(self):
+ """Overriden to use find_row which is a dict-lookup rather than a list.index() call."""
+ if not self.parent_item:
+ return None
try:
db_map, id_ = next(iter(self._db_map_ids.items()))
except StopIteration:
- return -1
- try:
+ return None
+ if isinstance(self.parent_item, MultiDBTreeItem):
return self.parent_item.find_row(db_map, id_)
- except AttributeError:
- return super().child_number()
+ return 0
+
+ def refresh_child_map(self):
+ """Recomputes the child map."""
+ self.model.layoutAboutToBeChanged.emit()
+ self._child_map.clear()
+ for row, child in enumerate(self.visible_children):
+ for db_map in child.db_maps:
+ id_ = child.db_map_id(db_map)
+ self._child_map.setdefault(db_map, {})[id_] = row
+ self.model.layoutChanged.emit()
def set_data(self, column, value, role):
raise NotImplementedError()
@@ -68,8 +93,8 @@ def db_mngr(self):
@property
def child_item_class(self):
- """Returns the type of child items. Reimplement in subclasses to return something more meaningful."""
- return MultiDBTreeItem
+ """Returns the type of child items."""
+ raise NotImplementedError()
@property
def display_id(self):
@@ -81,10 +106,14 @@ def display_id(self):
return None
return next(iter(ids))
+ @property
+ def name(self):
+ return self.db_map_data_field(self.first_db_map, "name", default="")
+
@property
def display_data(self):
"""Returns the name for display."""
- return self.db_map_data_field(self.first_db_map, "name")
+ return self.name
@property
def display_database(self):
@@ -100,17 +129,12 @@ def display_icon(self):
@property
def first_db_map(self):
"""Returns the first associated db_map."""
- return list(self._db_map_ids.keys())[0]
-
- @property
- def last_db_map(self):
- """Returns the last associated db_map."""
- return list(self._db_map_ids.keys())[-1]
+ return next(iter(self._db_map_ids))
@property
def db_maps(self):
"""Returns a list of all associated db_maps."""
- return list(self._db_map_ids.keys())
+ return list(self._db_map_ids)
@property
def db_map_ids(self):
@@ -128,20 +152,20 @@ def take_db_map(self, db_map):
"""Removes the mapping for given db_map and returns it."""
return self._db_map_ids.pop(db_map, None)
- def _deep_refresh_children(self):
+ def deep_refresh_children(self):
"""Refreshes children after taking db_maps from them.
Called after removing and updating children for this item."""
removed_rows = []
for row, child in reversed(list(enumerate(self.children))):
- if not child._db_map_ids:
+ if not child.db_map_ids:
removed_rows.append(row)
for row, count in reversed(rows_to_row_count_tuples(removed_rows)):
self.remove_children(row, count)
for row, child in enumerate(self.children):
- child._deep_refresh_children()
+ child.deep_refresh_children()
if self.children:
top_row = 0
- bottom_row = self.child_count() - 1
+ bottom_row = self.row_count() - 1
top_index = self.children[top_row].index().sibling(top_row, 1)
bottom_index = self.children[bottom_row].index().sibling(bottom_row, 1)
self.model.dataChanged.emit(top_index, bottom_index)
@@ -162,7 +186,7 @@ def deep_take_db_map(self, db_map):
id_ = self.take_db_map(db_map)
if id_ is None:
return None
- other = type(self)(model=self.model, db_map_ids={db_map: id_})
+ other = self.parent_item.make_or_restore_child({db_map: id_})
other_children = []
for child in self.children:
other_child = child.deep_take_db_map(db_map)
@@ -174,7 +198,7 @@ def deep_take_db_map(self, db_map):
def deep_merge(self, other):
"""Merges another item and all its descendants into this one."""
if not isinstance(other, type(self)):
- raise ValueError(f"Can't merge an instance of {type(other)} into a MultiDBTreeItem.")
+ raise ValueError(f"Can't merge an instance of {type(other).__name__} into a MultiDBTreeItem.")
for db_map in other.db_maps:
self.add_db_map_id(db_map, other.db_map_id(db_map))
self._merge_children(other.children)
@@ -184,7 +208,7 @@ def db_map_id(self, db_map):
return self._db_map_ids.get(db_map)
def db_map_data(self, db_map):
- """Returns data for this item in given db_map or None if not present."""
+ """Returns data for this item in given db_map or an empty dict if not present."""
id_ = self.db_map_id(db_map)
return self.db_mngr.get_item(db_map, self.item_type, id_)
@@ -203,12 +227,43 @@ def _create_new_children(self, db_map, children_ids, **kwargs):
Returns:
list of MultiDBTreeItem: new children
"""
- return [self.child_item_class(self.model, {db_map: id_}, **kwargs) for id_ in children_ids]
+ return [self.make_or_restore_child(db_map, id_, **kwargs) for id_ in children_ids]
+
+ def make_or_restore_child(self, db_map, id_, **kwargs):
+ """Makes or restores a child if one was ever made using given db_map and id.
+ The purpose of restoring is to keep using the same FetchParent,
+ which is useful in case the user undoes a series of removal operations
+ that would add items in cascade to the tree.
+
+ Args:
+ db_map (DatabaseMapping)
+ id (int)
+
+ Returns:
+ MultiDBTreemItem
+ """
+ db_map_ids = {db_map: id_}
+ key = (db_map, id_)
+ child = self._created_children.get(key)
+ if child is not None:
+ child.restore(db_map_ids, **kwargs)
+ return child
+ child = self._created_children[key] = self._make_child(db_map_ids, **kwargs)
+ return child
+
+ def restore(self, db_map_ids, **kwargs):
+ self._db_map_ids.update(db_map_ids)
+
+ def _make_child(self, db_map_ids, **kwargs):
+ return self.child_item_class(self.model, db_map_ids, **kwargs)
def _merge_children(self, new_children):
"""Merges new children into this item. Ensures that each child has a valid display id afterwards."""
if not new_children:
return
+ if len(self._db_map_ids) == 1:
+ self._insert_children_sorted(new_children)
+ return
existing_children = {child.display_id: child for child in self.children}
unmerged = []
for new_child in new_children:
@@ -222,13 +277,13 @@ def _merge_children(self, new_children):
existing_children[new_child.display_id] = new_child
unmerged.append(new_child)
if not unmerged:
- self._refresh_child_map()
+ self.refresh_child_map()
return
self._insert_children_sorted(unmerged)
def _insert_children_sorted(self, new_children):
"""Inserts and sorts children."""
- new_children = sorted(new_children, key=attrgetter("display_id"))
+ new_children = sorted(new_children, key=self._children_sort_key)
for chunk, pos in bisect_chunks(self.children, new_children, key=self._children_sort_key):
self.insert_children(pos, chunk)
@@ -236,11 +291,6 @@ def _insert_children_sorted(self, new_children):
def _children_sort_key(self):
return attrgetter("display_id")
- def will_have_children_change(self):
- """Notifies the view that the model's layout has changed.
- This triggers a repaint so this item will be painted gray if no children."""
- self.model.layoutChanged.emit()
-
@property
def fetch_item_type(self):
return self.child_item_class.item_type
@@ -264,6 +314,9 @@ def fetch_more_if_possible(self):
if self.can_fetch_more():
self.fetch_more()
+ def _key_for_index(self, db_map):
+ return None
+
def accepts_item(self, item, db_map):
return True
@@ -301,11 +354,11 @@ def remove_children_by_id(self, db_map_ids):
for db_map, ids in db_map_ids.items():
for child in self.find_children_by_id(db_map, *ids, reverse=True):
child.deep_remove_db_map(db_map)
- self._deep_refresh_children()
+ self.deep_refresh_children()
- def is_valid(self): # pylint: disable=no-self-use
- """Checks if the item is still valid after an update operation."""
- return True
+ def is_valid(self):
+ """See base class."""
+ return bool(self._db_map_ids)
def update_children_by_id(self, db_map_ids, **kwargs):
"""
@@ -328,7 +381,7 @@ def update_children_by_id(self, db_map_ids, **kwargs):
for db_map, ids in db_map_ids.items():
for id_ in ids:
row = self.find_row(db_map, id_)
- if row != -1:
+ if row is not None:
rows_to_update.add(row)
else:
db_map_ids_to_add.setdefault(db_map, set()).add(id_)
@@ -339,7 +392,6 @@ def update_children_by_id(self, db_map_ids, **kwargs):
display_ids = [child.display_id for child in self.children if child.display_id is not None]
for row in sorted(rows_to_update, reverse=True):
child = self.child(row)
- child.update(**kwargs)
if not child:
continue
if not child.is_valid():
@@ -351,61 +403,54 @@ def update_children_by_id(self, db_map_ids, **kwargs):
db_map = child.first_db_map
new_child = child.deep_take_db_map(db_map)
new_children.append(new_child)
- if child.display_id in display_ids[:row] + display_ids[row + 1 :] or child.should_be_merged():
+ if child.display_id in display_ids[:row] + display_ids[row + 1 :]:
# Take the child and put it in the list to be merged
+ new_children.append(child)
self.remove_children(row, 1)
display_ids.pop(row)
- child.revitalize()
new_children.append(child)
- self._deep_refresh_children()
+ self.deep_refresh_children()
self._merge_children(new_children)
top_left = self.model.index(0, 0, self.index())
- bottom_right = self.model.index(self.child_count() - 1, 0, self.index())
+ bottom_right = self.model.index(self.row_count() - 1, 0, self.index())
self.model.dataChanged.emit(top_left, bottom_right)
- def update(self, **kwargs):
- pass
-
- def should_be_merged(self):
- return False
-
def insert_children(self, position, children):
- """Insert new children at given position. Returns a boolean depending on how it went.
+ """Inserts new children at given position.
Args:
position (int): insert new items here
- children (iter): insert items from this iterable
+ children (Iterable of MultiDBTreeItem): insert items from this iterable
+
+ Returns:
+ bool: True if children were inserted successfully, False otherwise
"""
bad_types = [type(child) for child in children if not isinstance(child, MultiDBTreeItem)]
if bad_types:
- raise TypeError(f"Cand't insert children of type {bad_types} to an item of type {type(self)}")
+ raise TypeError(f"Can't insert children of type {bad_types} to an item of type {type(self)}")
if not super().insert_children(position, children):
return False
- self._refresh_child_map()
+ self.refresh_child_map()
+ for child in children:
+ child.register_fetch_parent()
return True
def remove_children(self, position, count):
"""Removes count children starting from the given position."""
if super().remove_children(position, count):
- self._refresh_child_map()
+ self.refresh_child_map()
return True
return False
- def clear_children(self):
- """Clear children list."""
- super().clear_children()
- self._child_map.clear()
-
- def _refresh_child_map(self):
- """Recomputes the child map."""
- self._child_map.clear()
- for row, child in enumerate(self.children):
- for db_map in child.db_maps:
- id_ = child.db_map_id(db_map)
- self._child_map.setdefault(db_map, dict())[id_] = row
+ def reposition_child(self, row):
+ child = self.child(row)
+ if not child:
+ return
+ self.remove_children(row, 1)
+ self._insert_children_sorted([child])
def find_row(self, db_map, id_):
- return self._child_map.get(db_map, {}).get(id_, -1)
+ return self._child_map.get(db_map, {}).get(id_)
def find_children_by_id(self, db_map, *ids, reverse=True):
"""Generates children with the given ids in the given db_map.
@@ -427,20 +472,21 @@ def _find_unsorted_rows_by_id(self, db_map, *ids):
# Yield all children with the db_map *and* the id
for id_ in ids:
row = self.find_row(db_map, id_)
- if row != -1:
+ if row is not None:
yield row
def data(self, column, role=Qt.ItemDataRole.DisplayRole):
"""Returns data for given column and role."""
- if column == 0:
- if role == Qt.ItemDataRole.DecorationRole:
- return self.display_icon
- if role == Qt.ItemDataRole.DisplayRole:
+ if role == Qt.ItemDataRole.DisplayRole:
+ if column == 0:
return self.display_data
- if role == Qt.ItemDataRole.EditRole:
- return self.edit_data
- if column and role == Qt.ItemDataRole.DisplayRole:
- return self.display_database
+ if column == 1:
+ return self.display_database
+ if role == Qt.ItemDataRole.DecorationRole:
+ if column == 0:
+ return self.display_icon
+ if role == Qt.ItemDataRole.EditRole:
+ return self.edit_data
def default_parameter_data(self):
"""Returns data to set as default in a parameter table when this item is selected."""
@@ -450,8 +496,7 @@ def tear_down(self):
super().tear_down()
self._fetch_parent.set_obsolete(True)
- def revitalize(self):
- """Reverts tear down operation"""
- self._fetch_parent.set_obsolete(False)
- for child in self._children:
- child.revitalize()
+ def register_fetch_parent(self):
+ """Registers item's fetch parent for all model's databases."""
+ for db_map in self.model.db_maps:
+ self.model.db_mngr.register_fetch_parent(db_map, self._fetch_parent)
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/multi_db_tree_model.py b/spinetoolbox/spine_db_editor/mvcmodels/multi_db_tree_model.py
index 04109a25d..7a9650524 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/multi_db_tree_model.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/multi_db_tree_model.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,9 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-A base model class to represent items from multiple databases in a tree.
-"""
+"""A base model class to represent items from multiple databases in a tree."""
from PySide6.QtCore import QModelIndex, Qt
from ...mvcmodels.minimal_tree_model import MinimalTreeModel, TreeItem
@@ -25,12 +24,14 @@ def __init__(self, db_editor, db_mngr, *db_maps):
Args:
db_editor (SpineDBEditor)
db_mngr (SpineDBManager): A manager for the given db_maps
- db_maps (iter): DiffDatabaseMapping instances
+ *db_maps: DatabaseMapping instances
"""
super().__init__(db_editor)
self.db_editor = db_editor
self.db_mngr = db_mngr
self.db_maps = db_maps
+ self._invisible_root_item = TreeItem(self)
+ self.destroyed.connect(lambda obj=None: self._invisible_root_item.tear_down_recursively())
self._root_item = None
@property
@@ -46,20 +47,26 @@ def root_item(self):
def root_index(self):
return self.index_from_item(self._root_item)
+ @property
+ def _header_labels(self):
+ return ("name", "database")
+
def build_tree(self):
"""Builds tree."""
- self.beginResetModel()
- self._invisible_root_item = TreeItem(self)
+ if self._invisible_root_item.has_children():
+ self.beginRemoveRows(QModelIndex(), 0, self.rowCount() - 1)
+ self._invisible_root_item = TreeItem(self)
+ self.destroyed.connect(lambda obj=None: self._invisible_root_item.tear_down_recursively())
+ self.endRemoveRows()
self._root_item = self.root_item_type(self, dict.fromkeys(self.db_maps))
self._invisible_root_item.append_children([self._root_item])
- self.endResetModel()
def columnCount(self, parent=QModelIndex()):
- return 2
+ return len(self._header_labels)
def headerData(self, section, orientation, role=Qt.ItemDataRole.DisplayRole):
if orientation == Qt.Orientation.Horizontal and role == Qt.ItemDataRole.DisplayRole:
- return ("name", "database")[section]
+ return self._header_labels[section]
return None
def find_items(self, db_map, path_prefix, fetch=False):
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/parameter_mixins.py b/spinetoolbox/spine_db_editor/mvcmodels/parameter_mixins.py
deleted file mode 100644
index c1a8cef35..000000000
--- a/spinetoolbox/spine_db_editor/mvcmodels/parameter_mixins.py
+++ /dev/null
@@ -1,564 +0,0 @@
-######################################################################################################################
-# Copyright (C) 2017-2022 Spine project consortium
-# This file is part of Spine Toolbox.
-# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
-# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
-# any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
-# without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
-# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
-# this program. If not, see .
-######################################################################################################################
-
-"""
-Miscelaneous mixins for parameter models
-"""
-
-from spinedb_api.parameter_value import split_value_and_type
-
-
-class ConvertToDBMixin:
- """Base class for all mixins that convert model items (name-based) into database items (id-based)."""
-
- def build_lookup_dictionary(self, db_map_data):
- """Begins an operation to convert items."""
-
- # pylint: disable=no-self-use
- def _convert_to_db(self, item, db_map):
- """Returns a db item (id-based) from the given model item (name-based).
-
- Args:
- item (dict): the model item
- db_map (DiffDatabaseMapping): the database where the resulting item belongs
-
- Returns:
- dict: the db item
- list: error log
- """
- item = item.copy()
- value_field, type_field = {
- "parameter_value": ("value", "type"),
- "parameter_definition": ("default_value", "default_type"),
- }[self.item_type]
- if value_field in item:
- value, value_type = split_value_and_type(item[value_field])
- item[value_field] = value
- item[type_field] = value_type
- return item, []
-
-
-class FillInAlternativeIdMixin(ConvertToDBMixin):
- """Fills in alternative names."""
-
- def __init__(self, *args, **kwargs):
- """Initializes lookup dicts."""
- super().__init__(*args, **kwargs)
- self._db_map_alt_lookup = dict()
-
- def build_lookup_dictionary(self, db_map_data):
- """Builds a name lookup dictionary for the given data.
-
- Args:
- db_map_data (dict): lists of model items keyed by DiffDatabaseMapping
- """
- super().build_lookup_dictionary(db_map_data)
- # Group data by name
- db_map_names = dict()
- for db_map, items in db_map_data.items():
- for item in items:
- name = item.get("alternative_name")
- db_map_names.setdefault(db_map, set()).add(name)
- # Build lookup dict
- self._db_map_alt_lookup.clear()
- for db_map, names in db_map_names.items():
- for name in names:
- item = self.db_mngr.get_item_by_field(db_map, "alternative", "name", name, only_visible=False)
- if item:
- self._db_map_alt_lookup.setdefault(db_map, {})[name] = item
-
- def _convert_to_db(self, item, db_map):
- """Returns a db item (id-based) from the given model item (name-based).
-
- Args:
- item (dict): the model item
- db_map (DiffDatabaseMapping): the database where the resulting item belongs
-
- Returns:
- dict: the db item
- list: error log
- """
- item, err = super()._convert_to_db(item, db_map)
- alt_name = item.pop("alternative_name", None)
- alt = self._db_map_alt_lookup.get(db_map, {}).get(alt_name)
- if not alt:
- return item, err + [f"Unknown alternative name {alt_name}"] if alt_name else err
- item["alternative_id"] = alt["id"]
- return item, err
-
-
-class FillInParameterNameMixin(ConvertToDBMixin):
- """Fills in parameter names."""
-
- def _convert_to_db(self, item, db_map):
- """Returns a db item (id-based) from the given model item (name-based).
-
- Args:
- item (dict): the model item
- db_map (DiffDatabaseMapping): the database where the resulting item belongs
-
- Returns:
- dict: the db item
- list: error log
- """
- item, err = super()._convert_to_db(item, db_map)
- name = item.pop("parameter_name", None)
- if name:
- item["name"] = name
- return item, err
-
-
-class FillInValueListIdMixin(ConvertToDBMixin):
- """Fills in value list ids."""
-
- def __init__(self, *args, **kwargs):
- """Initializes lookup dicts."""
- super().__init__(*args, **kwargs)
- self._db_map_value_list_lookup = dict()
-
- def build_lookup_dictionary(self, db_map_data):
- """Builds a name lookup dictionary for the given data.
-
- Args:
- db_map_data (dict): lists of model items keyed by DiffDatabaseMapping
- """
- super().build_lookup_dictionary(db_map_data)
- # Group data by name
- db_map_value_list_names = dict()
- for db_map, items in db_map_data.items():
- for item in items:
- value_list_name = item.get("value_list_name")
- db_map_value_list_names.setdefault(db_map, set()).add(value_list_name)
- # Build lookup dict
- self._db_map_value_list_lookup.clear()
- for db_map, names in db_map_value_list_names.items():
- for name in names:
- item = self.db_mngr.get_item_by_field(db_map, "parameter_value_list", "name", name, only_visible=False)
- if item:
- self._db_map_value_list_lookup.setdefault(db_map, {})[name] = item
-
- def _convert_to_db(self, item, db_map):
- """Returns a db item (id-based) from the given model item (name-based).
-
- Args:
- item (dict): the model item
- db_map (DiffDatabaseMapping): the database where the resulting item belongs
-
- Returns:
- dict: the db item
- list: error log
- """
- item, err1 = super()._convert_to_db(item, db_map)
- err2 = self._fill_in_value_list_id(item, db_map)
- return item, err1 + err2
-
- def _fill_in_value_list_id(self, item, db_map):
- """Fills in the value list id in the given db item.
-
- Args:
- item (dict): the db item
- db_map (DiffDatabaseMapping): the database where the given item belongs
-
- Returns:
- list: error log
- """
- if "value_list_name" not in item:
- return []
- value_list_name = item.pop("value_list_name")
- if value_list_name:
- value_list = self._db_map_value_list_lookup.get(db_map, {}).get(value_list_name)
- if not value_list:
- return [f"Unknown value list name {value_list_name}"] if value_list_name else []
- item["parameter_value_list_id"] = value_list["id"]
- else:
- item["parameter_value_list_id"] = None
- return []
-
-
-class FillInEntityClassIdMixin(ConvertToDBMixin):
- """Fills in entity_class ids."""
-
- def __init__(self, *args, **kwargs):
- """Initializes lookup dicts."""
- super().__init__(*args, **kwargs)
- self._db_map_ent_cls_lookup = dict()
-
- def build_lookup_dictionary(self, db_map_data):
- """Builds a name lookup dictionary for the given data.
-
- Args:
- db_map_data (dict): lists of model items keyed by DiffDatabaseMapping
- """
- super().build_lookup_dictionary(db_map_data)
- # Group data by name
- db_map_names = dict()
- for db_map, items in db_map_data.items():
- for item in items:
- entity_class_name = item.get(self.entity_class_name_key)
- db_map_names.setdefault(db_map, set()).add(entity_class_name)
- # Build lookup dict
- self._db_map_ent_cls_lookup.clear()
- for db_map, names in db_map_names.items():
- for name in names:
- item = self.db_mngr.get_item_by_field(db_map, self.entity_class_type, "name", name, only_visible=False)
- if item:
- self._db_map_ent_cls_lookup.setdefault(db_map, {})[name] = item
-
- def _fill_in_entity_class_id(self, item, db_map):
- """Fills in the entity_class id in the given db item.
-
- Args:
- item (dict): the db item
- db_map (DiffDatabaseMapping): the database where the given item belongs
-
- Returns:
- list: error log
- """
- entity_class_name = item.pop(self.entity_class_name_key, None)
- entity_class = self._db_map_ent_cls_lookup.get(db_map, {}).get(entity_class_name)
- if not entity_class:
- return [f"Unknown entity_class {entity_class_name}"] if entity_class_name else []
- item[self.entity_class_id_key] = entity_class.get("id")
- return []
-
- def _convert_to_db(self, item, db_map):
- """Returns a db item (id-based) from the given model item (name-based).
-
- Args:
- item (dict): the model item
- db_map (DiffDatabaseMapping): the database where the resulting item belongs
-
- Returns:
- dict: the db item
- list: error log
- """
- item, err1 = super()._convert_to_db(item, db_map)
- err2 = self._fill_in_entity_class_id(item, db_map)
- return item, err1 + err2
-
-
-class FillInEntityIdsMixin(ConvertToDBMixin):
- """Fills in entity ids."""
-
- _add_entities_on_the_fly = False
-
- def __init__(self, *args, **kwargs):
- """Initializes lookup dicts."""
- super().__init__(*args, **kwargs)
- self._db_map_ent_lookup = dict()
-
- def build_lookup_dictionary(self, db_map_data):
- """Builds a name lookup dictionary for the given data.
-
- Args:
- db_map_data (dict): lists of model items keyed by DiffDatabaseMapping
- """
- super().build_lookup_dictionary(db_map_data)
- # Group data by name
- db_map_names = dict()
- for db_map, items in db_map_data.items():
- for item in items:
- name = item.get(self.entity_name_key)
- db_map_names.setdefault(db_map, set()).add(name)
- # Build lookup dict
- self._db_map_ent_lookup.clear()
- for db_map, names in db_map_names.items():
- for name in names:
- items = self.db_mngr.get_items_by_field(
- db_map, self.entity_type, self.entity_name_key_in_cache, name, only_visible=False
- )
- if items:
- self._db_map_ent_lookup.setdefault(db_map, {})[name] = items
-
- def _fill_in_entity_ids(self, item, db_map):
- """Fills in all possible entity ids keyed by entity_class id in the given db item
- (as there can be more than one entity for the same name).
-
- Args:
- item (dict): the db item
- db_map (DiffDatabaseMapping): the database where the given item belongs
-
- Returns:
- list: error log
- """
- name = item.pop(self.entity_name_key, None)
- items = self._db_map_ent_lookup.get(db_map, {}).get(name)
- if not items:
- return [f"Unknown entity {name}"] if name and not self._add_entities_on_the_fly else []
- item["entity_ids"] = {x["class_id"]: x["id"] for x in items}
- return []
-
- def _convert_to_db(self, item, db_map):
- """Returns a db item (id-based) from the given model item (name-based).
-
- Args:
- item (dict): the model item
- db_map (DiffDatabaseMapping): the database where the resulting item belongs
-
- Returns:
- dict: the db item
- list: error log
- """
- item, err1 = super()._convert_to_db(item, db_map)
- err2 = self._fill_in_entity_ids(item, db_map)
- return item, err1 + err2
-
-
-class FillInParameterDefinitionIdsMixin(ConvertToDBMixin):
- """Fills in parameter_definition ids."""
-
- def __init__(self, *args, **kwargs):
- """Initializes lookup dicts."""
- super().__init__(*args, **kwargs)
- self._db_map_param_lookup = dict()
-
- def build_lookup_dictionary(self, db_map_data):
- """Builds a name lookup dictionary for the given data.
-
- Args:
- db_map_data (dict): lists of model items keyed by DiffDatabaseMapping
- """
- super().build_lookup_dictionary(db_map_data)
- # Group data by name
- db_map_names = dict()
- for db_map, items in db_map_data.items():
- for item in items:
- name = item.get("parameter_name")
- db_map_names.setdefault(db_map, set()).add(name)
- # Build lookup dict
- self._db_map_param_lookup.clear()
- for db_map, names in db_map_names.items():
- for name in names:
- items = [
- x
- for x in self.db_mngr.get_items_by_field(
- db_map, "parameter_definition", "parameter_name", name, only_visible=False
- )
- if self.entity_class_id_key in x
- ]
- if items:
- self._db_map_param_lookup.setdefault(db_map, {})[name] = items
-
- def _fill_in_parameter_ids(self, item, db_map):
- """Fills in all possible parameter_definition ids keyed by entity_class id in the given db item
- (as there can be more than one parameter_definition for the same name).
-
- Args:
- item (dict): the db item
- db_map (DiffDatabaseMapping): the database where the given item belongs
-
- Returns:
- list: error log
- """
- name = item.pop("parameter_name", None)
- items = self._db_map_param_lookup.get(db_map, {}).get(name)
- if not items:
- return [f"Unknown parameter {name}"] if name else []
- item["parameter_ids"] = {x[self.entity_class_id_key]: x["id"] for x in items}
- return []
-
- def _convert_to_db(self, item, db_map):
- """Returns a db item (id-based) from the given model item (name-based).
-
- Args:
- item (dict): the model item
- db_map (DiffDatabaseMapping): the database where the resulting item belongs
-
- Returns:
- dict: the db item
- list: error log
- """
- item, err1 = super()._convert_to_db(item, db_map)
- err2 = self._fill_in_parameter_ids(item, db_map)
- return item, err1 + err2
-
-
-class InferEntityClassIdMixin(ConvertToDBMixin):
- """Infers entity class ids."""
-
- def _convert_to_db(self, item, db_map):
- """Returns a db item (id-based) from the given model item (name-based).
-
- Args:
- item (dict): the model item
- db_map (DiffDatabaseMapping): the database where the resulting item belongs
-
- Returns:
- dict: the db item
- list: error log
- """
- item, err1 = super()._convert_to_db(item, db_map)
- err2 = self._infer_and_fill_in_entity_class_id(item, db_map)
- return item, err1 + err2
-
- def _infer_and_fill_in_entity_class_id(self, item, db_map):
- """Fills the entity_class id in the given db item, by intersecting entity ids and parameter ids.
- Then picks the correct entity id and parameter_definition id.
- Also sets the inferred entity_class name in the model.
-
- Args:
- item (dict): the db item
- db_map (DiffDatabaseMapping): the database where the given item belongs
-
- Returns:
- list: error log
- """
- row = item.pop("row")
- entity_ids = item.pop("entity_ids", {})
- parameter_ids = item.pop("parameter_ids", {})
- if self.entity_class_id_key not in item:
- if not entity_ids:
- entity_class_ids = set(parameter_ids.keys())
- elif not parameter_ids:
- entity_class_ids = set(entity_ids.keys())
- else:
- entity_class_ids = entity_ids.keys() & parameter_ids.keys()
- if len(entity_class_ids) != 1:
- # entity_class id not in the item and not inferrable, good bye
- return ["Unable to infer entity_class."]
- entity_class_id = entity_class_ids.pop()
- item[self.entity_class_id_key] = entity_class_id
- entity_class_name = self.db_mngr.get_item(
- db_map, self.entity_class_type, entity_class_id, only_visible=False
- )["name"]
- # TODO: Try to find a better place for this, and emit dataChanged
- self._main_data[row][self.header.index(self.entity_class_name_key)] = entity_class_name
- # At this point we're sure the entity_class_id is there
- entity_class_id = item[self.entity_class_id_key]
- entity_id = entity_ids.get(entity_class_id)
- parameter_definition_id = parameter_ids.get(entity_class_id)
- if entity_id:
- item[self.entity_id_key] = entity_id
- if parameter_definition_id:
- item["parameter_definition_id"] = parameter_definition_id
- return []
-
-
-class ImposeEntityClassIdMixin(ConvertToDBMixin):
- """Imposes entity class ids."""
-
- def _convert_to_db(self, item, db_map):
- """Returns a db item (id-based) from the given model item (name-based).
-
- Args:
- item (dict): the model item
- db_map (DiffDatabaseMapping): the database where the resulting item belongs
-
- Returns:
- dict: the db item
- list: error log
- """
- item, err1 = super()._convert_to_db(item, db_map)
- err2 = self._impose_entity_class_id(item, db_map)
- return item, err1 + err2
-
- def _impose_entity_class_id(self, item, db_map):
- """Imposes the entity_class id from the model, to pick the correct entity id and parameter_definition id.
-
- Args:
- item (dict): the db item
- db_map (DiffDatabaseMapping): the database where the given item belongs
-
- Returns:
- list: error log
- """
- entity_ids = item.pop("entity_ids", {})
- parameter_ids = item.pop("parameter_ids", {})
- entity_id = entity_ids.get(self.entity_class_id)
- parameter_definition_id = parameter_ids.get(self.entity_class_id)
- if entity_id:
- item[self.entity_id_key] = entity_id
- if parameter_definition_id:
- item["parameter_definition_id"] = parameter_definition_id
- return []
-
-
-class MakeRelationshipOnTheFlyMixin:
- """Makes relationships on the fly."""
-
- def __init__(self, *args, **kwargs):
- """Initializes lookup dicts."""
- super().__init__(*args, **kwargs)
- self._db_map_obj_lookup = dict()
- self._db_map_rel_cls_lookup = dict()
- self._db_map_existing_rels = dict()
-
- @staticmethod
- def _make_unique_relationship_id(item):
- """Returns a unique name-based identifier for db relationships."""
- return (item["class_name"], item["object_name_list"])
-
- def build_lookup_dictionaries(self, db_map_data):
- """Builds a name lookup dictionary for the given data.
-
- Args:
- db_map_data (dict): lists of model items keyed by DiffDatabaseMapping.
- """
- # Group data by name
- db_map_object_names = dict()
- db_map_rel_cls_names = dict()
- for db_map, items in db_map_data.items():
- for item in items:
- object_name_list = item.get("object_name_list")
- if object_name_list:
- db_map_object_names.setdefault(db_map, set()).update(object_name_list)
- relationship_class_name = item.get("relationship_class_name")
- db_map_rel_cls_names.setdefault(db_map, set()).add(relationship_class_name)
- # Build lookup dicts
- self._db_map_obj_lookup.clear()
- for db_map, names in db_map_object_names.items():
- for name in names:
- item = self.db_mngr.get_item_by_field(db_map, "object", "name", name, only_visible=False)
- if item:
- self._db_map_obj_lookup.setdefault(db_map, {})[name] = item
- self._db_map_rel_cls_lookup.clear()
- for db_map, names in db_map_rel_cls_names.items():
- for name in names:
- item = self.db_mngr.get_item_by_field(db_map, "relationship_class", "name", name, only_visible=False)
- if item:
- self._db_map_rel_cls_lookup.setdefault(db_map, {})[name] = item
- self._db_map_existing_rels = {
- db_map: {
- self._make_unique_relationship_id(x)
- for x in self.db_mngr.get_items(db_map, "relationship", only_visible=False)
- }
- for db_map in self._db_map_obj_lookup.keys() | self._db_map_rel_cls_lookup.keys()
- }
-
- def _make_relationship_on_the_fly(self, item, db_map):
- """Returns a database relationship item (id-based) from the given model parameter_value item (name-based).
-
- Args:
- item (dict): the model parameter_value item
- db_map (DiffDatabaseMapping): the database where the resulting item belongs
-
- Returns:
- dict: the db relationship item
- list: error log
- """
- relationship_class_name = item.get("relationship_class_name")
- object_name_list = item.get("object_name_list")
- if not object_name_list:
- return None, []
- relationships = self._db_map_existing_rels.get(db_map, set())
- if (relationship_class_name, object_name_list) in relationships:
- return None, []
- relationship_class = self._db_map_rel_cls_lookup.get(db_map, {}).get(relationship_class_name)
- if not relationship_class:
- return None, [f"Unknown relationship_class {relationship_class_name}"] if relationship_class_name else []
- object_id_list = []
- for name in object_name_list:
- object_ = self._db_map_obj_lookup.get(db_map, {}).get(name)
- if not object_:
- return None, [f"Unknown object {name}"]
- object_id_list.append(object_["id"])
- relationship_name = relationship_class_name + "__" + "_".join(object_name_list)
- return {"class_id": relationship_class["id"], "object_id_list": object_id_list, "name": relationship_name}, []
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/parameter_value_list_item.py b/spinetoolbox/spine_db_editor/mvcmodels/parameter_value_list_item.py
index bd5cbdce3..03ae1dbfc 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/parameter_value_list_item.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/parameter_value_list_item.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,10 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-Tree items for parameter_value lists.
-"""
-
+"""Tree items for parameter_value lists."""
from PySide6.QtCore import Qt
from PySide6.QtGui import QIcon
from spinetoolbox.mvcmodels.shared import PARSED_ROLE
@@ -41,10 +39,10 @@ def fetch_item_type(self):
return "parameter_value_list"
def empty_child(self):
- return ListItem()
+ return ListItem(self._model)
def _make_child(self, id_):
- return ListItem(id_)
+ return ListItem(self._model, id_)
class ListItem(
@@ -52,10 +50,6 @@ class ListItem(
):
"""A list item."""
- def __init__(self, identifier=None, name=None):
- super().__init__(identifier=identifier)
- self._name = name
-
@property
def item_type(self):
return "parameter_value_list"
@@ -65,19 +59,19 @@ def fetch_item_type(self):
return "list_value"
def _make_item_data(self):
- return {"name": "Type new list name here..." if self._name is None else self._name}
+ return {"name": "Type new list name here..."}
def _do_set_up(self):
- if not self.id and not self._name:
+ if not self.id:
return
super()._do_set_up()
# pylint: disable=no-self-use
def empty_child(self):
- return ValueItem()
+ return ValueItem(self._model)
def _make_child(self, id_):
- return ValueItem(id_)
+ return ValueItem(self._model, id_)
def accepts_item(self, item, db_map):
return item["parameter_value_list_id"] == self.id
@@ -110,7 +104,8 @@ def data(self, column, role=Qt.ItemDataRole.DisplayRole):
if role == Qt.ItemDataRole.DisplayRole and not self.id:
return "Enter new list value here..."
if role in (Qt.ItemDataRole.DisplayRole, Qt.ItemDataRole.EditRole, Qt.ItemDataRole.ToolTipRole, PARSED_ROLE):
- return self.db_mngr.get_value(self.db_map, self.item_type, self.id, role=role)
+ item = self.db_mngr.get_item(self.db_map, self.item_type, self.id)
+ return self.db_mngr.get_value(self.db_map, item, role=role)
return super().data(column, role)
def list_index(self):
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/parameter_value_list_model.py b/spinetoolbox/spine_db_editor/mvcmodels/parameter_value_list_model.py
index 5ba1787d7..a23c19e5e 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/parameter_value_list_model.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/parameter_value_list_model.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,10 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-A tree model for parameter_value lists.
-"""
-
+"""A tree model for parameter_value lists."""
from PySide6.QtCore import Qt, QModelIndex
from .tree_model_base import TreeModelBase
from .parameter_value_list_item import DBItem
@@ -21,13 +19,8 @@
class ParameterValueListModel(TreeModelBase):
"""A model to display parameter_value_list data in a tree view."""
- @staticmethod
- def _make_db_item(db_map):
- return DBItem(db_map)
-
- @staticmethod
- def _top_children():
- return []
+ def _make_db_item(self, db_map):
+ return DBItem(self, db_map)
def columnCount(self, parent=QModelIndex()):
"""Returns the number of columns under the given parent. Always 1."""
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/pivot_model.py b/spinetoolbox/spine_db_editor/mvcmodels/pivot_model.py
index e9a787bb5..3017e2075 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/pivot_model.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/pivot_model.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,10 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-Provides PivotModel.
-"""
-
+"""Provides PivotModel."""
import operator
from ...helpers import tuple_itemgetter
@@ -147,6 +145,8 @@ def _index_key_getter(self, indexes):
Callable: an itemgetter
"""
keys = tuple(self.index_ids.index(i) for i in indexes if i in self.index_ids)
+ if not keys:
+ return lambda _: ()
return tuple_itemgetter(operator.itemgetter(*keys), len(keys))
def _get_unique_index_values(self, indexes):
@@ -166,12 +166,19 @@ def _get_unique_index_values(self, indexes):
result = {index_getter(k): None for k in self._data if frozen_getter(k) == self.frozen_value}
else:
result = {index_getter(k): None for k in self._data}
- return sorted(
- (x for x in result if None not in x),
- key=lambda x: tuple(
- self.top_left_headers[header_name].header_data(header_id) for header_name, header_id in zip(indexes, x)
- ),
- )
+ accepted = {}
+ headers = self.top_left_headers
+ for x in result:
+ sort_keys = []
+ for header_name, header_id in zip(indexes, x):
+ header = headers[header_name]
+ if not header.accepts(header_id):
+ break
+ sort_key = header.header_data(header_id)
+ sort_keys.append(sort_key if sort_key is not None else "")
+ else:
+ accepted[x] = sort_keys
+ return [item[0] for item in sorted(accepted.items(), key=operator.itemgetter(1))]
def set_pivot(self, rows, columns, frozen, frozen_value):
"""Sets pivot."""
@@ -198,12 +205,12 @@ def set_frozen_value(self, value):
"""Sets values for the frozen indexes.
Args:
- value (list of str):
+ value (tuple of str):
"""
- if len(value) != len(self.pivot_frozen):
- raise ValueError("'value' must have same length as 'self.pivot_frozen'")
if value == self.frozen_value:
return
+ if len(value) != len(self.pivot_frozen):
+ raise ValueError("'value' must have same length as 'self.pivot_frozen'")
self.set_pivot(self.pivot_rows, self.pivot_columns, self.pivot_frozen, value)
def set_frozen(self, frozen):
@@ -254,7 +261,7 @@ def row_key(self, row):
return len(self.pivot_rows) * (None,)
if row == 0:
return ()
- raise IndexError('index out of range for current row pivot')
+ raise IndexError("index out of range for current row pivot")
def column_key(self, column):
if self.pivot_columns:
@@ -263,7 +270,7 @@ def column_key(self, column):
return len(self.pivot_columns) * (None,)
if column == 0:
return ()
- raise IndexError('index out of range for current column pivot')
+ raise IndexError("index out of range for current column pivot")
@property
def rows(self):
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/pivot_table_models.py b/spinetoolbox/spine_db_editor/mvcmodels/pivot_table_models.py
index e20139d7b..37e191e03 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/pivot_table_models.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/pivot_table_models.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,19 +10,18 @@
# this program. If not, see .
######################################################################################################################
-"""
-Provides pivot table models for the Tabular View.
-"""
+"""Provides pivot table models for the Tabular View."""
from collections import defaultdict
from contextlib import suppress
from functools import partial
-
+from itertools import product
+from typing import Iterable
from PySide6.QtCore import Qt, Signal, Slot, QTimer, QAbstractTableModel, QModelIndex, QSortFilterProxyModel
from PySide6.QtGui import QFont
-
from spinedb_api import DatabaseMapping
-from spinedb_api.parameter_value import join_value_and_type, split_value_and_type
-from spinetoolbox.helpers import DB_ITEM_SEPARATOR, parameter_identifier
+from spinedb_api.helpers import name_from_elements
+from spinedb_api.parameter_value import IndexedValue, join_value_and_type, split_value_and_type
+from spinetoolbox.helpers import DB_ITEM_SEPARATOR, parameter_identifier, plain_to_tool_tip
from spinetoolbox.fetch_parent import FlexibleFetchParent
from .colors import FIXED_FIELD_COLOR, PIVOT_TABLE_HEADER_COLOR
from .pivot_model import PivotModel
@@ -58,7 +58,21 @@ def _get_header_data_from_db(self, item_type, header_id, field_name, role):
if role in (Qt.ItemDataRole.DisplayRole, Qt.ItemDataRole.EditRole):
return item.get(field_name)
if role == Qt.ItemDataRole.ToolTipRole:
- return item.get("description", "No description")
+ return plain_to_tool_tip(item.get("description", "No description."))
+
+ @staticmethod
+ def accepts(header_id):
+ """Tests if header id is valid.
+
+ Args:
+ header_id (Any): header id
+
+ Returns:
+ bool: True if id is valid, False otherwise
+ """
+ if isinstance(header_id, Iterable):
+ return all(id_ is not None for id_ in header_id[1:])
+ return header_id is not None
def header_data(self, header_id, role=Qt.ItemDataRole.DisplayRole):
"""Returns header data for given id.
@@ -96,8 +110,8 @@ def add_data(self, names, db_map):
raise NotImplementedError()
-class TopLeftObjectHeaderItem(TopLeftHeaderItem):
- """A top left header for object_class."""
+class TopLeftEntityHeaderItem(TopLeftHeaderItem):
+ """A top left header for an entity class."""
def __init__(self, model, rank, class_name, class_id):
super().__init__(model)
@@ -107,21 +121,25 @@ def __init__(self, model, rank, class_name, class_id):
@property
def header_type(self):
- return "object"
+ return "entity"
@property
def name(self):
return self._name
+ @property
+ def class_id(self):
+ return self._class_id
+
def header_data(self, header_id, role=Qt.ItemDataRole.DisplayRole):
"""See base class."""
- return self._get_header_data_from_db("object", header_id, "name", role)
+ return self._get_header_data_from_db("entity", header_id, "name", role)
def update_data(self, db_map_data):
"""See base class."""
if not db_map_data:
return False
- self.db_mngr.update_objects(db_map_data)
+ self.db_mngr.update_entities(db_map_data)
return True
def add_data(self, names, db_map):
@@ -130,7 +148,7 @@ def add_data(self, names, db_map):
return False
class_id = self._class_id[db_map]
db_map_data = {db_map: [{"name": name, "class_id": class_id} for name in names]}
- self.db_mngr.add_objects(db_map_data)
+ self.db_mngr.add_entities(db_map_data)
return True
@@ -147,7 +165,7 @@ def name(self):
def header_data(self, header_id, role=Qt.ItemDataRole.DisplayRole):
"""See base class."""
- return self._get_header_data_from_db("parameter_definition", header_id, "parameter_name", role)
+ return self._get_header_data_from_db("parameter_definition", header_id, "name", role)
def update_data(self, db_map_data):
"""See base class."""
@@ -352,7 +370,11 @@ def db_maps(self):
def reset_fetch_parents(self):
for parent in self._fetch_parents():
- parent.reset_fetching(None)
+ parent.reset()
+
+ def set_fetch_parents_non_obsolete(self):
+ for parent in self._fetch_parents():
+ parent.set_obsolete(False)
def _fetch_parents(self):
"""Yields fetch parents for this model.
@@ -367,8 +389,9 @@ def canFetchMore(self, _):
return False
result = False
for fetch_parent in self._fetch_parents():
- for db_map in self._parent.db_maps:
- result |= self.db_mngr.can_fetch_more(db_map, fetch_parent)
+ if not fetch_parent.is_fetched:
+ for db_map in self._parent.db_maps:
+ result |= self.db_mngr.can_fetch_more(db_map, fetch_parent)
return result
def fetchMore(self, _):
@@ -475,9 +498,9 @@ def remove_from_model(self, data):
if not data:
return
row_count, column_count = self.model.remove_from_model(data)
- frozen_values = self.model.frozen_values(data)
- if frozen_values:
- self.frozen_values_removed.emit(frozen_values)
+ removed_frozen_values = self.model.frozen_values(data) - self.model.frozen_values(self.model._data)
+ if removed_frozen_values:
+ self.frozen_values_removed.emit(removed_frozen_values)
if row_count > 0:
first = self.headerRowCount()
self.beginRemoveRows(QModelIndex(), first, first + row_count - 1)
@@ -560,7 +583,7 @@ def x_parameter_name(self):
header_ids = self._header_ids(0, pivot_column)
_, parameter_id = header_ids[-3]
db_map = header_ids[-1]
- parameter_name = self.db_mngr.get_item(db_map, "parameter_definition", parameter_id).get("parameter_name", "")
+ parameter_name = self.db_mngr.get_item(db_map, "parameter_definition", parameter_id).get("name", "")
return parameter_name
def headerRowCount(self):
@@ -777,7 +800,7 @@ def _color_data(self, index):
def _text_alignment_data(self, index): # pylint: disable=no-self-use
return None
- def _header_data(self, index, role=Qt.ItemDataRole.DisplayRole):
+ def _header_data(self, index):
header_id = self._header_id(index)
top_left_id = self.top_left_id(index)
return self._header_name(top_left_id, header_id)
@@ -785,6 +808,17 @@ def _header_data(self, index, role=Qt.ItemDataRole.DisplayRole):
def _header_name(self, top_left_id, header_id):
return self.top_left_headers[top_left_id].header_data(header_id)
+ def get_db_map_entities(self):
+ """Returns a dict mapping db maps to a list of dict entity items in the current class.
+
+ Returns:
+ dict
+ """
+ return {
+ db_map: self.db_mngr.get_items_by_field(db_map, "entity", "class_id", class_id)
+ for db_map, class_id in self._parent.current_class_id.items()
+ }
+
def _data(self, index, role):
raise NotImplementedError()
@@ -795,7 +829,7 @@ def data(self, index, role=Qt.ItemDataRole.DisplayRole):
if self.index_in_left(index):
return self.model.pivot_columns[index.row()]
if self.index_in_headers(index):
- return self._header_data(index, role)
+ return self._header_data(index)
if self.index_in_data(index):
return self._data(index, role)
if "database" not in self.model.pivot_frozen:
@@ -911,6 +945,11 @@ def _batch_set_empty_header_data(self, header_data, get_top_left_id):
success = success or header_item.add_data(names, db_map)
return success
+ def tear_down(self):
+ """Sets fetch parents obsolete preventing further updates."""
+ for fetch_parent in self._fetch_parents():
+ fetch_parent.set_obsolete(True)
+
class ParameterValuePivotTableModel(PivotTableModelBase):
"""A model for the pivot table in parameter_value input type."""
@@ -921,8 +960,16 @@ def __init__(self, parent):
parent (SpineDBEditor)
"""
super().__init__(parent)
+ self._entity_class_fetch_parent = FlexibleFetchParent(
+ "entity_class",
+ handle_items_added=self._handle_entity_classes_added,
+ handle_items_removed=self._handle_entity_classes_removed,
+ handle_items_updated=lambda _: self._parent.refresh_views(),
+ accepts_item=self._parent.accepts_entity_class_item,
+ owner=self,
+ )
self._entity_fetch_parent = FlexibleFetchParent(
- None,
+ "entity",
handle_items_added=self._handle_entities_added,
handle_items_removed=self._handle_entities_removed,
handle_items_updated=lambda _: self._parent.refresh_views(),
@@ -954,6 +1001,17 @@ def __init__(self, parent):
owner=self,
)
+ def _handle_entity_classes_added(self, db_map_data):
+ pass
+
+ def _handle_entity_classes_removed(self, db_map_data):
+ for header_item in self.model.top_left_headers.values():
+ if isinstance(header_item, TopLeftEntityHeaderItem):
+ for db_map, class_id in header_item.class_id.items():
+ if any(class_item["id"] == class_id for class_item in db_map_data[db_map]):
+ self.clear_model()
+ return
+
def _handle_entities_added(self, db_map_data):
data = self._load_empty_parameter_value_data(db_map_entities=db_map_data)
self.add_to_model(data)
@@ -982,7 +1040,7 @@ def _handle_parameter_values_added(self, db_map_data):
def _handle_parameter_values_removed(self, db_map_data):
data = self._load_full_parameter_value_data(db_map_parameter_values=db_map_data, action="remove")
- self.remove_from_model(data)
+ self.update_model(data)
def _handle_alternatives_added(self, db_map_data):
db_map_alternative_ids = {db_map: [(db_map, a["id"]) for a in items] for db_map, items in db_map_data.items()}
@@ -994,11 +1052,89 @@ def _handle_alternatives_removed(self, db_map_data):
data = self._load_empty_parameter_value_data(db_map_alternative_ids=db_map_alternative_ids)
self.remove_from_model(data)
- def _load_empty_parameter_value_data(self, *args, **kwargs):
- return self._parent.load_empty_parameter_value_data(*args, **kwargs)
+ def _load_empty_parameter_value_data(
+ self, db_map_entities=None, db_map_parameter_ids=None, db_map_alternative_ids=None
+ ):
+ """Returns a dict containing all possible combinations of entities and parameters for the current class
+ in all db_maps.
+
+ Args:
+ db_map_entities (dict, optional): if given, only load data for these db maps and entities
+ db_map_parameter_ids (dict, optional): if given, only load data for these db maps and parameter definitions
+ db_map_alternative_ids (dict, optional): if given, only load data for these db maps and alternatives
+
+ Returns:
+ dict: Key is a tuple object_id, ..., parameter_id, value is None.
+ """
+ (
+ db_map_entity_ids,
+ db_map_parameter_ids,
+ db_map_alternative_ids,
+ ) = self._all_combination_for_empty_parameter_value(
+ db_map_entities, db_map_parameter_ids, db_map_alternative_ids
+ )
+ return {
+ entity_id + (parameter_id, alt_id, db_map): None
+ for db_map in self.db_maps
+ for entity_id in db_map_entity_ids.get(db_map, [])
+ for parameter_id in db_map_parameter_ids.get(db_map, [])
+ for alt_id in db_map_alternative_ids.get(db_map, [])
+ }
+
+ def _all_combination_for_empty_parameter_value(self, db_map_entities, db_map_parameter_ids, db_map_alternative_ids):
+ if db_map_entities is None:
+ db_map_entities = self.get_db_map_entities()
+ if db_map_parameter_ids is None:
+ db_map_parameter_ids = {
+ db_map: [(db_map, id_) for id_ in ids]
+ for db_map, ids in self._get_db_map_parameter_value_or_def_ids("parameter_definition").items()
+ }
+ if db_map_alternative_ids is None:
+ db_map_alternative_ids = {
+ db_map: [
+ (db_map, id_) for a in self.db_mngr.get_items(db_map, "alternative") if (id_ := a["id"]) is not None
+ ]
+ for db_map in self.db_maps
+ }
+ db_map_entity_ids = {
+ db_map: [
+ id_tuple
+ for e in entities
+ if (id_tuple := tuple((db_map, id_) for id_ in e["element_id_list"] or (e["id"],)))
+ ]
+ for db_map, entities in db_map_entities.items()
+ }
+ if not any(db_map_entity_ids.values()) and (
+ current_dimension_id_list := self._parent.current_dimension_id_list
+ ):
+ db_map_entity_ids = {
+ db_map: [tuple((db_map, None) for _ in current_dimension_id_list)] for db_map in self.db_maps
+ }
+ if not any(db_map_parameter_ids.values()):
+ db_map_parameter_ids = {db_map: [(db_map, None)] for db_map in self.db_maps}
+ if not any(db_map_alternative_ids.values()):
+ db_map_alternative_ids = {db_map: [(db_map, None)] for db_map in self.db_maps}
+ return db_map_entity_ids, db_map_parameter_ids, db_map_alternative_ids
+
+ def _load_full_parameter_value_data(self, db_map_parameter_values=None, action="add"):
+ """Returns a dict of parameter values for the current class.
+
+ Args:
+ db_map_parameter_values (list, optional)
+ action (str)
- def _load_full_parameter_value_data(self, *args, **kwargs):
- return self._parent.load_full_parameter_value_data(*args, **kwargs)
+ Returns:
+ dict: Key is a tuple object_id, ..., parameter_id, value is the parameter_value.
+ """
+ if db_map_parameter_values is None:
+ db_map_parameter_values = self._get_db_map_parameter_values_or_defs("parameter_value")
+ get_id = _make_get_id(action)
+ return {
+ tuple((db_map, id_) for id_ in x["element_id_list"] or (x["entity_id"],))
+ + ((db_map, x["parameter_id"]), (db_map, x["alternative_id"]), db_map): get_id(db_map, x)
+ for db_map, items in db_map_parameter_values.items()
+ for x in items
+ }
@property
def item_type(self):
@@ -1009,33 +1145,42 @@ def _fetch_parents(self):
yield self._alternative_fetch_parent
yield self._parameter_definition_fetch_parent
yield self._entity_fetch_parent
+ yield self._entity_class_fetch_parent
- def reset_fetch_parents(self):
- super().reset_fetch_parents()
- if self._parent.current_class_type == "object_class":
- self._entity_fetch_parent.fetch_item_type = "object"
- elif self._parent.current_class_type == "relationship_class":
- self._entity_fetch_parent.fetch_item_type = "relationship"
+ def _db_map_element_ids(self, header_ids):
+ entity_indexes = [
+ k for k, h in enumerate(self.top_left_headers.values()) if isinstance(h, TopLeftEntityHeaderItem)
+ ]
+ return header_ids[-1], [header_ids[k][1] for k in entity_indexes]
- def db_map_object_ids(self, index):
+ def db_map_entity_ids(self, indexes):
"""
- Returns db_map and object ids for given index. Used by PivotTableView.
+ Returns db_map and entity ids for given indexes. Used by PivotTableView.
+
+ Args:
+ indexes (list of QModelIndex): indexes corresponding to entity items
Returns:
- DatabaseMapping, list
+ dict: mapping DatabaseMapping to set of entity ids
"""
- row, column = self.map_to_pivot(index)
- header_ids = self._header_ids(row, column)
- return self._db_map_object_ids(header_ids)
-
- def _db_map_object_ids(self, header_ids):
- object_indexes = [
- k for k, h in enumerate(self.top_left_headers.values()) if isinstance(h, TopLeftObjectHeaderItem)
- ]
- return header_ids[-1], [header_ids[k][1] for k in object_indexes]
+ db_map_entity_lookup = {
+ db_map: {ent["element_id_list"]: ent["id"] for ent in ents}
+ for db_map, ents in self.get_db_map_entities().items()
+ }
+ db_map_entity_ids = {}
+ for index in indexes:
+ row, column = self.map_to_pivot(index)
+ if not self._parent.first_current_entity_class["dimension_id_list"]:
+ db_map, id_ = self._header_id(index)
+ else:
+ header_ids = self._header_ids(row, column)
+ db_map, element_id_list = self._db_map_element_ids(header_ids)
+ id_ = db_map_entity_lookup.get(db_map, {}).get(tuple(element_id_list))
+ db_map_entity_ids.setdefault(db_map, set()).add(id_)
+ return db_map_entity_ids
def all_header_names(self, index):
- """Returns the object, parameter, alternative, and db names corresponding to the given data index.
+ """Returns the entity, parameter, alternative, and db names corresponding to the given data index.
Args:
index (QModelIndex)
@@ -1048,14 +1193,14 @@ def all_header_names(self, index):
"""
row, column = self.map_to_pivot(index)
header_ids = self._header_ids(row, column)
- _, objects_ids = self._db_map_object_ids(header_ids)
+ _, entity_ids = self._db_map_element_ids(header_ids)
_, parameter_id = header_ids[-3]
_, alternative_id = header_ids[-2]
db_map = header_ids[-1]
- object_names = [self.db_mngr.get_item(db_map, "object", id_)["name"] for id_ in objects_ids]
- parameter_name = self.db_mngr.get_item(db_map, "parameter_definition", parameter_id).get("parameter_name", "")
+ entity_names = [self.db_mngr.get_item(db_map, "entity", id_)["name"] for id_ in entity_ids]
+ parameter_name = self.db_mngr.get_item(db_map, "parameter_definition", parameter_id).get("name", "")
alternative_name = self.db_mngr.get_item(db_map, "alternative", alternative_id).get("name", "")
- return object_names, parameter_name, alternative_name, db_map.codename
+ return entity_names, parameter_name, alternative_name, db_map.codename
def index_name(self, index):
"""Returns a string that concatenates the object and parameter names corresponding to the given data index.
@@ -1069,8 +1214,8 @@ def index_name(self, index):
"""
if not self.index_in_data(index):
return ""
- object_names, parameter_name, alternative_name, db_name = self.all_header_names(index)
- return parameter_identifier(db_name, parameter_name, object_names, alternative_name)
+ entity_names, parameter_name, alternative_name, db_name = self.all_header_names(index)
+ return parameter_identifier(db_name, parameter_name, entity_names, alternative_name)
def column_name(self, column):
"""Returns a string that concatenates the object and parameter names corresponding to the given column.
@@ -1091,10 +1236,10 @@ def column_name(self, column):
def call_reset_model(self, pivot=None):
"""See base class."""
- object_class_ids = self._parent.current_object_class_ids
+ dimension_ids = self._parent.current_dimension_ids
data = {}
top_left_headers = [
- TopLeftObjectHeaderItem(self, k, name, id_) for k, (name, id_) in enumerate(object_class_ids.items())
+ TopLeftEntityHeaderItem(self, k, name, id_) for k, (name, id_) in enumerate(dimension_ids.items())
]
top_left_headers += [TopLeftParameterHeaderItem(self)]
top_left_headers += [TopLeftAlternativeHeaderItem(self)]
@@ -1125,28 +1270,20 @@ def _data(self, index, role):
if data[0][0] is None:
return None
db_map, id_ = data[0][0]
- return self.db_mngr.get_value(db_map, "parameter_value", id_, role)
+ item = self.db_mngr.get_item(db_map, "parameter_value", id_)
+ return self.db_mngr.get_value(db_map, item, role)
def _do_batch_set_inner_data(self, row_map, column_map, data, values):
return self._batch_set_parameter_value_data(row_map, column_map, data, values)
- def _object_parameter_value_to_add(self, db_map, header_ids, value_and_type):
- value, value_type = split_value_and_type(value_and_type)
- return dict(
- object_class_id=self._parent.current_class_id[db_map],
- object_id=header_ids[0],
- parameter_definition_id=header_ids[-2],
- value=value,
- type=value_type,
- alternative_id=header_ids[-1],
+ def _entity_parameter_value_to_add(self, db_map, header_ids, value_and_type, ent_id_lookup=None):
+ entity_id = (
+ header_ids[0] if ent_id_lookup is None else ent_id_lookup[db_map, tuple(id_ for id_ in header_ids[:-2])]
)
-
- def _relationship_parameter_value_to_add(self, db_map, header_ids, value_and_type, rel_id_lookup):
- object_id_list = tuple(id_ for id_ in header_ids[:-2])
value, value_type = split_value_and_type(value_and_type)
return dict(
- relationship_class_id=self._parent.current_class_id[db_map],
- relationship_id=rel_id_lookup[db_map, object_id_list],
+ entity_class_id=self._parent.current_class_id[db_map],
+ entity_id=entity_id,
parameter_definition_id=header_ids[-2],
value=value,
type=value_type,
@@ -1154,21 +1291,18 @@ def _relationship_parameter_value_to_add(self, db_map, header_ids, value_and_typ
)
def _make_parameter_value_to_add(self):
- if self._parent.current_class_type == "object_class":
- return self._object_parameter_value_to_add
- if self._parent.current_class_type == "relationship_class":
- db_map_relationships = {
- db_map: self.db_mngr.get_items_by_field(db_map, "relationship", "class_id", class_id)
- for db_map, class_id in self._parent.current_class_id.items()
- }
- rel_id_lookup = {
- (db_map, x["object_id_list"]): x["id"]
- for db_map, relationships in db_map_relationships.items()
- for x in relationships
- }
- return lambda db_map, header_ids, value, rel_id_lookup=rel_id_lookup: self._relationship_parameter_value_to_add(
- db_map, header_ids, value, rel_id_lookup
- )
+ if not self._parent.first_current_entity_class["dimension_id_list"]:
+ return self._entity_parameter_value_to_add
+ db_map_entities = {
+ db_map: self.db_mngr.get_items_by_field(db_map, "entity", "class_id", class_id)
+ for db_map, class_id in self._parent.current_class_id.items()
+ }
+ ent_id_lookup = {
+ (db_map, x["element_id_list"]): x["id"] for db_map, entities in db_map_entities.items() for x in entities
+ }
+ return lambda db_map, header_ids, value, ent_id_lookup=ent_id_lookup: self._entity_parameter_value_to_add(
+ db_map, header_ids, value, ent_id_lookup
+ )
@staticmethod
def _parameter_value_to_update(id_, header_ids, value_and_type):
@@ -1239,10 +1373,61 @@ def get_set_data_delayed(self, index):
{db_map: [self._parameter_value_to_update(id_, header_ids, join_value_and_type(*value_type_tup))]}
)
+ def _get_db_map_parameter_value_or_def_ids(self, item_type):
+ """Returns a dict mapping db maps to a list of integer parameter (value or def) ids from the current class.
+
+ Args:
+ item_type (str): either "parameter_value" or "parameter_definition"
+
+ Returns:
+ dict
+ """
+ current_class_id = self._parent.current_class_id
+ return {
+ db_map: [x["id"] for x in self.db_mngr.get_items_by_field(db_map, item_type, "entity_class_id", class_id)]
+ for db_map, class_id in current_class_id.items()
+ }
+
+ def _get_db_map_parameter_values_or_defs(self, item_type):
+ """Returns a dict mapping db maps to list of dict parameter (value or def) items from the current class.
+
+ Args:
+ item_type (str): either "parameter_value" or "parameter_definition"
+
+ Returns:
+ dict
+ """
+ db_map_ids = self._get_db_map_parameter_value_or_def_ids(item_type)
+ return {
+ db_map: [self.db_mngr.get_item(db_map, item_type, id_) for id_ in ids] for db_map, ids in db_map_ids.items()
+ }
+
+ def load_full_parameter_value_data(self, db_map_parameter_values=None, action="add"):
+ """Returns a dict of parameter values for the current class.
+
+ Args:
+ db_map_parameter_values (list, optional)
+ action (str)
+
+ Returns:
+ dict: Key is a tuple object_id, ..., parameter_id, value is the parameter_value.
+ """
+ if db_map_parameter_values is None:
+ db_map_parameter_values = self._get_db_map_parameter_values_or_defs("parameter_value")
+ get_id = _make_get_id(action)
+ return {
+ tuple((db_map, id_) for id_ in x["element_id_list"] or (x["entity_id"],))
+ + ((db_map, x["parameter_id"]), (db_map, x["alternative_id"]), db_map): get_id(db_map, x)
+ for db_map, items in db_map_parameter_values.items()
+ for x in items
+ }
+
class IndexExpansionPivotTableModel(ParameterValuePivotTableModel):
"""A model for the pivot table in parameter index expansion input type."""
+ INDEX_INSERTION_POINT = -3
+
def __init__(self, parent):
"""
Args:
@@ -1253,10 +1438,10 @@ def __init__(self, parent):
def call_reset_model(self, pivot=None):
"""See base class."""
- object_class_ids = self._parent.current_object_class_ids
+ entity_class_ids = self._parent.current_dimension_ids
data = {}
top_left_headers = [
- TopLeftObjectHeaderItem(self, k, name, id_) for k, (name, id_) in enumerate(object_class_ids.items())
+ TopLeftEntityHeaderItem(self, k, name, id_) for k, (name, id_) in enumerate(entity_class_ids.items())
]
self._index_top_left_header = TopLeftParameterIndexHeaderItem(self)
top_left_headers += [
@@ -1277,6 +1462,12 @@ def call_reset_model(self, pivot=None):
# The parameter index is not a column (it's either a row or frozen)
pass
+ def emptyRowCount(self):
+ return 0
+
+ def emptyColumnCount(self):
+ return 0
+
def flags(self, index):
"""Roles for data"""
if self.index_in_data(index):
@@ -1298,11 +1489,57 @@ def column_is_index_column(self, column):
# The parameter index is not a column (it's either a row or frozen)
return False
- def _load_empty_parameter_value_data(self, *args, **kwargs):
- return self._parent.load_empty_expanded_parameter_value_data(*args, **kwargs)
+ def _handle_parameter_values_removed(self, db_map_data):
+ data = self._load_full_parameter_value_data(db_map_parameter_values=db_map_data, action="remove")
+ self.remove_from_model(data)
+
+ def _load_empty_parameter_value_data(
+ self, db_map_entities=None, db_map_parameter_ids=None, db_map_alternative_ids=None
+ ):
+ """Does not load the data since adding values in index expansion mode is disabled.
- def _load_full_parameter_value_data(self, *args, **kwargs):
- return self._parent.load_full_expanded_parameter_value_data(*args, **kwargs)
+ Args:
+ db_map_entities (dict, optional): mapping from database map to iterable of entity items
+ db_map_parameter_ids (dict, optional): mapping from database map
+ to iterable of parameter definition id tuples
+ db_map_alternative_ids (dict, optional): mapping from database map to iterable of alternative id tuples
+
+ Returns:
+ dict: empty data
+ """
+ return {}
+
+ def _load_full_parameter_value_data(self, db_map_parameter_values=None, action="add"):
+ """Makes a dict of expanded parameter values for the current class.
+
+ Args:
+ db_map_parameter_values (list, optional)
+ action (str)
+
+ Returns:
+ dict: mapping from unique value id tuple to value tuple
+ """
+ if db_map_parameter_values is None:
+ db_map_parameter_values = self._get_db_map_parameter_values_or_defs("parameter_value")
+ full_data = {}
+ get_id = _make_get_id(action)
+ for db_map, items in db_map_parameter_values.items():
+ for item in items:
+ element_ids = tuple((db_map, id_) for id_ in item["element_id_list"])
+ if not element_ids:
+ element_ids = ((db_map, item["entity_id"]),)
+ parameter_id = (db_map, item["parameter_id"])
+ parsed_value = item["parsed_value"]
+ if isinstance(parsed_value, IndexedValue):
+ value_indexes = parsed_value.indexes
+ else:
+ value_indexes = ("",)
+ alternative_ids = (db_map, item["alternative_id"])
+ for value_index in value_indexes:
+ full_data[element_ids + ((None, value_index), parameter_id, alternative_ids, db_map)] = get_id(
+ db_map, item
+ )
+ return full_data
def _data(self, index, role):
row, column = self.map_to_pivot(index)
@@ -1318,14 +1555,25 @@ def _data(self, index, role):
@staticmethod
def _parameter_value_to_update(id_, header_ids, value_and_type):
value, value_type = split_value_and_type(value_and_type)
- return {"id": id_, "value": value, "type": value_type, "index": header_ids[-3]}
+ return {
+ "id": id_,
+ "value": value,
+ "type": value_type,
+ "index": header_ids[IndexExpansionPivotTableModel.INDEX_INSERTION_POINT],
+ }
def _update_parameter_values(self, db_map_data):
self.db_mngr.update_expanded_parameter_values(db_map_data)
+ def _indexes(self, value):
+ if value is None:
+ return []
+ db_map, id_ = value
+ return self.db_mngr.get_value_indexes(db_map, "parameter_value", id_)
-class RelationshipPivotTableModel(PivotTableModelBase):
- """A model for the pivot table in relationship input type."""
+
+class ElementPivotTableModel(PivotTableModelBase):
+ """A model for the pivot table in element input type."""
def __init__(self, parent):
"""
@@ -1333,46 +1581,68 @@ def __init__(self, parent):
parent (SpineDBEditor)
"""
super().__init__(parent)
- self._relationship_fetch_parent = FlexibleFetchParent(
- "relationship",
- handle_items_added=self._handle_relationships_added,
- handle_items_removed=self._handle_relationships_removed,
+ self._entity_fetch_parent = FlexibleFetchParent(
+ "entity",
+ handle_items_added=self._handle_entities_added,
+ handle_items_removed=self._handle_entities_removed,
handle_items_updated=lambda _: self._parent.refresh_views(),
accepts_item=self._parent.accepts_entity_item,
owner=self,
chunk_size=None,
)
- self._object_fetch_parent = FlexibleFetchParent(
- "object",
- handle_items_added=self._handle_objects_added,
- handle_items_removed=self._handle_objects_removed,
+ self._element_fetch_parent = FlexibleFetchParent(
+ "entity",
+ handle_items_added=self._handle_elements_added,
+ handle_items_removed=self._handle_elements_removed,
handle_items_updated=lambda _: self._parent.refresh_views(),
- accepts_item=self._parent.accepts_member_object_item,
+ accepts_item=self._parent.accepts_element_item,
owner=self,
)
- def _handle_relationships_added(self, db_map_data):
- data = self._parent.load_full_relationship_data(db_map_relationships=db_map_data, action="add")
+ def _handle_entities_added(self, db_map_data):
+ data = self._load_full_element_data(db_map_entities=db_map_data, action="add")
self.update_model(data)
- def _handle_relationships_removed(self, db_map_data):
- data = self._parent.load_full_relationship_data(db_map_relationships=db_map_data, action="remove")
+ def _handle_entities_removed(self, db_map_data):
+ data = self._load_full_element_data(db_map_entities=db_map_data, action="remove")
self.update_model(data)
- def _load_empty_relationship_data(self, db_map_data):
- db_map_class_objects = dict()
+ def _load_empty_element_data(self, db_map_data):
+ if not self._parent.first_current_entity_class["dimension_id_list"]:
+ return {}
+ db_map_class_entities = {}
for db_map, items in db_map_data.items():
- class_objects = db_map_class_objects[db_map] = dict()
+ class_entities = db_map_class_entities[db_map] = {}
for item in items:
- class_objects.setdefault(item["class_id"], []).append(item)
- return self._parent.load_empty_relationship_data(db_map_class_objects=db_map_class_objects)
+ class_entities.setdefault(item["class_id"], []).append(item)
+ data = {}
+ for db_map in self.db_maps:
+ element_id_lists = []
+ all_given_ids = set()
+ for db_map_dimension_id in self._parent.current_dimension_id_list:
+ dim_id = db_map_dimension_id.get(db_map)
+ elements = self.db_mngr.get_items_by_field(db_map, "entity", "class_id", dim_id)
+ ids = {item["id"]: None for item in elements}
+ given_elements = db_map_class_entities.get(db_map, {}).get(dim_id)
+ if given_elements is not None:
+ given_ids = {item["id"]: None for item in given_elements}
+ ids.update(given_ids)
+ all_given_ids.update(given_ids.keys())
+ element_id_lists.append(list(ids.keys()))
+ db_map_data = {
+ tuple((db_map, id_) for id_ in element_ids) + (db_map,): None
+ for element_ids in product(*element_id_lists)
+ if not all_given_ids or all_given_ids.intersection(element_ids)
+ }
+ data.update(db_map_data)
+ return data
- def _handle_objects_added(self, db_map_data):
- data = self._load_empty_relationship_data(db_map_data)
+ def _handle_elements_added(self, db_map_data):
+ data = self._load_empty_element_data(db_map_data)
self.add_to_model(data)
- def _handle_objects_removed(self, db_map_data):
- data = self._load_empty_relationship_data(db_map_data)
+ def _handle_elements_removed(self, db_map_data):
+ data = self._load_empty_element_data(db_map_data)
self.remove_from_model(data)
@property
@@ -1380,15 +1650,15 @@ def item_type(self):
return "relationship"
def _fetch_parents(self):
- yield self._object_fetch_parent
- yield self._relationship_fetch_parent
+ yield self._element_fetch_parent
+ yield self._entity_fetch_parent
def call_reset_model(self, pivot=None):
"""See base class."""
- object_class_ids = self._parent.current_object_class_ids
+ entity_class_ids = self._parent.current_dimension_ids
data = {}
top_left_headers = [
- TopLeftObjectHeaderItem(self, k, name, id_) for k, (name, id_) in enumerate(object_class_ids.items())
+ TopLeftEntityHeaderItem(self, k, name, id_) for k, (name, id_) in enumerate(entity_class_ids.items())
]
top_left_headers += [TopLeftDatabaseHeaderItem(self)]
self.top_left_headers = {h.name: h for h in top_left_headers}
@@ -1417,16 +1687,13 @@ def _data(self, index, role):
return bool(data[0][0])
def _do_batch_set_inner_data(self, row_map, column_map, data, values):
- return self._batch_set_relationship_data(row_map, column_map, data, values)
+ return self._batch_set_entity_data(row_map, column_map, data, values)
- def _batch_set_relationship_data(self, row_map, column_map, data, values):
- def relationship_to_add(db_map, header_ids):
- rel_cls_name = self.db_mngr.get_item(
- db_map, "relationship_class", self._parent.current_class_id.get(db_map)
- )["name"]
- object_names = [self.db_mngr.get_item(db_map, "object", id_)["name"] for id_ in header_ids]
- name = rel_cls_name + "_" + "__".join(object_names)
- return dict(object_id_list=list(header_ids), class_id=self._parent.current_class_id.get(db_map), name=name)
+ def _batch_set_entity_data(self, row_map, column_map, data, values):
+ def entity_to_add(db_map, header_ids):
+ element_names = [self.db_mngr.get_item(db_map, "entity", id_)["name"] for id_ in header_ids]
+ name = name_from_elements(element_names)
+ return dict(element_id_list=list(header_ids), class_id=self._parent.current_class_id.get(db_map), name=name)
to_add = {}
to_remove = {}
@@ -1436,19 +1703,40 @@ def relationship_to_add(db_map, header_ids):
db_map = header_ids.pop()
header_ids = [id_ for _, id_ in header_ids]
if data[i][j] is None and values[row, column]:
- item = relationship_to_add(db_map, header_ids)
+ item = entity_to_add(db_map, header_ids)
to_add.setdefault(db_map, []).append(item)
elif data[i][j] is not None and not values[row, column]:
_, id_ = data[i][j]
- to_remove.setdefault(db_map, {}).setdefault("relationship", []).append(id_)
+ to_remove.setdefault(db_map, {}).setdefault("entity", []).append(id_)
if not to_add and not to_remove:
return False
if to_add:
- self.db_mngr.add_relationships(to_add)
+ self.db_mngr.add_entities(to_add)
if to_remove:
self.db_mngr.remove_items(to_remove)
return True
+ def _load_full_element_data(self, db_map_entities=None, action="add"):
+ """Returns a dict of entity elements in the current class.
+
+ Args:
+ db_map_entities (dict, optional): a mapping from database map to entities in the current entity class
+ action (str): 'add' or 'remove'
+
+ Returns:
+ dict: Key is db_map-object id tuple, value is relationship id.
+ """
+ if not self._parent.first_current_entity_class.get("dimension_id_list", None):
+ return {}
+ if db_map_entities is None:
+ db_map_entities = self.get_db_map_entities()
+ get_id = _make_get_id(action)
+ return {
+ tuple((db_map, id_) for id_ in ent["element_id_list"]) + (db_map,): get_id(db_map, ent)
+ for db_map, entities in db_map_entities.items()
+ for ent in entities
+ }
+
class ScenarioAlternativePivotTableModel(PivotTableModelBase):
"""A model for the pivot table in scenario alternative input type."""
@@ -1482,19 +1770,19 @@ def __init__(self, parent):
)
def _handle_scenarios_added(self, db_map_data):
- data = self._parent.load_scenario_alternative_data(db_map_scenarios=db_map_data)
+ data = self._load_scenario_alternative_data(db_map_scenarios=db_map_data)
self.add_to_model(data)
def _handle_scenarios_removed(self, db_map_data):
- data = self._parent.load_scenario_alternative_data(db_map_scenarios=db_map_data)
+ data = self._load_scenario_alternative_data(db_map_scenarios=db_map_data)
self.remove_from_model(data)
def _handle_alternatives_added(self, db_map_data):
- data = self._parent.load_scenario_alternative_data(db_map_alternatives=db_map_data)
+ data = self._load_scenario_alternative_data(db_map_alternatives=db_map_data)
self.add_to_model(data)
def _handle_alternatives_removed(self, db_map_data):
- data = self._parent.load_scenario_alternative_data(db_map_alternatives=db_map_data)
+ data = self._load_scenario_alternative_data(db_map_alternatives=db_map_data)
self.remove_from_model(data)
def _handle_scenario_alternatives_changed(self, db_map_data):
@@ -1502,7 +1790,7 @@ def _handle_scenario_alternatives_changed(self, db_map_data):
db_map: [self.db_mngr.get_item(db_map, "scenario", x["scenario_id"]) for x in items]
for db_map, items in db_map_data.items()
}
- data = self._parent.load_scenario_alternative_data(db_map_scenarios=db_map_scenarios)
+ data = self._load_scenario_alternative_data(db_map_scenarios=db_map_scenarios)
self.update_model(data)
@property
@@ -1587,6 +1875,34 @@ def _batch_set_scenario_alternative_data(self, row_map, column_map, data, values
self.db_mngr.set_scenario_alternatives(db_map_items)
return True
+ def _load_scenario_alternative_data(self, db_map_scenarios=None, db_map_alternatives=None):
+ """Returns a dict containing all scenario alternatives.
+
+ Returns:
+ dict: Key is db_map-id tuple, value is None or rank.
+ """
+ if db_map_scenarios is None:
+ db_map_scenarios = {db_map: self.db_mngr.get_items(db_map, "scenario") for db_map in self.db_maps}
+ if db_map_alternatives is None:
+ db_map_alternatives = {db_map: self.db_mngr.get_items(db_map, "alternative") for db_map in self.db_maps}
+ data = {}
+ for db_map in self.db_maps:
+ scenario_alternative_ranks = {
+ x["id"]: {
+ alt_id: k + 1
+ for k, alt_id in enumerate(self.db_mngr.get_scenario_alternative_id_list(db_map, x["id"]))
+ }
+ for x in db_map_scenarios.get(db_map, [])
+ }
+ alternative_ids = [x["id"] for x in db_map_alternatives.get(db_map, [])]
+ db_map_data = {
+ ((db_map, scen_id), (db_map, alt_id), db_map): alternative_ranks.get(alt_id)
+ for scen_id, alternative_ranks in scenario_alternative_ranks.items()
+ for alt_id in alternative_ids
+ }
+ data.update(db_map_data)
+ return data
+
class PivotTableSortFilterProxy(QSortFilterProxyModel):
model_data_changed = Signal()
@@ -1621,7 +1937,9 @@ def clear_filter(self):
def accept_index(self, index, index_ids):
for i, identifier in zip(index, index_ids):
valid = self.index_filters.get(identifier)
- if valid is not None and i not in valid:
+ # NOTE: the tuple() below is to work-around TempId.__hash__,
+ # but we should fix the latter.
+ if valid is not None and i not in tuple(valid):
return False
return True
@@ -1653,3 +1971,15 @@ def filterAcceptsColumn(self, source_column, source_parent):
def batch_set_data(self, indexes, values):
indexes = [self.mapToSource(index) for index in indexes]
return self.sourceModel().batch_set_data(indexes, values)
+
+
+def _make_get_id(action):
+ """Returns a function to compute the db_map-id tuple of an item.
+
+ Args:
+ action (str): "add" or "remove"
+
+ Returns:
+ Callable: function to compute db_map-id tuples
+ """
+ return {"add": lambda db_map, x: (db_map, x["id"]), "remove": lambda db_map, x: None}[action]
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/scenario_item.py b/spinetoolbox/spine_db_editor/mvcmodels/scenario_item.py
index 0a577ade8..4a3ec4437 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/scenario_item.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/scenario_item.py
@@ -11,7 +11,6 @@
"""Classes to represent items in scenario tree."""
from PySide6.QtCore import Qt
-
from .tree_item_utility import (
BoldTextMixin,
EditableMixin,
@@ -37,10 +36,10 @@ def fetch_item_type(self):
return "scenario"
def empty_child(self):
- return ScenarioItem()
+ return ScenarioItem(self._model)
def _make_child(self, id_):
- return ScenarioItem(id_)
+ return ScenarioItem(self._model, id_)
class ScenarioItem(GrayIfLastMixin, EditableMixin, EmptyChildMixin, FetchMoreMixin, BoldTextMixin, LeafItem):
@@ -58,10 +57,10 @@ def fetch_item_type(self):
def icon_code(self):
return _SCENARIO_ICON
- @property
- def tool_tip(self):
- if not self.id:
+ def tool_tip(self, column):
+ if column == 0 and not self.id:
return "Note: Scenario names longer than 20 characters might appear shortened in generated files.
"
+ return super().tool_tip(column)
def _do_set_up(self):
"""Doesn't add children to the last row."""
@@ -93,11 +92,18 @@ def update_alternative_id_list(self):
curr_alt_count = len(self.non_empty_children)
if alt_count > curr_alt_count:
added_count = alt_count - curr_alt_count
- children = [ScenarioAlternativeItem() for _ in range(added_count)]
+ children = [ScenarioAlternativeItem(self._model) for _ in range(added_count)]
self.insert_children(curr_alt_count, children)
elif curr_alt_count > alt_count:
removed_count = curr_alt_count - alt_count
self.remove_children(alt_count, removed_count)
+ else:
+ self.model.dataChanged.emit(
+ self.model.index(0, 0, self.index()), self.model.index(self.row_count() - 1, 0, self.index())
+ )
+
+ def accepts_item(self, item, db_map):
+ return db_map == self.db_map and item["scenario_id"] == self.id
def handle_items_added(self, _db_map_data):
self.update_alternative_id_list()
@@ -110,7 +116,7 @@ def handle_items_updated(self, _db_map_data):
def empty_child(self):
"""See base class."""
- return ScenarioAlternativeItem()
+ return ScenarioAlternativeItem(self._model)
def _make_child(self, id_):
"""Not needed - we don't quite add children here, but rather update them in update_alternative_id_list."""
@@ -123,9 +129,10 @@ class ScenarioAlternativeItem(GrayIfLastMixin, EditableMixin, LeafItem):
def item_type(self):
return "scenario_alternative"
- @property
- def tool_tip(self):
- return "Drag and drop this item to reorder scenario alternatives
"
+ def tool_tip(self, column):
+ if column == 0:
+ return "Drag and drop this item to reorder scenario alternatives
"
+ return super().tool_tip(column)
def _make_item_data(self):
return {"name": "Type scenario alternative name here...", "description": ""}
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/scenario_model.py b/spinetoolbox/spine_db_editor/mvcmodels/scenario_model.py
index 1c23f0d17..aac69c7e6 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/scenario_model.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/scenario_model.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -8,10 +9,10 @@
# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
# this program. If not, see .
######################################################################################################################
+
"""Contains scenario tree model."""
import pickle
-
-from PySide6.QtCore import QMimeData, Qt
+from PySide6.QtCore import QMimeData, Qt, QByteArray
from spinetoolbox.helpers import unique_name
from .tree_model_base import TreeModelBase
from .scenario_item import ScenarioDBItem, ScenarioAlternativeItem, ScenarioItem
@@ -22,13 +23,8 @@
class ScenarioModel(TreeModelBase):
"""A model to display scenarios in a tree view."""
- @staticmethod
- def _make_db_item(db_map):
- return ScenarioDBItem(db_map)
-
- @staticmethod
- def _top_children():
- return []
+ def _make_db_item(self, db_map):
+ return ScenarioDBItem(self, db_map)
def supportedDropActions(self):
return Qt.DropAction.CopyAction | Qt.DropAction.MoveAction
@@ -66,7 +62,7 @@ def mimeData(self, indexes):
db_item = item.parent_item
db_key = self.db_mngr.db_map_key(db_item.db_map)
scenario_data.setdefault(db_key, []).append(item.id)
- mime.setData(mime_types.SCENARIO_DATA, pickle.dumps(scenario_data))
+ mime.setData(mime_types.SCENARIO_DATA, QByteArray(pickle.dumps(scenario_data)))
mime.setText(two_column_as_csv(scenario_indexes))
return mime
alternative_indexes = []
@@ -84,18 +80,18 @@ def mimeData(self, indexes):
db_item = item.parent_item.parent_item
db_key = self.db_mngr.db_map_key(db_item.db_map)
alternative_data.setdefault(db_key, []).append(item.alternative_id)
- mime.setData(mime_types.ALTERNATIVE_DATA, pickle.dumps(alternative_data))
+ mime.setData(mime_types.ALTERNATIVE_DATA, QByteArray(pickle.dumps(alternative_data)))
mime.setText(two_column_as_csv(alternative_indexes))
return mime
return None
- def canDropMimeData(self, data, drop_action, row, column, parent):
+ def canDropMimeData(self, mime_data, drop_action, row, column, parent):
if drop_action & self.supportedDropActions() == 0:
return False
- if not data.hasFormat(mime_types.ALTERNATIVE_DATA):
+ if not mime_data.hasFormat(mime_types.ALTERNATIVE_DATA):
return False
try:
- payload = pickle.loads(data.data(mime_types.ALTERNATIVE_DATA))
+ payload = pickle.loads(mime_data.data(mime_types.ALTERNATIVE_DATA).data())
except pickle.UnpicklingError:
return False
if not isinstance(payload, dict):
@@ -115,12 +111,12 @@ def canDropMimeData(self, data, drop_action, row, column, parent):
db_item = self.db_item(parent_item)
if db_map != db_item.db_map:
return False
- if data.hasFormat("application/vnd.spinetoolbox.scenario-alternative"):
+ if mime_data.hasFormat("application/vnd.spinetoolbox.scenario-alternative"):
# Check that reordering only happens within the same scenario
return False
return True
- def dropMimeData(self, data, drop_action, row, column, parent):
+ def dropMimeData(self, mime_data, drop_action, row, column, parent):
# This function expects that data has be verified by canDropMimeData() already.
scenario_item = self.item_from_index(parent)
if not isinstance(scenario_item, ScenarioItem):
@@ -128,15 +124,7 @@ def dropMimeData(self, data, drop_action, row, column, parent):
# on a wrong tree item (bug in Qt or canDropMimeData()?).
# In those cases the type of scen_item is StandardTreeItem or ScenarioRootItem.
return False
- old_alternative_id_list = list(scenario_item.alternative_id_list)
- if row == -1:
- row = len(old_alternative_id_list)
- db_map_key, alternative_ids = pickle.loads(data.data(mime_types.ALTERNATIVE_DATA)).popitem()
- alternative_id_list = [id_ for id_ in old_alternative_id_list[:row] if id_ not in alternative_ids]
- alternative_id_list += alternative_ids
- alternative_id_list += [id_ for id_ in old_alternative_id_list[row:] if id_ not in alternative_ids]
- db_item = {"id": scenario_item.id, "alternative_id_list": alternative_id_list}
- self.db_mngr.set_scenario_alternatives({scenario_item.db_map: [db_item]})
+ self.paste_alternative_mime_data(mime_data, row, scenario_item)
return True
def paste_alternative_mime_data(self, mime_data, row, scenario_item):
@@ -150,16 +138,21 @@ def paste_alternative_mime_data(self, mime_data, row, scenario_item):
old_alternative_id_list = list(scenario_item.alternative_id_list)
if row == -1:
row = len(old_alternative_id_list)
- data_to_add = {}
- for db_map_key, alternative_ids in pickle.loads(mime_data.data(mime_types.ALTERNATIVE_DATA)).items():
+ new_alternative_ids = []
+ for db_map_key, alternative_names in pickle.loads(mime_data.data(mime_types.ALTERNATIVE_DATA).data()).items():
target_db_map = self.db_mngr.db_map_from_key(db_map_key)
if target_db_map != scenario_item.db_map:
continue
- alternative_id_list = [id_ for id_ in old_alternative_id_list[:row] if id_ not in alternative_ids]
- alternative_id_list += alternative_ids
- alternative_id_list += [id_ for id_ in old_alternative_id_list[row:] if id_ not in alternative_ids]
- data_to_add[target_db_map] = [{"id": scenario_item.id, "alternative_id_list": alternative_id_list}]
- self.db_mngr.set_scenario_alternatives(data_to_add)
+ for name in alternative_names:
+ if isinstance(name, str):
+ new_alternative_ids.append(scenario_item.db_map.get_alternative_item(name=name)["id"])
+ else: # When rearranging alternatives in a scenario, the id is given straight
+ new_alternative_ids.append(name)
+ alternative_id_list = [id_ for id_ in old_alternative_id_list[:row] if id_ not in new_alternative_ids]
+ alternative_id_list += new_alternative_ids
+ alternative_id_list += [id_ for id_ in old_alternative_id_list[row:] if id_ not in new_alternative_ids]
+ db_item = {"id": scenario_item.id, "alternative_id_list": alternative_id_list}
+ self.db_mngr.set_scenario_alternatives({scenario_item.db_map: [db_item]})
def paste_scenario_mime_data(self, mime_data, db_item):
"""Adds scenarios and their alternatives from MIME data to the model.
@@ -171,38 +164,36 @@ def paste_scenario_mime_data(self, mime_data, db_item):
scenarios_to_add = []
alternatives_to_add = []
alternative_names_by_scenario = {}
- existing_scenarios = {i.name for i in self.db_mngr.get_items(db_item.db_map, "scenario", only_visible=False)}
- existing_alternatives = {
- i.name for i in self.db_mngr.get_items(db_item.db_map, "alternative", only_visible=False)
- }
- for db_map_key, scenario_ids in pickle.loads(mime_data.data(mime_types.SCENARIO_DATA)).items():
+ existing_scenarios = {i["name"] for i in self.db_mngr.get_items(db_item.db_map, "scenario")}
+ existing_alternatives = {i["name"] for i in self.db_mngr.get_items(db_item.db_map, "alternative")}
+ for db_map_key, scenario_names in pickle.loads(mime_data.data(mime_types.SCENARIO_DATA).data()).items():
db_map = self.db_mngr.db_map_from_key(db_map_key)
if db_map is db_item.db_map:
continue
- for id_ in scenario_ids:
- scenario_data = self.db_mngr.get_item(db_map, "scenario", id_, only_visible=False)
- if scenario_data.name in existing_scenarios:
+ for name in scenario_names:
+ scenario_data = db_map.get_scenario_item(name=name)
+ if scenario_data["name"] in existing_scenarios:
continue
- alternative_id_list = self.db_mngr.get_scenario_alternative_id_list(db_map, id_, only_visible=False)
+ alternative_id_list = self.db_mngr.get_scenario_alternative_id_list(db_map, scenario_data["id"])
for alternative_id in alternative_id_list:
- alternative_db_item = self.db_mngr.get_item(
- db_map, "alternative", alternative_id, only_visible=False
+ alternative_db_item = self.db_mngr.get_item(db_map, "alternative", alternative_id)
+ alternative_names_by_scenario.setdefault(scenario_data["name"], []).append(
+ alternative_db_item["name"]
)
- alternative_names_by_scenario.setdefault(scenario_data.name, []).append(alternative_db_item.name)
- if alternative_db_item.name in existing_alternatives:
+ if alternative_db_item["name"] in existing_alternatives:
continue
alternatives_to_add.append(
- {"name": alternative_db_item.name, "description": alternative_db_item.description}
+ {"name": alternative_db_item["name"], "description": alternative_db_item["description"]}
)
- scenarios_to_add.append({"name": scenario_data.name, "description": scenario_data.description})
+ scenarios_to_add.append({"name": scenario_data["name"], "description": scenario_data["description"]})
if scenarios_to_add:
if alternatives_to_add:
self.db_mngr.add_alternatives({db_item.db_map: alternatives_to_add})
self.db_mngr.add_scenarios({db_item.db_map: scenarios_to_add})
- alternatives = self.db_mngr.get_items(db_item.db_map, "alternative", only_visible=False)
- alternative_id_by_name = {i.name: i.id for i in alternatives}
+ alternatives = self.db_mngr.get_items(db_item.db_map, "alternative")
+ alternative_id_by_name = {i["name"]: i["id"] for i in alternatives}
scenarios = self.db_mngr.get_items(db_item.db_map, "scenario")
- scenario_id_by_name = {i.name: i.id for i in scenarios}
+ scenario_id_by_name = {i["name"]: i["id"] for i in scenarios}
scenario_alternative_id_lists = []
for scenario_name, alternative_name_list in alternative_names_by_scenario.items():
alternative_id_list = [alternative_id_by_name[name] for name in alternative_name_list]
@@ -218,15 +209,13 @@ def duplicate_scenario(self, scenario_item):
scenario_item (ScenarioItem): scenario item to duplicate
"""
db_map = scenario_item.db_map
- existing_names = {i.name for i in self.db_mngr.get_items(db_map, "scenario", only_visible=False)}
- name = unique_name(scenario_item.item_data.name, existing_names)
- self.db_mngr.add_scenarios({db_map: [{"name": name, "description": scenario_item.item_data.description}]})
- alternative_id_list = self.db_mngr.get_scenario_alternative_id_list(
- db_map, scenario_item.id, only_visible=False
- )
- for item in self.db_mngr.get_items(db_map, "scenario", only_visible=False):
- if item.name == name:
+ existing_names = {i["name"] for i in self.db_mngr.get_items(db_map, "scenario")}
+ name = unique_name(scenario_item.item_data["name"], existing_names)
+ self.db_mngr.add_scenarios({db_map: [{"name": name, "description": scenario_item.item_data["description"]}]})
+ alternative_id_list = self.db_mngr.get_scenario_alternative_id_list(db_map, scenario_item.id)
+ for item in self.db_mngr.get_items(db_map, "scenario"):
+ if item["name"] == name:
self.db_mngr.set_scenario_alternatives(
- {db_map: [{"id": item.id, "alternative_id_list": alternative_id_list}]}
+ {db_map: [{"id": item["id"], "alternative_id_list": alternative_id_list}]}
)
break
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/single_and_empty_model_mixins.py b/spinetoolbox/spine_db_editor/mvcmodels/single_and_empty_model_mixins.py
new file mode 100644
index 000000000..b033e0516
--- /dev/null
+++ b/spinetoolbox/spine_db_editor/mvcmodels/single_and_empty_model_mixins.py
@@ -0,0 +1,76 @@
+######################################################################################################################
+# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
+# This file is part of Spine Toolbox.
+# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
+# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
+# any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+# without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
+# this program. If not, see .
+######################################################################################################################
+
+"""Miscellaneous mixins for parameter models."""
+
+from spinedb_api.parameter_value import split_value_and_type
+
+
+class ConvertToDBMixin:
+ """Base class for all mixins that convert model items (name-based) into database items (id-based)."""
+
+ # pylint: disable=no-self-use
+ def _convert_to_db(self, item):
+ """Returns a db item (id-based) from the given model item (name-based).
+
+ Args:
+ item (dict): the model item
+
+ Returns:
+ dict: the db item
+ list: error log
+ """
+ item = item.copy()
+ for field, real_field in self.field_map.items():
+ if field in item:
+ item[real_field] = item.pop(field)
+ return item.copy(), []
+
+
+class SplitValueAndTypeMixin(ConvertToDBMixin):
+ def _convert_to_db(self, item):
+ item, err = super()._convert_to_db(item)
+ value_field, type_field = {
+ "parameter_value": ("value", "type"),
+ "parameter_definition": ("default_value", "default_type"),
+ }[self.item_type]
+ if value_field in item:
+ value, value_type = split_value_and_type(item[value_field])
+ item[value_field] = value
+ item[type_field] = value_type
+ return item, err
+
+
+class MakeEntityOnTheFlyMixin(ConvertToDBMixin):
+ """Makes relationships on the fly."""
+
+ @staticmethod
+ def _make_entity_on_the_fly(item, db_map):
+ """Returns a database entity item (id-based) from the given model parameter_value item (name-based).
+
+ Args:
+ item (dict): the model parameter_value item
+ db_map (DiffDatabaseMapping): the database where the resulting item belongs
+
+ Returns:
+ dict: the db entity item
+ list: error log
+ """
+ entity_class_name = item.get("entity_class_name")
+ entity_class = db_map.get_item("entity_class", name=entity_class_name)
+ if not entity_class:
+ return None, [f"Unknown entity_class {entity_class_name}"] if entity_class_name else []
+ entity_byname = item.get("entity_byname")
+ if not entity_byname:
+ return None, []
+ item = {"entity_class_name": entity_class_name, "entity_byname": entity_byname}
+ return None if db_map.get_item("entity", **item) else item, []
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/single_models.py b/spinetoolbox/spine_db_editor/mvcmodels/single_models.py
new file mode 100644
index 000000000..47c9d5f48
--- /dev/null
+++ b/spinetoolbox/spine_db_editor/mvcmodels/single_models.py
@@ -0,0 +1,417 @@
+######################################################################################################################
+# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
+# This file is part of Spine Toolbox.
+# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
+# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
+# any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+# without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
+# this program. If not, see .
+######################################################################################################################
+
+"""Single models for parameter definitions and values (as 'for a single entity')."""
+from PySide6.QtCore import Qt
+from spinetoolbox.helpers import DB_ITEM_SEPARATOR, plain_to_rich
+from ...mvcmodels.minimal_table_model import MinimalTableModel
+from ..mvcmodels.single_and_empty_model_mixins import SplitValueAndTypeMixin, MakeEntityOnTheFlyMixin
+from ...mvcmodels.shared import PARSED_ROLE, DB_MAP_ROLE
+from .colors import FIXED_FIELD_COLOR
+
+
+class HalfSortedTableModel(MinimalTableModel):
+ def reset_model(self, main_data=None):
+ """Reset model."""
+ if main_data is None:
+ main_data = []
+ self.beginResetModel()
+ self._main_data = sorted(main_data, key=self._sort_key)
+ self.endResetModel()
+
+ def add_rows(self, data):
+ data = [item for item in data if item not in self._main_data]
+ if not data:
+ return
+ self.beginResetModel()
+ self._main_data += data
+ self._main_data.sort(key=self._sort_key)
+ self.endResetModel()
+
+ def _sort_key(self, element):
+ return element
+
+
+class SingleModelBase(HalfSortedTableModel):
+ """Base class for all single models that go in a CompoundModelBase subclass."""
+
+ def __init__(self, parent, db_map, entity_class_id, committed, lazy=False):
+ """
+ Args:
+ parent (CompoundModelBase): the parent model
+ db_map (DatabaseMapping)
+ entity_class_id (int)
+ committed (bool)
+ """
+ super().__init__(parent=parent, header=parent.header, lazy=lazy)
+ self.db_mngr = parent.db_mngr
+ self.db_map = db_map
+ self.entity_class_id = entity_class_id
+ self._auto_filter = {} # Maps field to accepted ids for that field
+ self.committed = committed
+
+ def __lt__(self, other):
+ if self.entity_class_name == other.entity_class_name:
+ return self.db_map.codename < other.db_map.codename
+ return self.entity_class_name < other.entity_class_name
+
+ @property
+ def item_type(self):
+ """The DB item type, required by the data method."""
+ raise NotImplementedError()
+
+ @property
+ def field_map(self):
+ return self._parent.field_map
+
+ def update_items_in_db(self, items):
+ """Update items in db. Required by batch_set_data"""
+ items_to_upd = []
+ error_log = []
+ for item in items:
+ item_to_upd, errors = self._convert_to_db(item)
+ if tuple(item_to_upd.keys()) != ("id",):
+ items_to_upd.append(item_to_upd)
+ if errors:
+ error_log += errors
+ if items_to_upd:
+ self._do_update_items_in_db({self.db_map: items_to_upd})
+ if error_log:
+ self.db_mngr.error_msg.emit({self.db_map: error_log})
+
+ @property
+ def _references(self):
+ raise NotImplementedError()
+
+ @property
+ def entity_class_name(self):
+ return self.db_mngr.get_item(self.db_map, "entity_class", self.entity_class_id)["name"]
+
+ @property
+ def dimension_id_list(self):
+ return self.db_mngr.get_item(self.db_map, "entity_class", self.entity_class_id)["dimension_id_list"]
+
+ @property
+ def fixed_fields(self):
+ return ["entity_class_name", "database"]
+
+ @property
+ def group_fields(self):
+ return ["entity_byname"]
+
+ @property
+ def can_be_filtered(self):
+ return True
+
+ def _mapped_field(self, field):
+ return self.field_map.get(field, field)
+
+ def item_id(self, row):
+ """Returns parameter id for row.
+
+ Args:
+ row (int): row index
+
+ Returns:
+ int: parameter id
+ """
+ return self._main_data[row]
+
+ def item_ids(self):
+ """Returns model's parameter ids.
+
+ Returns:
+ set of int: ids
+ """
+ return set(self._main_data)
+
+ def db_item(self, index):
+ return self._db_item(index.row())
+
+ def _db_item(self, row):
+ id_ = self._main_data[row]
+ return self.db_item_from_id(id_)
+
+ def db_item_from_id(self, id_):
+ return self.db_mngr.get_item(self.db_map, self.item_type, id_)
+
+ def db_items(self):
+ return [self._db_item(row) for row in range(self.rowCount())]
+
+ def flags(self, index):
+ """Make fixed indexes non-editable."""
+ flags = super().flags(index)
+ if self.header[index.column()] in self.fixed_fields:
+ return flags & ~Qt.ItemIsEditable
+ return flags
+
+ def _filter_accepts_row(self, row):
+ item = self.db_mngr.get_item(self.db_map, self.item_type, self._main_data[row])
+ return self.filter_accepts_item(item)
+
+ def filter_accepts_item(self, item):
+ return self._auto_filter_accepts_item(item)
+
+ def set_auto_filter(self, field, values):
+ if values == self._auto_filter.get(field, set()):
+ return False
+ self._auto_filter[field] = values
+ return True
+
+ def _auto_filter_accepts_item(self, item):
+ """Returns the result of the auto filter."""
+ if self._auto_filter is None:
+ return False
+ for field, values in self._auto_filter.items():
+ if values and item.get(field) not in values:
+ return False
+ return True
+
+ def accepted_rows(self):
+ """Yields accepted rows, for convenience."""
+ for row in range(self.rowCount()):
+ if self._filter_accepts_row(row):
+ yield row
+
+ def _get_ref(self, db_item, field):
+ """Returns the item referred by the given field."""
+ ref = self._references.get(field)
+ if ref is None:
+ return {}
+ src_id_key, ref_type = ref
+ ref_if = db_item.get(src_id_key)
+ return self.db_mngr.get_item(self.db_map, ref_type, ref_if)
+
+ def data(self, index, role=Qt.ItemDataRole.DisplayRole):
+ field = self.header[index.column()]
+ if role == Qt.ItemDataRole.BackgroundRole and field in self.fixed_fields:
+ return FIXED_FIELD_COLOR
+ if role in (Qt.ItemDataRole.DisplayRole, Qt.ItemDataRole.EditRole, Qt.ItemDataRole.ToolTipRole):
+ if field == "database":
+ return self.db_map.codename
+ id_ = self._main_data[index.row()]
+ item = self.db_mngr.get_item(self.db_map, self.item_type, id_)
+ if role == Qt.ItemDataRole.ToolTipRole:
+ description = self._get_ref(item, field).get("description")
+ if description:
+ return plain_to_rich(description)
+ mapped_field = self._mapped_field(field)
+ data = item.get(mapped_field)
+ if data and field in self.group_fields:
+ data = DB_ITEM_SEPARATOR.join(data)
+ return data
+ if role == Qt.ItemDataRole.DecorationRole and field == "entity_class_name":
+ return self.db_mngr.entity_class_icon(self.db_map, self.entity_class_id)
+ if role == DB_MAP_ROLE:
+ return self.db_map
+ return super().data(index, role)
+
+ def batch_set_data(self, indexes, data):
+ """Sets data for indexes in batch.
+ Sets data directly in database using db mngr. If successful, updated data will be
+ automatically seen by the data method.
+ """
+
+ def split_value(value, column):
+ if self.header[column] in self.group_fields:
+ return tuple(value.split(DB_ITEM_SEPARATOR))
+ return value
+
+ if not indexes or not data:
+ return False
+ row_data = {}
+ for index, value in zip(indexes, data):
+ row_data.setdefault(index.row(), {})[self.header[index.column()]] = split_value(value, index.column())
+ items = [dict(id=self._main_data[row], **data) for row, data in row_data.items()]
+ self.update_items_in_db(items)
+ return True
+
+
+class FilterEntityAlternativeMixin:
+ """Provides the interface to filter by entity and alternative."""
+
+ def __init__(self, *args, **kwargs):
+ super().__init__(*args, **kwargs)
+ self._filter_alternative_ids = set()
+ self._filter_entity_ids = set()
+
+ def set_filter_entity_ids(self, db_map_class_entity_ids):
+ # Don't accept entity id filters from entities that don't belong in this model
+ filter_entity_ids = set().union(
+ *(
+ ent_ids
+ for (db_map, class_id), ent_ids in db_map_class_entity_ids.items()
+ if db_map == self.db_map and (class_id == self.entity_class_id or class_id in self.dimension_id_list)
+ )
+ )
+ if self._filter_entity_ids == filter_entity_ids:
+ return False
+ self._filter_entity_ids = filter_entity_ids
+ return True
+
+ def set_filter_alternative_ids(self, db_map_alternative_ids):
+ alternative_ids = db_map_alternative_ids.get(self.db_map, set())
+ if self._filter_alternative_ids == alternative_ids:
+ return False
+ self._filter_alternative_ids = alternative_ids
+ return True
+
+ def filter_accepts_item(self, item):
+ """Reimplemented to also account for the entity and alternative filter."""
+ return (
+ super().filter_accepts_item(item)
+ and self._entity_filter_accepts_item(item)
+ and self._alternative_filter_accepts_item(item)
+ )
+
+ def _entity_filter_accepts_item(self, item):
+ """Returns the result of the entity filter."""
+ if not self._filter_entity_ids: # If no entities are selected, only entity classes
+ return True
+ entity_id = item[self._mapped_field("entity_id")]
+ return entity_id in self._filter_entity_ids or bool(set(item["element_id_list"]) & self._filter_entity_ids)
+
+ def _alternative_filter_accepts_item(self, item):
+ """Returns the result of the alternative filter."""
+ if not self._filter_alternative_ids:
+ return True
+ alternative_id = item.get("alternative_id")
+ return alternative_id is None or alternative_id in self._filter_alternative_ids
+
+
+class ParameterMixin:
+ """Provides the data method for parameter values and definitions."""
+
+ @property
+ def value_field(self):
+ return {"parameter_definition": "default_value", "parameter_value": "value"}[self.item_type]
+
+ @property
+ def parameter_definition_id_key(self):
+ return {"parameter_definition": "id", "parameter_value": "parameter_id"}[self.item_type]
+
+ @property
+ def _references(self):
+ return {
+ "entity_class_name": ("entity_class_id", "entity_class"),
+ "entity_byname": ("entity_id", "entity"),
+ "parameter_name": (self.parameter_definition_id_key, "parameter_definition"),
+ "value_list_name": ("value_list_id", "parameter_value_list"),
+ "description": ("id", "parameter_definition"),
+ "value": ("id", "parameter_value"),
+ "default_value": ("id", "parameter_definition"),
+ "database": ("database", None),
+ "alternative_name": ("alternative_id", "alternative"),
+ }
+
+ def data(self, index, role=Qt.ItemDataRole.DisplayRole):
+ """Gets the id and database for the row, and reads data from the db manager
+ using the item_type property.
+ Paint the object_class icon next to the name.
+ Also paint background of fixed indexes gray and apply custom format to JSON fields."""
+ field = self.header[index.column()]
+ # Display, edit, tool tip, alignment role of 'value fields'
+ if field == self.value_field and role in (
+ Qt.ItemDataRole.DisplayRole,
+ Qt.ItemDataRole.EditRole,
+ Qt.ItemDataRole.ToolTipRole,
+ Qt.TextAlignmentRole,
+ PARSED_ROLE,
+ ):
+ id_ = self._main_data[index.row()]
+ item = self.db_mngr.get_item(self.db_map, self.item_type, id_)
+ return self.db_mngr.get_value(self.db_map, item, role)
+ return super().data(index, role)
+
+
+class EntityMixin:
+ def update_items_in_db(self, items):
+ """Overriden to create entities on the fly first."""
+ for item in items:
+ item["entity_class_name"] = self.entity_class_name
+ entities = []
+ error_log = []
+ for item in items:
+ entity, errors = self._make_entity_on_the_fly(item, self.db_map)
+ if entity:
+ entities.append(entity)
+ if errors:
+ error_log.extend(errors)
+ if entities:
+ self.db_mngr.add_entities({self.db_map: entities})
+ if error_log:
+ self.db_mngr.error_msg.emit({self.db_map: error_log})
+ super().update_items_in_db(items)
+
+ def _do_update_items_in_db(self, db_map_data):
+ raise NotImplementedError()
+
+
+class SingleParameterDefinitionModel(SplitValueAndTypeMixin, ParameterMixin, SingleModelBase):
+ """A parameter_definition model for a single entity_class."""
+
+ @property
+ def item_type(self):
+ return "parameter_definition"
+
+ def _sort_key(self, element):
+ item = self.db_item_from_id(element)
+ return item.get("name", "")
+
+ def _do_update_items_in_db(self, db_map_data):
+ self.db_mngr.update_parameter_definitions(db_map_data)
+
+
+class SingleParameterValueModel(
+ MakeEntityOnTheFlyMixin,
+ SplitValueAndTypeMixin,
+ ParameterMixin,
+ EntityMixin,
+ FilterEntityAlternativeMixin,
+ SingleModelBase,
+):
+ """A parameter_value model for a single entity_class."""
+
+ @property
+ def item_type(self):
+ return "parameter_value"
+
+ def _sort_key(self, element):
+ item = self.db_item_from_id(element)
+ return (item.get("entity_byname", ()), item.get("parameter_name", ""), item.get("alternative_name", ""))
+
+ def _do_update_items_in_db(self, db_map_data):
+ self.db_mngr.update_parameter_values(db_map_data)
+
+
+class SingleEntityAlternativeModel(MakeEntityOnTheFlyMixin, EntityMixin, FilterEntityAlternativeMixin, SingleModelBase):
+ """An entity_alternative model for a single entity_class."""
+
+ @property
+ def item_type(self):
+ return "entity_alternative"
+
+ def _sort_key(self, element):
+ item = self.db_item_from_id(element)
+ return (item.get("entity_byname", ()), item.get("alternative_name", ""))
+
+ @property
+ def _references(self):
+ return {
+ "entity_class_name": ("entity_class_id", "entity_class"),
+ "entity_byname": ("entity_id", "entity"),
+ "alternative_name": ("alternative_id", "alternative"),
+ "database": ("database", None),
+ }
+
+ def _do_update_items_in_db(self, db_map_data):
+ self.db_mngr.update_entity_alternatives(db_map_data)
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/single_parameter_models.py b/spinetoolbox/spine_db_editor/mvcmodels/single_parameter_models.py
deleted file mode 100644
index 1a4ce111d..000000000
--- a/spinetoolbox/spine_db_editor/mvcmodels/single_parameter_models.py
+++ /dev/null
@@ -1,523 +0,0 @@
-######################################################################################################################
-# Copyright (C) 2017-2022 Spine project consortium
-# This file is part of Spine Toolbox.
-# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
-# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
-# any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
-# without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
-# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
-# this program. If not, see .
-######################################################################################################################
-
-"""
-Single models for parameter definitions and values (as 'for a single entity').
-"""
-
-from PySide6.QtCore import Qt
-from spinetoolbox.helpers import DB_ITEM_SEPARATOR
-from ...mvcmodels.minimal_table_model import MinimalTableModel
-from ..mvcmodels.parameter_mixins import (
- FillInParameterNameMixin,
- FillInValueListIdMixin,
- MakeRelationshipOnTheFlyMixin,
- FillInAlternativeIdMixin,
- FillInParameterDefinitionIdsMixin,
- FillInEntityIdsMixin,
- ImposeEntityClassIdMixin,
-)
-from ...mvcmodels.shared import PARSED_ROLE, DB_MAP_ROLE
-from .colors import FIXED_FIELD_COLOR
-
-
-class HalfSortedTableModel(MinimalTableModel):
- def reset_model(self, main_data=None):
- """Reset model."""
- if main_data is None:
- main_data = list()
- self.beginResetModel()
- self._main_data = sorted(main_data, key=self._sort_key)
- self.endResetModel()
-
- def add_rows(self, data):
- data = [item for item in data if item not in self._main_data]
- if not data:
- return
- self.beginResetModel()
- self._main_data += data
- self._main_data.sort(key=self._sort_key)
- self.endResetModel()
-
- def _sort_key(self, element):
- return element
-
-
-class SingleParameterModel(HalfSortedTableModel):
- """A parameter model for a single entity_class to go in a CompoundParameterModel.
- Provides methods to associate the model to an entity_class as well as
- to filter entities within the class.
- """
-
- def __init__(self, header, db_mngr, db_map, entity_class_id, committed, lazy=False):
- """Init class.
-
- Args:
- header (list): list of field names for the header
- """
- super().__init__(header=header, lazy=lazy)
- self.db_mngr = db_mngr
- self.db_map = db_map
- self.entity_class_id = entity_class_id
- self._auto_filter = dict() # Maps field to accepted ids for that field
- self.committed = committed
-
- def __lt__(self, other):
- if self.entity_class_name == other.entity_class_name:
- return self.db_map.codename < other.db_map.codename
- return self.entity_class_name < other.entity_class_name
-
- @property
- def item_type(self):
- """The item type, either 'parameter_value' or 'parameter_definition', required by the data method."""
- raise NotImplementedError()
-
- @property
- def entity_class_type(self):
- """The entity_class type, either 'object_class' or 'relationship_class'."""
- raise NotImplementedError()
-
- @property
- def entity_class_name_field(self):
- return {"object_class": "object_class_name", "relationship_class": "relationship_class_name"}[
- self.entity_class_type
- ]
-
- @property
- def entity_class_name(self):
- return self.db_mngr.get_item(self.db_map, self.entity_class_type, self.entity_class_id)["name"]
-
- @property
- def entity_class_id_key(self):
- return {"object_class": "object_class_id", "relationship_class": "relationship_class_id"}[
- self.entity_class_type
- ]
-
- @property
- def value_field(self):
- return {"parameter_definition": "default_value", "parameter_value": "value"}[self.item_type]
-
- @property
- def fixed_fields(self):
- return {
- "object_class": ["object_class_name", "database"],
- "relationship_class": ["relationship_class_name", "object_class_name_list", "database"],
- }[self.entity_class_type]
-
- @property
- def group_fields(self):
- return {
- "object_class": {"parameter_definition": [], "parameter_value": []},
- "relationship_class": {
- "parameter_definition": ["object_class_name_list"],
- "parameter_value": ["object_name_list"],
- },
- }[self.entity_class_type][self.item_type]
-
- @property
- def parameter_definition_id_key(self):
- return {"parameter_definition": "id", "parameter_value": "parameter_id"}[self.item_type]
-
- @property
- def can_be_filtered(self):
- return True
-
- def item_id(self, row):
- """Returns parameter id for row.
-
- Args:
- row (int): row index
-
- Returns:
- int: parameter id
- """
- return self._main_data[row]
-
- def item_ids(self):
- """Returns model's parameter ids.
-
- Returns:
- set of int: ids
- """
- return set(self._main_data)
-
- def db_item(self, index):
- return self._db_item(index.row())
-
- def _db_item(self, row):
- id_ = self._main_data[row]
- return self.db_item_from_id(id_)
-
- def db_item_from_id(self, id_):
- return self.db_mngr.get_item(self.db_map, self.item_type, id_)
-
- def db_items(self):
- return [self._db_item(row) for row in range(self.rowCount())]
-
- def flags(self, index):
- """Make fixed indexes non-editable."""
- flags = super().flags(index)
- if self.header[index.column()] in self.fixed_fields:
- return flags & ~Qt.ItemIsEditable
- return flags
-
- def get_field_item_data(self, field):
- """Returns item data for given field.
-
- Args:
- field (str): A field from the header
-
- Returns:
- str, str
- """
- return {
- "object_class_name": ("object_class_id", "object_class"),
- "relationship_class_name": ("relationship_class_id", "relationship_class"),
- "object_class_name_list": ("relationship_class_id", "relationship_class"),
- "object_name": ("object_id", "object"),
- "object_name_list": ("relationship_id", "relationship"),
- "parameter_name": (self.parameter_definition_id_key, "parameter_definition"),
- "value_list_name": ("value_list_id", "parameter_value_list"),
- "description": ("id", "parameter_definition"),
- "value": ("id", "parameter_value"),
- "default_value": ("id", "parameter_definition"),
- "database": ("database", None),
- "alternative_id": ("alternative_id", "alternative"),
- }.get(field)
-
- def get_id_key(self, field):
- field_item_data = self.get_field_item_data(field)
- if field_item_data is None:
- return None
- return field_item_data[0]
-
- def get_field_item(self, field, db_item):
- """Returns a db item corresponding to the given field from the table header,
- or an empty dict if the field doesn't contain db items.
- """
- field_item_data = self.get_field_item_data(field)
- if field_item_data is None:
- return {}
- id_key, item_type = field_item_data
- item_id = db_item.get(id_key)
- return self.db_mngr.get_item(self.db_map, item_type, item_id)
-
- def data(self, index, role=Qt.ItemDataRole.DisplayRole):
- """Gets the id and database for the row, and reads data from the db manager
- using the item_type property.
- Paint the object_class icon next to the name.
- Also paint background of fixed indexes gray and apply custom format to JSON fields."""
- field = self.header[index.column()]
- # Background role
- if role == Qt.ItemDataRole.BackgroundRole and field in self.fixed_fields:
- return FIXED_FIELD_COLOR
- # Display, edit, tool tip, alignment role of 'json fields'
- if field == self.value_field and role in (
- Qt.ItemDataRole.DisplayRole,
- Qt.ItemDataRole.EditRole,
- Qt.ItemDataRole.ToolTipRole,
- Qt.TextAlignmentRole,
- PARSED_ROLE,
- ):
- id_ = self._main_data[index.row()]
- return self.db_mngr.get_value(self.db_map, self.item_type, id_, role)
- if role in (Qt.ItemDataRole.DisplayRole, Qt.ItemDataRole.EditRole, Qt.ItemDataRole.ToolTipRole):
- if field == "database":
- return self.db_map.codename
- id_ = self._main_data[index.row()]
- item = self.db_mngr.get_item(self.db_map, self.item_type, id_)
- if role == Qt.ItemDataRole.ToolTipRole:
- description = self.get_field_item(field, item).get("description", None)
- if description not in (None, ""):
- return description
- data = item.get(field)
- if data and field in self.group_fields:
- data = DB_ITEM_SEPARATOR.join(data)
- return data
- if role == Qt.ItemDataRole.DecorationRole and field == self.entity_class_name_field:
- return self.db_mngr.entity_class_icon(self.db_map, self.entity_class_type, self.entity_class_id)
- if role == DB_MAP_ROLE:
- return self.db_map
- return super().data(index, role)
-
- def batch_set_data(self, indexes, data):
- """Sets data for indexes in batch.
- Sets data directly in database using db mngr. If successful, updated data will be
- automatically seen by the data method.
- """
-
- def split_value(value, column):
- if self.header[column] in self.group_fields:
- return tuple(value.split(DB_ITEM_SEPARATOR))
- return value
-
- if not indexes or not data:
- return False
- row_data = dict()
- for index, value in zip(indexes, data):
- row_data.setdefault(index.row(), {})[self.header[index.column()]] = split_value(value, index.column())
- items = [dict(id=self._main_data[row], **data) for row, data in row_data.items()]
- self.update_items_in_db(items)
- return True
-
- def update_items_in_db(self, items):
- """Update items in db. Required by batch_set_data"""
- raise NotImplementedError()
-
- def _filter_accepts_row(self, row):
- item = self.db_mngr.get_item(self.db_map, self.item_type, self._main_data[row])
- return self.filter_accepts_item(item)
-
- def filter_accepts_item(self, item):
- return self._auto_filter_accepts_item(item)
-
- def set_auto_filter(self, field, values):
- if values == self._auto_filter.get(field, set()):
- return False
- self._auto_filter[field] = values
- return True
-
- def _auto_filter_accepts_item(self, item):
- """Returns the result of the auto filter."""
- if self._auto_filter is None:
- return False
- for field, values in self._auto_filter.items():
- if values and item.get(field) not in values:
- return False
- return True
-
- def accepted_rows(self):
- """Yields accepted rows, for convenience."""
- for row in range(self.rowCount()):
- if self._filter_accepts_row(row):
- yield row
-
- def _get_field_item(self, field, id_):
- """Returns a item from the db_mngr.get_item depending on the field.
- If a field doesn't correspond to a item in the database then an empty dict is returned.
- """
- header_to_id = {
- "object_class_name": ("entity_class_id", "object_class"),
- "relationship_class_name": ("entity_class_id", "relationship_class"),
- "object_name": ("entity_id", "object"),
- "object_name_list": ("entity_id", "relationship"),
- "parameter_name": (self.parameter_definition_id_key, "parameter_definition"),
- }
- id_field_item_type = header_to_id.get(field)
- if id_field_item_type is None:
- return {}
- id_field, item_type = id_field_item_type
- data = self.db_mngr.get_item(self.db_map, self.item_type, id_)
- item_id = data.get(id_field)
- return self.db_mngr.get_item(self.db_map, item_type, item_id)
-
-
-class SingleObjectParameterMixin:
- """Associates a parameter model with a single object_class."""
-
- @property
- def entity_class_type(self):
- return "object_class"
-
-
-class SingleRelationshipParameterMixin:
- """Associates a parameter model with a single relationship_class."""
-
- @property
- def entity_class_type(self):
- return "relationship_class"
-
-
-class SingleParameterDefinitionMixin(FillInParameterNameMixin, FillInValueListIdMixin):
- """A parameter_definition model for a single entity_class."""
-
- @property
- def item_type(self):
- return "parameter_definition"
-
- def _sort_key(self, element):
- item = self.db_item_from_id(element)
- return item["parameter_name"]
-
- def update_items_in_db(self, items):
- """Update items in db.
-
- Args:
- items (list): dictionary-items
- """
- self.build_lookup_dictionary({self.db_map: items})
- param_defs = list()
- error_log = list()
- for item in items:
- param_def, errors = self._convert_to_db(item, self.db_map)
- if tuple(param_def.keys()) != ("id",):
- param_defs.append(param_def)
- if errors:
- error_log += errors
- if param_defs:
- self.db_mngr.update_parameter_definitions({self.db_map: param_defs})
- if error_log:
- self.db_mngr.error_msg.emit({self.db_map: error_log})
-
-
-class SingleParameterValueMixin(
- FillInAlternativeIdMixin, ImposeEntityClassIdMixin, FillInParameterDefinitionIdsMixin, FillInEntityIdsMixin
-):
- """A parameter_value model for a single entity_class."""
-
- _filter_db_map_class_entity_ids = dict()
- _filter_alternative_ids = set()
- _filter_entity_ids = set()
-
- @property
- def item_type(self):
- return "parameter_value"
-
- @property
- def entity_type(self):
- """Either 'object' or "relationship'."""
- raise NotImplementedError()
-
- @property
- def entity_id_key(self):
- return {"object": "object_id", "relationship": "relationship_id"}[self.entity_type]
-
- @property
- def entity_name_key(self):
- return {"object": "object_name", "relationship": "object_name_list"}[self.entity_type]
-
- @property
- def entity_name_key_in_cache(self):
- return {"object": "name", "relationship": "object_name_list"}[self.entity_type]
-
- def _sort_key(self, element):
- item = self.db_item_from_id(element)
- return tuple(item[k] for k in (self.entity_name_key, "parameter_name", "alternative_name"))
-
- def set_filter_entity_ids(self, db_map_class_entity_ids):
- if self._filter_db_map_class_entity_ids == db_map_class_entity_ids:
- return False
- self._filter_db_map_class_entity_ids = db_map_class_entity_ids
- self._filter_entity_ids = db_map_class_entity_ids.get((self.db_map, self.entity_class_id), set())
- return True
-
- def set_filter_alternative_ids(self, db_map_alternative_ids):
- alternative_ids = db_map_alternative_ids.get(self.db_map, set())
- if self._filter_alternative_ids == alternative_ids:
- return False
- self._filter_alternative_ids = alternative_ids
- return True
-
- def filter_accepts_item(self, item):
- """Reimplemented to also account for the entity and alternative filter."""
- return (
- super().filter_accepts_item(item)
- and self._entity_filter_accepts_item(item)
- and self._alternative_filter_accepts_item(item)
- )
-
- def _entity_filter_accepts_item(self, item):
- """Returns the result of the entity filter."""
- object_class_id = item["object_class_id"]
- if not self._filter_db_map_class_entity_ids:
- return True
- try:
- active_class_ids = [i[1] for i in self._filter_db_map_class_entity_ids.keys()]
- except TypeError:
- active_class_ids = []
- if object_class_id and object_class_id not in active_class_ids:
- return True
- entity_id = item["entity_id"]
- return entity_id in self._filter_entity_ids
-
- def _alternative_filter_accepts_item(self, item):
- """Returns the result of the alternative filter."""
- if not self._filter_alternative_ids:
- return True
- alternative_id = item["alternative_id"]
- return alternative_id in self._filter_alternative_ids
-
- def update_items_in_db(self, items):
- """Update items in db.
-
- Args:
- items (list): dictionary-items
- """
- param_vals = list()
- error_log = list()
- db_map_data = dict()
- db_map_data[self.db_map] = items
- self.build_lookup_dictionary(db_map_data)
- for item in items:
- param_val, errors = self._convert_to_db(item, self.db_map)
- if tuple(param_val.keys()) != ("id",):
- param_vals.append(param_val)
- if errors:
- error_log += errors
- if param_vals:
- self.db_mngr.update_parameter_values({self.db_map: param_vals})
- if error_log:
- self.db_mngr.error_msg.emit({self.db_map: error_log})
-
-
-class SingleObjectParameterDefinitionModel(
- SingleObjectParameterMixin, SingleParameterDefinitionMixin, SingleParameterModel
-):
- """An object parameter_definition model for a single object_class."""
-
-
-class SingleRelationshipParameterDefinitionModel(
- SingleRelationshipParameterMixin, SingleParameterDefinitionMixin, SingleParameterModel
-):
- """A relationship parameter_definition model for a single relationship_class."""
-
-
-class SingleObjectParameterValueModel(SingleObjectParameterMixin, SingleParameterValueMixin, SingleParameterModel):
- """An object parameter_value model for a single object_class."""
-
- @property
- def entity_type(self):
- return "object"
-
-
-class SingleRelationshipParameterValueModel(
- SingleRelationshipParameterMixin, MakeRelationshipOnTheFlyMixin, SingleParameterValueMixin, SingleParameterModel
-):
- """A relationship parameter_value model for a single relationship_class."""
-
- @property
- def entity_type(self):
- return "relationship"
-
- def update_items_in_db(self, items):
- """Update items in db.
-
- Args:
- items (list): dictionary-items
- """
- for item in items:
- item["relationship_class_name"] = self.entity_class_name
- db_map_data = {self.db_map: items}
- self.build_lookup_dictionaries(db_map_data)
- db_map_relationships = dict()
- db_map_error_log = dict()
- for db_map, data in db_map_data.items():
- for item in data:
- relationship, err = self._make_relationship_on_the_fly(item, db_map)
- if relationship:
- db_map_relationships.setdefault(db_map, []).append(relationship)
- if err:
- db_map_error_log.setdefault(db_map, []).extend(err)
- if any(db_map_relationships.values()):
- self.db_mngr.add_relationships(db_map_relationships)
- if db_map_error_log:
- self.db_mngr.error_msg.emit(db_map_error_log)
- super().update_items_in_db(items)
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/tool_feature_item.py b/spinetoolbox/spine_db_editor/mvcmodels/tool_feature_item.py
deleted file mode 100644
index 1bdc8665f..000000000
--- a/spinetoolbox/spine_db_editor/mvcmodels/tool_feature_item.py
+++ /dev/null
@@ -1,369 +0,0 @@
-######################################################################################################################
-# Copyright (C) 2017-2022 Spine project consortium
-# This file is part of Spine Toolbox.
-# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
-# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
-# any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
-# without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
-# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
-# this program. If not, see .
-######################################################################################################################
-
-"""
-Classes to represent tool and feature items in a tree.
-"""
-from PySide6.QtCore import Qt
-from .tree_item_utility import GrayIfLastMixin, EditableMixin, EmptyChildRootItem, LeafItem, StandardTreeItem
-
-_FEATURE_ICON = "\uf5bc" # splotch
-_TOOL_ICON = "\uf6e3" # hammer
-_METHOD_ICON = "\uf1de" # sliders-h
-
-
-class FeatureRootItem(EmptyChildRootItem):
- """A feature root item."""
-
- @property
- def item_type(self):
- return "feature"
-
- @property
- def display_data(self):
- return "feature"
-
- @property
- def icon_code(self):
- return _FEATURE_ICON
-
- def empty_child(self):
- return FeatureLeafItem()
-
- def _make_child(self, id_):
- return FeatureLeafItem(id_)
-
-
-class ToolRootItem(EmptyChildRootItem):
- """A tool root item."""
-
- @property
- def item_type(self):
- return "tool"
-
- @property
- def display_data(self):
- return "tool"
-
- @property
- def icon_code(self):
- return _TOOL_ICON
-
- def empty_child(self):
- return ToolLeafItem()
-
- def _make_child(self, id_):
- return ToolLeafItem(id_)
-
-
-class FeatureLeafItem(GrayIfLastMixin, EditableMixin, LeafItem):
- """A feature leaf item."""
-
- @property
- def item_type(self):
- return "feature"
-
- def _make_item_data(self):
- return {"name": "Enter new feature here...", "description": ""}
-
- @property
- def item_data(self):
- if not self.id:
- return self._make_item_data()
- item_data = self.db_mngr.get_item(self.db_map, self.item_type, self.id)
- if not item_data:
- return {}
- item_data["name"] = self.model.make_feature_name(
- item_data["entity_class_name"], item_data["parameter_definition_name"]
- )
- return item_data
-
- @property
- def tool_tip(self):
- return "Drag this item and drop it onto a tool feature item below to create a tool feature
"
-
- def add_item_to_db(self, db_item):
- if db_item is None:
- return
- self.db_mngr.add_features({self.db_map: [db_item]})
-
- def update_item_in_db(self, db_item):
- if db_item is None:
- return
- self.db_mngr.update_features({self.db_map: [db_item]})
-
- def flags(self, column):
- return super().flags(column) | Qt.ItemIsDragEnabled
-
- def _make_item_to_add(self, value):
- ids = self._get_ids_from_feat_name(value)
- if not ids:
- return None
- parameter_definition_id, parameter_value_list_id = ids
- return dict(
- parameter_definition_id=parameter_definition_id,
- parameter_value_list_id=parameter_value_list_id,
- description=self.item_data["description"],
- )
-
- def _make_item_to_update(self, column, value):
- if column != 0:
- return super()._make_item_to_update(column, value)
- ids = self._get_ids_from_feat_name(value)
- if not ids:
- return None
- parameter_definition_id, parameter_value_list_id = ids
- return dict(
- id=self.id, parameter_definition_id=parameter_definition_id, parameter_value_list_id=parameter_value_list_id
- )
-
- def _get_ids_from_feat_name(self, feature_name):
- ids = self.model.get_feature_data(self.db_map, feature_name)
- if ids is None:
- self.model._parent.msg_error.emit(
- f"Invalid feature '{feature_name}'.
"
- "Please enter a valid combination of entity class/parameter definition.
"
- )
- return None
- return ids
-
-
-class ToolLeafItem(GrayIfLastMixin, EditableMixin, LeafItem):
- """A tool leaf item."""
-
- @property
- def item_type(self):
- return "tool"
-
- def add_item_to_db(self, db_item):
- self.db_mngr.add_tools({self.db_map: [db_item]})
-
- def update_item_in_db(self, db_item):
- self.db_mngr.update_tools({self.db_map: [db_item]})
-
- def _do_set_up(self):
- if not self.id:
- return
- super()._do_set_up()
- self.append_children([ToolFeatureRootItem()])
-
-
-class ToolFeatureRootItem(EmptyChildRootItem):
- """A tool_feature root item."""
-
- @property
- def item_type(self):
- return "tool_feature"
-
- @property
- def display_data(self):
- return "tool_feature"
-
- @property
- def tool_tip(self):
- return "Drag a feature item from above and drop it here to create a tool feature
"
-
- @property
- def icon_code(self):
- return _FEATURE_ICON
-
- @property
- def feature_id_list(self):
- return [child.id for child in self.children]
-
- def flags(self, column):
- return super().flags(column) | Qt.ItemIsDropEnabled
-
- def empty_child(self):
- return ToolFeatureLeafItem()
-
- def _make_child(self, id_):
- return ToolFeatureLeafItem(id_)
-
- def accepts_item(self, item, db_map):
- return item["tool_id"] == self.parent_item.id
-
-
-class ToolFeatureLeafItem(GrayIfLastMixin, LeafItem):
- """A tool feature leaf item."""
-
- @property
- def item_type(self):
- return "tool_feature"
-
- @property
- def item_data(self):
- if not self.id:
- return dict(name="Type tool feature name here...")
- item_data = self.db_mngr.get_item(self.db_map, self.item_type, self.id)
- if not item_data:
- return {}
- feature_data = self.db_mngr.get_item(self.db_map, "feature", item_data["feature_id"])
- item_data["name"] = self.model.make_feature_name(
- feature_data["entity_class_name"], feature_data["parameter_definition_name"]
- )
- return item_data
-
- def _do_set_up(self):
- if not self.id:
- return
- super()._do_set_up()
- self.append_children([ToolFeatureRequiredItem(), ToolFeatureMethodRootItem()])
-
- def _make_item_to_add(self, value):
- feature_id, parameter_value_list_id = value
- return {
- "tool_id": self.parent_item.parent_item.id,
- "feature_id": feature_id,
- "parameter_value_list_id": parameter_value_list_id,
- }
-
- def add_item_to_db(self, db_item):
- self.db_mngr.add_tool_features({self.db_map: [db_item]})
-
- def update_item_in_db(self, db_item):
- self.db_mngr.update_tool_features({self.db_map: [db_item]})
-
- def flags(self, column):
- flags = super().flags(column)
- if not self.id:
- flags |= Qt.ItemIsEditable
- return flags
-
-
-class ToolFeatureRequiredItem(StandardTreeItem):
- """A tool feature required item."""
-
- @property
- def item_type(self):
- return "tool_feature required"
-
- def flags(self, column):
- flags = super().flags(column)
- if column == 0:
- flags |= Qt.ItemIsEditable
- return flags
-
- def data(self, column, role=Qt.ItemDataRole.DisplayRole):
- if column == 0 and role in (Qt.ItemDataRole.DisplayRole, Qt.ItemDataRole.EditRole):
- if not self.parent_item.item_data:
- return None
- required = "yes" if self.parent_item.item_data["required"] else "no"
- return "required: " + required
- return super().data(column, role)
-
- def set_data(self, column, value, role=Qt.ItemDataRole.EditRole):
- if role == Qt.ItemDataRole.EditRole and column == 0:
- required = {"yes": True, "no": False}.get(value)
- if required is None:
- return False
- db_item = {"id": self.parent_item.id, "required": required}
- self.parent_item.update_item_in_db(db_item)
- return True
- return False
-
- def has_children(self):
- return False
-
-
-class ToolFeatureMethodRootItem(EmptyChildRootItem):
- """A tool_feature_method root item."""
-
- @property
- def item_type(self):
- return "tool_feature_method"
-
- @property
- def display_data(self):
- return "tool_feature_method"
-
- @property
- def icon_code(self):
- return _METHOD_ICON
-
- def empty_child(self):
- return ToolFeatureMethodLeafItem()
-
- def _make_child(self, id_):
- return ToolFeatureMethodLeafItem(id_)
-
- def accepts_item(self, item, db_map):
- return item["tool_feature_id"] == self.parent_item.id
-
-
-class ToolFeatureMethodLeafItem(GrayIfLastMixin, LeafItem):
- """A tool_feature_method leaf item."""
-
- @property
- def item_type(self):
- return "tool_feature_method"
-
- @property
- def tool_feature_item(self):
- return self.parent_item.parent_item
-
- @property
- def item_data(self):
- if not self.id:
- return self._make_item_data()
- item_data = self.db_mngr.get_item(self.db_map, self.item_type, self.id)
- if not item_data:
- return {}
- item_data["name"] = self.db_mngr.get_value_list_item(
- self.db_map, item_data["parameter_value_list_id"], item_data["method_index"]
- )
- return item_data
-
- def _make_item_data(self):
- return {"name": "Enter new method here...", "description": ""}
-
- def flags(self, column):
- flags = super().flags(column)
- if column == 0:
- flags |= Qt.ItemIsEditable
- return flags
-
- def _make_item_to_add(self, value):
- tool_feat_item = self.tool_feature_item
- tool_feature_id = tool_feat_item.id
- parameter_value_list_id = tool_feat_item.item_data["parameter_value_list_id"]
- method_index = self._get_method_index(parameter_value_list_id, value)
- if method_index is None:
- return None
- return dict(
- tool_feature_id=tool_feature_id, parameter_value_list_id=parameter_value_list_id, method_index=method_index
- )
-
- def _make_item_to_update(self, column, value):
- if column != 0:
- return super()._make_item_to_update(column, value)
- tool_feat_item = self.tool_feature_item
- parameter_value_list_id = tool_feat_item.item_data["parameter_value_list_id"]
- method_index = self._get_method_index(parameter_value_list_id, value)
- if method_index is None:
- return None
- return dict(id=self.id, method_index=method_index)
-
- def _get_method_index(self, parameter_value_list_id, method):
- method_index = self.model.get_method_index(self.tool_feature_item.db_map, parameter_value_list_id, method)
- if method_index is None:
- self.model._parent.msg_error.emit(
- f"Invalid method '{method}'.
"
- f"Please enter a valid method for feature '{self.tool_feature_item.name}'.
"
- )
- return None
- return method_index
-
- def add_item_to_db(self, db_item):
- self.db_mngr.add_tool_feature_methods({self.db_map: [db_item]})
-
- def update_item_in_db(self, db_item):
- self.db_mngr.update_tool_feature_methods({self.db_map: [db_item]})
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/tool_feature_model.py b/spinetoolbox/spine_db_editor/mvcmodels/tool_feature_model.py
deleted file mode 100644
index 632535801..000000000
--- a/spinetoolbox/spine_db_editor/mvcmodels/tool_feature_model.py
+++ /dev/null
@@ -1,156 +0,0 @@
-######################################################################################################################
-# Copyright (C) 2017-2022 Spine project consortium
-# This file is part of Spine Toolbox.
-# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
-# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
-# any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
-# without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
-# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
-# this program. If not, see .
-######################################################################################################################
-"""
-Models to represent tools and features in a tree.
-"""
-import json
-from PySide6.QtCore import QMimeData, Qt
-from .tree_model_base import TreeModelBase
-from .tree_item_utility import StandardDBItem
-from .tool_feature_item import FeatureRootItem, ToolRootItem
-
-
-class ToolFeatureModel(TreeModelBase):
- """A model to display tools and features in a tree view.
-
-
- Args:
- parent (SpineDBEditor)
- db_mngr (SpineDBManager)
- db_maps (iter): DiffDatabaseMapping instances
- """
-
- def __init__(self, parent, db_mngr, *db_maps):
- """Initialize class"""
- super().__init__(parent, db_mngr, *db_maps)
- self._db_map_feature_data = {}
- self._db_map_feature_methods = {}
-
- @staticmethod
- def _make_db_item(db_map):
- return StandardDBItem(db_map)
-
- @staticmethod
- def _top_children():
- return [FeatureRootItem(), ToolRootItem()]
-
- @staticmethod
- def make_feature_name(entity_class_name, parameter_definition_name):
- if entity_class_name is None:
- entity_class_name = ""
- if parameter_definition_name is None:
- parameter_definition_name = ""
- return entity_class_name + "/" + parameter_definition_name
-
- def _begin_set_features(self, db_map):
- parameter_definitions = self.db_mngr.get_items(db_map, "parameter_definition", only_visible=False)
- key = lambda x: self.make_feature_name(
- x.get("object_class_name") or x.get("relationship_class_name"), x["parameter_name"]
- )
- self._db_map_feature_data[db_map] = {
- key(x): (x["id"], x["value_list_id"]) for x in parameter_definitions if x["value_list_id"]
- }
-
- def get_all_feature_names(self, db_map):
- self._begin_set_features(db_map)
- return list(self._db_map_feature_data.get(db_map, {}).keys())
-
- def get_feature_data(self, db_map, feature_name):
- return self._db_map_feature_data.get(db_map, {}).get(feature_name)
-
- def _begin_set_feature_method(self, db_map, parameter_value_list_id):
- parameter_value_list = self.db_mngr.get_item(
- db_map, "parameter_value_list", parameter_value_list_id, only_visible=False
- )
- value_index_list = parameter_value_list["value_index_list"]
- display_value_list = self.db_mngr.get_parameter_value_list(
- db_map, parameter_value_list_id, role=Qt.ItemDataRole.DisplayRole, only_visible=False
- )
- self._db_map_feature_methods.setdefault(db_map, {})[parameter_value_list_id] = dict(
- zip(display_value_list, value_index_list)
- )
-
- def get_all_feature_methods(self, db_map, parameter_value_list_id):
- self._begin_set_feature_method(db_map, parameter_value_list_id)
- return list(self._db_map_feature_methods.get(db_map, {}).get(parameter_value_list_id, {}).keys())
-
- def get_method_index(self, db_map, parameter_value_list_id, method):
- return self._db_map_feature_methods.get(db_map, {}).get(parameter_value_list_id, {}).get(method)
-
- def supportedDropActions(self):
- return Qt.CopyAction | Qt.MoveAction
-
- def mimeData(self, indexes):
- """
- Builds a dict mapping db name to item type to a list of ids.
-
- Returns:
- QMimeData
- """
- items = {self.item_from_index(ind): None for ind in indexes} # NOTE: this avoids dupes and keeps order
- d = {}
- for item in items:
- parent_item = item.parent_item
- db_row = self.db_row(parent_item)
- parent_type = parent_item.item_type
- master_key = ";;".join([str(db_row), parent_type])
- d.setdefault(master_key, []).append(item.child_number())
- data = json.dumps(d)
- mime = QMimeData()
- mime.setText(data)
- return mime
-
- def canDropMimeData(self, data, drop_action, row, column, parent):
- if not parent.isValid():
- return False
- if not data.hasText():
- return False
- try:
- data = json.loads(data.text())
- except ValueError:
- return False
- if not isinstance(data, dict):
- return False
- # Check that all source data comes from the same db and parent
- if len(data) != 1:
- return False
- master_key = next(iter(data))
- db_row, parent_type = master_key.split(";;")
- db_row = int(db_row)
- if parent_type != "feature":
- return False
- # Check that target is in the same db as source
- tool_item = self.item_from_index(parent)
- if db_row != self.db_row(tool_item):
- return False
- return True
-
- def dropMimeData(self, data, drop_action, row, column, parent):
- tool_feat_root_item = self.item_from_index(parent)
- master_key, feature_rows = json.loads(data.text()).popitem()
- db_row, _parent_type = master_key.split(";;")
- db_row = int(db_row)
- feat_root_item = self._invisible_root_item.child(db_row).child(0)
- db_items = []
- for feat_row in feature_rows:
- item = feat_root_item.child(feat_row)
- feature_id = item.id
- if feature_id in tool_feat_root_item.feature_id_list:
- continue
- parameter_value_list_id = item.item_data.get("parameter_value_list_id")
- db_item = {
- "tool_id": tool_feat_root_item.parent_item.id,
- "feature_id": feature_id,
- "parameter_value_list_id": parameter_value_list_id,
- }
- db_items.append(db_item)
- self.db_mngr.add_tool_features({tool_feat_root_item.db_map: db_items})
- return True
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/tree_item_utility.py b/spinetoolbox/spine_db_editor/mvcmodels/tree_item_utility.py
index df4d0ba8d..942e46ea7 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/tree_item_utility.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/tree_item_utility.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,14 +10,11 @@
# this program. If not, see .
######################################################################################################################
-"""
-A tree model for parameter_value lists.
-"""
-
+"""A tree model for parameter_value lists."""
from PySide6.QtCore import Qt
from PySide6.QtGui import QBrush, QFont, QIcon, QGuiApplication
from spinetoolbox.mvcmodels.minimal_tree_model import TreeItem
-from spinetoolbox.helpers import CharIconEngine, bisect_chunks
+from spinetoolbox.helpers import CharIconEngine, bisect_chunks, plain_to_tool_tip
from spinetoolbox.fetch_parent import FlexibleFetchParent
@@ -39,8 +37,7 @@ def display_data(self):
def icon_code(self):
return None
- @property
- def tool_tip(self):
+ def tool_tip(self, column):
return None
@property
@@ -51,15 +48,15 @@ def display_icon(self):
return QIcon(engine.pixmap())
def data(self, column, role=Qt.ItemDataRole.DisplayRole):
+ if role == Qt.ItemDataRole.ToolTipRole:
+ return self.tool_tip(column)
if column != 0:
return None
if role in (Qt.ItemDataRole.DisplayRole, Qt.ItemDataRole.EditRole):
return self.display_data
if role == Qt.ItemDataRole.DecorationRole:
return self.display_icon
- if role == Qt.ItemDataRole.ToolTipRole:
- return self.tool_tip
- return super().data(column, role)
+ return super().data(0, role)
def set_data(self, column, value, role=Qt.ItemDataRole.DisplayRole):
return False
@@ -87,7 +84,7 @@ class GrayIfLastMixin:
"""Paints the item gray if it's the last."""
def data(self, column, role=Qt.ItemDataRole.DisplayRole):
- if role == Qt.ForegroundRole and self.child_number() == self.parent_item.child_count() - 1:
+ if role == Qt.ForegroundRole and self.child_number() == self.parent_item.row_count() - 1:
gray_color = QGuiApplication.palette().text().color()
gray_color.setAlpha(128)
gray_brush = QBrush(gray_color)
@@ -134,15 +131,6 @@ def insert_children_sorted(self, children):
return False
return True
- def _resort(self):
- # FIXME MM Needed?
- non_empty_children, empty_child = self.children[:-1], self.children[-1]
- non_empty_children.sort(key=self._children_sort_key)
- self.children = non_empty_children + [empty_child]
- top = self.model.index_from_item(self.child(0))
- bottom = self.model.index_from_item(self.child(-1))
- self.model.dataChanged.emit(top, bottom)
-
class FetchMoreMixin:
def __init__(self, *args, **kwargs):
@@ -158,6 +146,7 @@ def __init__(self, *args, **kwargs):
def tear_down(self):
super().tear_down()
self._natural_fetch_parent.set_obsolete(True)
+ self._natural_fetch_parent.deleteLater()
@property
def fetch_item_type(self):
@@ -179,6 +168,12 @@ def fetch_more(self):
def _make_child(self, id_):
raise NotImplementedError()
+ def _do_make_child(self, id_):
+ child = self._created_children.get(id_)
+ if child is None:
+ child = self._created_children[id_] = self._make_child(id_)
+ return child
+
def accepts_item(self, item, db_map):
return True
@@ -197,8 +192,8 @@ def handle_items_added(self, db_map_data):
continue
ids = ids_committed if item.get("commit_id") is not None else ids_uncommitted
ids.append(item["id"])
- children_committed = [self._make_child(id_) for id_ in ids_committed]
- children_uncommitted = [self._make_child(id_) for id_ in ids_uncommitted]
+ children_committed = [self._do_make_child(id_) for id_ in ids_committed]
+ children_uncommitted = [self._do_make_child(id_) for id_ in ids_uncommitted]
self.insert_children_sorted(children_committed)
self.insert_children(len(self.non_empty_children), children_uncommitted)
@@ -221,21 +216,21 @@ def handle_items_updated(self, db_map_data):
self.model.dataChanged.emit(index, index)
if leaf_item.children:
top_left = self.model.index_from_item(leaf_item.child(0))
- bottom_right = self.model.index_from_item(leaf_item.child(-1))
+ bottom_right = self.model.index_from_item(leaf_item.child(leaf_item.child_count() - 1))
self.model.dataChanged.emit(top_left, bottom_right)
class StandardDBItem(SortChildrenMixin, StandardTreeItem):
"""An item representing a db."""
- def __init__(self, db_map):
+ def __init__(self, model, db_map):
"""Init class.
- Args
- db_mngr (SpineDBManager)
- db_map (DiffDatabaseMapping)
+ Args:
+ model (MinimalTreeModel)
+ db_map (DatabaseMapping)
"""
- super().__init__()
+ super().__init__(model)
self.db_map = db_map
@property
@@ -252,30 +247,14 @@ def data(self, column, role=Qt.ItemDataRole.DisplayRole):
return self.db_map.codename
-class RootItem(SortChildrenMixin, BoldTextMixin, FetchMoreMixin, StandardTreeItem):
- """A root item."""
-
- @property
- def item_type(self):
- raise NotImplementedError
-
- @property
- def db_map(self):
- return self.parent_item.db_map
-
-
-class EmptyChildRootItem(EmptyChildMixin, RootItem):
- def empty_child(self):
- raise NotImplementedError
-
-
class LeafItem(StandardTreeItem):
- def __init__(self, identifier=None):
+ def __init__(self, model, identifier=None):
"""
Args:
+ model (MinimalTreeModel)
identifier (int, optional): item's database id
"""
- super().__init__()
+ super().__init__(model)
self._id = identifier
def _make_item_data(self):
@@ -303,6 +282,11 @@ def item_data(self):
def name(self):
return self.item_data["name"]
+ def tool_tip(self, column):
+ if column != 0 and (header_data := self.header_data(column)) == "description":
+ return plain_to_tool_tip(self.item_data.get(header_data))
+ return super().tool_tip(column)
+
def add_item_to_db(self, db_item):
raise NotImplementedError()
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/tree_model_base.py b/spinetoolbox/spine_db_editor/mvcmodels/tree_model_base.py
index a3b912315..7b8f0da6b 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/tree_model_base.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/tree_model_base.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -8,10 +9,9 @@
# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
# this program. If not, see .
######################################################################################################################
-"""
-Models to represent things in a tree.
-"""
-from PySide6.QtCore import Qt, QModelIndex
+
+"""Models to represent things in a tree."""
+from PySide6.QtCore import QObject, Qt, QModelIndex, Slot
from spinetoolbox.mvcmodels.minimal_tree_model import MinimalTreeModel
from .tree_item_utility import StandardTreeItem
@@ -24,12 +24,13 @@ def __init__(self, db_editor, db_mngr, *db_maps):
Args:
db_editor (SpineDBEditor)
db_mngr (SpineDBManager)
- *db_maps: DiffDatabaseMapping instances
+ *db_maps: DatabaseMapping instances
"""
super().__init__(db_editor)
self.db_editor = db_editor
self.db_mngr = db_mngr
self.db_maps = db_maps
+ self.destroyed.connect(self._tear_down_tree)
def columnCount(self, parent=QModelIndex()):
"""Returns the number of columns under the given parent. Always 2.
@@ -47,19 +48,14 @@ def headerData(self, section, orientation, role=Qt.ItemDataRole.DisplayRole):
def build_tree(self):
"""Builds tree."""
self.beginResetModel()
+ self._invisible_root_item.tear_down_recursively()
self._invisible_root_item = StandardTreeItem(self)
self.endResetModel()
for db_map in self.db_maps:
db_item = self._make_db_item(db_map)
self._invisible_root_item.append_children([db_item])
- db_item.append_children(self._top_children())
-
- @staticmethod
- def _make_db_item(db_map):
- raise NotImplementedError()
- @staticmethod
- def _top_children():
+ def _make_db_item(self, db_map):
raise NotImplementedError()
@staticmethod
@@ -70,3 +66,8 @@ def db_item(item):
def db_row(self, item):
return self.db_item(item).child_number()
+
+ @Slot(QObject)
+ def _tear_down_tree(self, obj=None):
+ """Tears down tree items recursively"""
+ self._invisible_root_item.tear_down_recursively()
diff --git a/spinetoolbox/spine_db_editor/mvcmodels/utils.py b/spinetoolbox/spine_db_editor/mvcmodels/utils.py
index eab5e5985..4189bfa36 100644
--- a/spinetoolbox/spine_db_editor/mvcmodels/utils.py
+++ b/spinetoolbox/spine_db_editor/mvcmodels/utils.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -8,6 +9,7 @@
# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
# this program. If not, see .
######################################################################################################################
+
"""General helper functions and classes for DB editor's models."""
import csv
from io import StringIO
diff --git a/spinetoolbox/spine_db_editor/scenario_generation.py b/spinetoolbox/spine_db_editor/scenario_generation.py
index f9fb8a262..1b6ca8920 100644
--- a/spinetoolbox/spine_db_editor/scenario_generation.py
+++ b/spinetoolbox/spine_db_editor/scenario_generation.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -9,9 +10,7 @@
# this program. If not, see .
######################################################################################################################
-"""
-Contains functions for automatically generating scenarios from a set of alternatives.
-"""
+"""Contains functions for automatically generating scenarios from a set of alternatives."""
from itertools import compress, permutations
diff --git a/spinetoolbox/spine_db_editor/ui/__init__.py b/spinetoolbox/spine_db_editor/ui/__init__.py
index 5aad8885c..7bf75cecf 100644
--- a/spinetoolbox/spine_db_editor/ui/__init__.py
+++ b/spinetoolbox/spine_db_editor/ui/__init__.py
@@ -1,5 +1,6 @@
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
diff --git a/spinetoolbox/spine_db_editor/ui/commit_viewer_affected_item_info.py b/spinetoolbox/spine_db_editor/ui/commit_viewer_affected_item_info.py
new file mode 100644
index 000000000..cd6b79a97
--- /dev/null
+++ b/spinetoolbox/spine_db_editor/ui/commit_viewer_affected_item_info.py
@@ -0,0 +1,60 @@
+# -*- coding: utf-8 -*-
+######################################################################################################################
+# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
+# This file is part of Spine Toolbox.
+# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
+# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
+# any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+# without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
+# this program. If not, see .
+######################################################################################################################
+
+################################################################################
+## Form generated from reading UI file 'commit_viewer_affected_item_info.ui'
+##
+## Created by: Qt User Interface Compiler version 6.5.2
+##
+## WARNING! All changes made in this file will be lost when recompiling UI file!
+################################################################################
+
+from PySide6.QtCore import (QCoreApplication, QDate, QDateTime, QLocale,
+ QMetaObject, QObject, QPoint, QRect,
+ QSize, QTime, QUrl, Qt)
+from PySide6.QtGui import (QBrush, QColor, QConicalGradient, QCursor,
+ QFont, QFontDatabase, QGradient, QIcon,
+ QImage, QKeySequence, QLinearGradient, QPainter,
+ QPalette, QPixmap, QRadialGradient, QTransform)
+from PySide6.QtWidgets import (QApplication, QHeaderView, QLabel, QSizePolicy,
+ QTableWidget, QTableWidgetItem, QVBoxLayout, QWidget)
+
+class Ui_Form(object):
+ def setupUi(self, Form):
+ if not Form.objectName():
+ Form.setObjectName(u"Form")
+ Form.resize(400, 300)
+ self.verticalLayout = QVBoxLayout(Form)
+ self.verticalLayout.setObjectName(u"verticalLayout")
+ self.verticalLayout.setContentsMargins(0, 0, 0, 0)
+ self.affected_items_table = QTableWidget(Form)
+ self.affected_items_table.setObjectName(u"affected_items_table")
+
+ self.verticalLayout.addWidget(self.affected_items_table)
+
+ self.fetch_status_label = QLabel(Form)
+ self.fetch_status_label.setObjectName(u"fetch_status_label")
+
+ self.verticalLayout.addWidget(self.fetch_status_label)
+
+
+ self.retranslateUi(Form)
+
+ QMetaObject.connectSlotsByName(Form)
+ # setupUi
+
+ def retranslateUi(self, Form):
+ Form.setWindowTitle(QCoreApplication.translate("Form", u"Form", None))
+ self.fetch_status_label.setText(QCoreApplication.translate("Form", u"TextLabel", None))
+ # retranslateUi
+
diff --git a/spinetoolbox/spine_db_editor/ui/commit_viewer_affected_item_info.ui b/spinetoolbox/spine_db_editor/ui/commit_viewer_affected_item_info.ui
new file mode 100644
index 000000000..fe6cbacdc
--- /dev/null
+++ b/spinetoolbox/spine_db_editor/ui/commit_viewer_affected_item_info.ui
@@ -0,0 +1,56 @@
+
+
+
+ Form
+
+
+
+ 0
+ 0
+ 400
+ 300
+
+
+
+ Form
+
+
+
+ 0
+
+
+ 0
+
+
+ 0
+
+
+ 0
+
+ -
+
+
+ -
+
+
+ TextLabel
+
+
+
+
+
+
+
+
diff --git a/spinetoolbox/spine_db_editor/ui/db_commit_viewer.py b/spinetoolbox/spine_db_editor/ui/db_commit_viewer.py
new file mode 100644
index 000000000..e3bdbbe7d
--- /dev/null
+++ b/spinetoolbox/spine_db_editor/ui/db_commit_viewer.py
@@ -0,0 +1,154 @@
+# -*- coding: utf-8 -*-
+######################################################################################################################
+# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
+# This file is part of Spine Toolbox.
+# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
+# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
+# any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+# without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
+# this program. If not, see .
+######################################################################################################################
+
+################################################################################
+## Form generated from reading UI file 'db_commit_viewer.ui'
+##
+## Created by: Qt User Interface Compiler version 6.5.2
+##
+## WARNING! All changes made in this file will be lost when recompiling UI file!
+################################################################################
+
+from PySide6.QtCore import (QCoreApplication, QDate, QDateTime, QLocale,
+ QMetaObject, QObject, QPoint, QRect,
+ QSize, QTime, QUrl, Qt)
+from PySide6.QtGui import (QBrush, QColor, QConicalGradient, QCursor,
+ QFont, QFontDatabase, QGradient, QIcon,
+ QImage, QKeySequence, QLinearGradient, QPainter,
+ QPalette, QPixmap, QRadialGradient, QTransform)
+from PySide6.QtWidgets import (QApplication, QFrame, QHBoxLayout, QHeaderView,
+ QLabel, QSizePolicy, QSplitter, QStackedWidget,
+ QTabWidget, QTextBrowser, QTreeWidget, QTreeWidgetItem,
+ QVBoxLayout, QWidget)
+
+class Ui_DBCommitViewer(object):
+ def setupUi(self, DBCommitViewer):
+ if not DBCommitViewer.objectName():
+ DBCommitViewer.setObjectName(u"DBCommitViewer")
+ DBCommitViewer.resize(716, 218)
+ self.horizontalLayout_2 = QHBoxLayout(DBCommitViewer)
+ self.horizontalLayout_2.setObjectName(u"horizontalLayout_2")
+ self.splitter = QSplitter(DBCommitViewer)
+ self.splitter.setObjectName(u"splitter")
+ self.splitter.setOrientation(Qt.Horizontal)
+ self.commit_list = QTreeWidget(self.splitter)
+ __qtreewidgetitem = QTreeWidgetItem()
+ __qtreewidgetitem.setText(0, u"1");
+ self.commit_list.setHeaderItem(__qtreewidgetitem)
+ self.commit_list.setObjectName(u"commit_list")
+ self.splitter.addWidget(self.commit_list)
+ self.verticalFrame = QFrame(self.splitter)
+ self.verticalFrame.setObjectName(u"verticalFrame")
+ self.verticalFrame.setStyleSheet(u"QFrame {\n"
+" background-color: white;\n"
+"}")
+ self.verticalFrame.setFrameShape(QFrame.Box)
+ self.verticalLayout = QVBoxLayout(self.verticalFrame)
+ self.verticalLayout.setSpacing(3)
+ self.verticalLayout.setObjectName(u"verticalLayout")
+ self.verticalLayout.setContentsMargins(5, 5, 5, 0)
+ self.label = QLabel(self.verticalFrame)
+ self.label.setObjectName(u"label")
+
+ self.verticalLayout.addWidget(self.label)
+
+ self.affected_items_widget_stack = QStackedWidget(self.verticalFrame)
+ self.affected_items_widget_stack.setObjectName(u"affected_items_widget_stack")
+ self.items_page = QWidget()
+ self.items_page.setObjectName(u"items_page")
+ self.horizontalLayout_3 = QHBoxLayout(self.items_page)
+ self.horizontalLayout_3.setSpacing(0)
+ self.horizontalLayout_3.setObjectName(u"horizontalLayout_3")
+ self.horizontalLayout_3.setContentsMargins(0, 0, 0, 0)
+ self.affected_item_tab_widget = QTabWidget(self.items_page)
+ self.affected_item_tab_widget.setObjectName(u"affected_item_tab_widget")
+ self.affected_item_tab_widget.setDocumentMode(True)
+
+ self.horizontalLayout_3.addWidget(self.affected_item_tab_widget)
+
+ self.affected_items_widget_stack.addWidget(self.items_page)
+ self.no_items_page = QWidget()
+ self.no_items_page.setObjectName(u"no_items_page")
+ self.horizontalLayout = QHBoxLayout(self.no_items_page)
+ self.horizontalLayout.setSpacing(0)
+ self.horizontalLayout.setObjectName(u"horizontalLayout")
+ self.horizontalLayout.setContentsMargins(0, 0, 0, 0)
+ self.no_affected_items_notice = QTextBrowser(self.no_items_page)
+ self.no_affected_items_notice.setObjectName(u"no_affected_items_notice")
+ self.no_affected_items_notice.setFocusPolicy(Qt.NoFocus)
+ self.no_affected_items_notice.setVerticalScrollBarPolicy(Qt.ScrollBarAlwaysOff)
+ self.no_affected_items_notice.setHorizontalScrollBarPolicy(Qt.ScrollBarAlwaysOff)
+ self.no_affected_items_notice.setOpenLinks(False)
+
+ self.horizontalLayout.addWidget(self.no_affected_items_notice)
+
+ self.affected_items_widget_stack.addWidget(self.no_items_page)
+ self.loading_page = QWidget()
+ self.loading_page.setObjectName(u"loading_page")
+ self.horizontalLayout_4 = QHBoxLayout(self.loading_page)
+ self.horizontalLayout_4.setSpacing(0)
+ self.horizontalLayout_4.setObjectName(u"horizontalLayout_4")
+ self.horizontalLayout_4.setContentsMargins(0, 0, 0, 0)
+ self.loading_label = QLabel(self.loading_page)
+ self.loading_label.setObjectName(u"loading_label")
+ self.loading_label.setAlignment(Qt.AlignLeading|Qt.AlignLeft|Qt.AlignTop)
+
+ self.horizontalLayout_4.addWidget(self.loading_label)
+
+ self.affected_items_widget_stack.addWidget(self.loading_page)
+ self.no_commit_selected_page = QWidget()
+ self.no_commit_selected_page.setObjectName(u"no_commit_selected_page")
+ self.verticalLayout_2 = QVBoxLayout(self.no_commit_selected_page)
+ self.verticalLayout_2.setSpacing(0)
+ self.verticalLayout_2.setObjectName(u"verticalLayout_2")
+ self.verticalLayout_2.setContentsMargins(0, 0, 0, 0)
+ self.label_2 = QLabel(self.no_commit_selected_page)
+ self.label_2.setObjectName(u"label_2")
+ self.label_2.setAlignment(Qt.AlignLeading|Qt.AlignLeft|Qt.AlignTop)
+
+ self.verticalLayout_2.addWidget(self.label_2)
+
+ self.affected_items_widget_stack.addWidget(self.no_commit_selected_page)
+
+ self.verticalLayout.addWidget(self.affected_items_widget_stack)
+
+ self.splitter.addWidget(self.verticalFrame)
+
+ self.horizontalLayout_2.addWidget(self.splitter)
+
+
+ self.retranslateUi(DBCommitViewer)
+
+ self.affected_items_widget_stack.setCurrentIndex(3)
+ self.affected_item_tab_widget.setCurrentIndex(-1)
+
+
+ QMetaObject.connectSlotsByName(DBCommitViewer)
+ # setupUi
+
+ def retranslateUi(self, DBCommitViewer):
+ self.label.setText(QCoreApplication.translate("DBCommitViewer", u"Affected items", None))
+ self.no_affected_items_notice.setHtml(QCoreApplication.translate("DBCommitViewer", u"\n"
+"\n"
+"No affected items found for selected commit.
\n"
+"Note, that it is not possible to show items that have been removed by this or a later commit.
", None))
+ self.loading_label.setText(QCoreApplication.translate("DBCommitViewer", u"Loading...", None))
+ self.label_2.setText(QCoreApplication.translate("DBCommitViewer", u"Select a commit from the list on the left.", None))
+ pass
+ # retranslateUi
+
diff --git a/spinetoolbox/spine_db_editor/ui/db_commit_viewer.ui b/spinetoolbox/spine_db_editor/ui/db_commit_viewer.ui
new file mode 100644
index 000000000..e752a981d
--- /dev/null
+++ b/spinetoolbox/spine_db_editor/ui/db_commit_viewer.ui
@@ -0,0 +1,219 @@
+
+
+
+ DBCommitViewer
+
+
+
+ 0
+ 0
+ 716
+ 218
+
+
+
+ -
+
+
+ Qt::Horizontal
+
+
+
+
+ 1
+
+
+
+
+
+ QFrame {
+ background-color: white;
+}
+
+
+ QFrame::Box
+
+
+
+ 3
+
+
+ 5
+
+
+ 5
+
+
+ 5
+
+
+ 0
+
+
-
+
+
+ Affected items
+
+
+
+ -
+
+
+ 3
+
+
+
+
+ 0
+
+
+ 0
+
+
+ 0
+
+
+ 0
+
+
+ 0
+
+
-
+
+
+ -1
+
+
+ true
+
+
+
+
+
+
+
+
+ 0
+
+
+ 0
+
+
+ 0
+
+
+ 0
+
+
+ 0
+
+ -
+
+
+ Qt::NoFocus
+
+
+ Qt::ScrollBarAlwaysOff
+
+
+ Qt::ScrollBarAlwaysOff
+
+
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
+<html><head><meta name="qrichtext" content="1" /><meta charset="utf-8" /><style type="text/css">
+p, li { white-space: pre-wrap; }
+hr { height: 1px; border-width: 0; }
+li.unchecked::marker { content: "\2610"; }
+li.checked::marker { content: "\2612"; }
+</style></head><body style=" font-family:'Segoe UI'; font-size:9pt; font-weight:400; font-style:normal;">
+<p style=" margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">No affected items found for selected commit.</p>
+<p style=" margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">Note, that it is not possible to show items that have been removed by this or a later commit.</p></body></html>
+
+
+ false
+
+
+
+
+
+
+
+
+ 0
+
+
+ 0
+
+
+ 0
+
+
+ 0
+
+
+ 0
+
+ -
+
+
+ Loading...
+
+
+ Qt::AlignLeading|Qt::AlignLeft|Qt::AlignTop
+
+
+
+
+
+
+
+
+ 0
+
+
+ 0
+
+
+ 0
+
+
+ 0
+
+
+ 0
+
+ -
+
+
+ Select a commit from the list on the left.
+
+
+ Qt::AlignLeading|Qt::AlignLeft|Qt::AlignTop
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/spinetoolbox/spine_db_editor/ui/scenario_generator.py b/spinetoolbox/spine_db_editor/ui/scenario_generator.py
index 9cd058328..44c1038b4 100644
--- a/spinetoolbox/spine_db_editor/ui/scenario_generator.py
+++ b/spinetoolbox/spine_db_editor/ui/scenario_generator.py
@@ -1,6 +1,7 @@
# -*- coding: utf-8 -*-
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
diff --git a/spinetoolbox/spine_db_editor/ui/select_databases.py b/spinetoolbox/spine_db_editor/ui/select_databases.py
index 620e09c29..e7aae00ab 100644
--- a/spinetoolbox/spine_db_editor/ui/select_databases.py
+++ b/spinetoolbox/spine_db_editor/ui/select_databases.py
@@ -1,6 +1,7 @@
# -*- coding: utf-8 -*-
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
diff --git a/spinetoolbox/spine_db_editor/ui/spine_db_editor_window.py b/spinetoolbox/spine_db_editor/ui/spine_db_editor_window.py
index 15214479e..0ecba52f4 100644
--- a/spinetoolbox/spine_db_editor/ui/spine_db_editor_window.py
+++ b/spinetoolbox/spine_db_editor/ui/spine_db_editor_window.py
@@ -1,6 +1,7 @@
# -*- coding: utf-8 -*-
######################################################################################################################
# Copyright (C) 2017-2022 Spine project consortium
+# Copyright Spine Toolbox contributors
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
@@ -31,10 +32,10 @@
QSizePolicy, QSpacerItem, QVBoxLayout, QWidget)
from spinetoolbox.spine_db_editor.widgets.custom_qgraphicsviews import EntityQGraphicsView
-from spinetoolbox.spine_db_editor.widgets.custom_qtableview import (FrozenTableView, ItemMetadataTableView, MetadataTableView, ObjectParameterDefinitionTableView,
- ObjectParameterValueTableView, PivotTableView, RelationshipParameterDefinitionTableView, RelationshipParameterValueTableView)
-from spinetoolbox.spine_db_editor.widgets.custom_qtreeview import (AlternativeTreeView, ObjectTreeView, ParameterValueListTreeView, RelationshipTreeView,
- ScenarioTreeView, ToolFeatureTreeView)
+from spinetoolbox.spine_db_editor.widgets.custom_qtableview import (EntityAlternativeTableView, FrozenTableView, ItemMetadataTableView, MetadataTableView,
+ ParameterDefinitionTableView, ParameterValueTableView, PivotTableView)
+from spinetoolbox.spine_db_editor.widgets.custom_qtreeview import (AlternativeTreeView, EntityTreeView, ParameterValueListTreeView, ScenarioTreeView)
+from spinetoolbox.spine_db_editor.widgets.custom_qwidgets import (LegendWidget, ProgressBarWidget, TimeLineWidget)
from spinetoolbox import resources_icons_rc
class Ui_MainWindow(object):
@@ -108,7 +109,7 @@ def setupUi(self, MainWindow):
self.actionMass_remove_items.setObjectName(u"actionMass_remove_items")
self.actionMass_remove_items.setEnabled(False)
icon10 = QIcon()
- icon10.addFile(u":/icons/menu_icons/cube_minus.svg", QSize(), QIcon.Normal, QIcon.Off)
+ icon10.addFile(u":/icons/menu_icons/bolt-lightning.svg", QSize(), QIcon.Normal, QIcon.Off)
self.actionMass_remove_items.setIcon(icon10)
self.actionExport_session = QAction(MainWindow)
self.actionExport_session.setObjectName(u"actionExport_session")
@@ -177,7 +178,7 @@ def setupUi(self, MainWindow):
self.alternative_tree_view.setDragEnabled(True)
self.alternative_tree_view.setDragDropMode(QAbstractItemView.DragOnly)
self.alternative_tree_view.setSelectionMode(QAbstractItemView.ExtendedSelection)
- self.alternative_tree_view.setUniformRowHeights(True)
+ self.alternative_tree_view.setUniformRowHeights(False)
self.verticalLayout_18.addWidget(self.alternative_tree_view)
@@ -195,180 +196,88 @@ def setupUi(self, MainWindow):
self.treeView_parameter_value_list.setObjectName(u"treeView_parameter_value_list")
self.treeView_parameter_value_list.setEditTriggers(QAbstractItemView.AnyKeyPressed|QAbstractItemView.DoubleClicked|QAbstractItemView.EditKeyPressed)
self.treeView_parameter_value_list.setSelectionMode(QAbstractItemView.ExtendedSelection)
- self.treeView_parameter_value_list.setUniformRowHeights(True)
self.treeView_parameter_value_list.header().setVisible(True)
self.verticalLayout.addWidget(self.treeView_parameter_value_list)
self.dockWidget_parameter_value_list.setWidget(self.dockWidgetContents)
MainWindow.addDockWidget(Qt.RightDockWidgetArea, self.dockWidget_parameter_value_list)
- self.dockWidget_relationship_parameter_value = QDockWidget(MainWindow)
- self.dockWidget_relationship_parameter_value.setObjectName(u"dockWidget_relationship_parameter_value")
+ self.dockWidget_parameter_value = QDockWidget(MainWindow)
+ self.dockWidget_parameter_value.setObjectName(u"dockWidget_parameter_value")
self.dockWidgetContents_2 = QWidget()
self.dockWidgetContents_2.setObjectName(u"dockWidgetContents_2")
self.verticalLayout_5 = QVBoxLayout(self.dockWidgetContents_2)
self.verticalLayout_5.setSpacing(0)
self.verticalLayout_5.setObjectName(u"verticalLayout_5")
self.verticalLayout_5.setContentsMargins(0, 0, 0, 0)
- self.tableView_relationship_parameter_value = RelationshipParameterValueTableView(self.dockWidgetContents_2)
- self.tableView_relationship_parameter_value.setObjectName(u"tableView_relationship_parameter_value")
- sizePolicy1 = QSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
- sizePolicy1.setHorizontalStretch(2)
- sizePolicy1.setVerticalStretch(0)
- sizePolicy1.setHeightForWidth(self.tableView_relationship_parameter_value.sizePolicy().hasHeightForWidth())
- self.tableView_relationship_parameter_value.setSizePolicy(sizePolicy1)
- self.tableView_relationship_parameter_value.setMouseTracking(True)
- self.tableView_relationship_parameter_value.setContextMenuPolicy(Qt.DefaultContextMenu)
- self.tableView_relationship_parameter_value.setLayoutDirection(Qt.LeftToRight)
- self.tableView_relationship_parameter_value.setTabKeyNavigation(False)
- self.tableView_relationship_parameter_value.setSelectionBehavior(QAbstractItemView.SelectItems)
- self.tableView_relationship_parameter_value.setSortingEnabled(False)
- self.tableView_relationship_parameter_value.setWordWrap(False)
- self.tableView_relationship_parameter_value.horizontalHeader().setHighlightSections(False)
- self.tableView_relationship_parameter_value.horizontalHeader().setStretchLastSection(True)
- self.tableView_relationship_parameter_value.verticalHeader().setVisible(False)
- self.tableView_relationship_parameter_value.verticalHeader().setHighlightSections(False)
-
- self.verticalLayout_5.addWidget(self.tableView_relationship_parameter_value)
-
- self.dockWidget_relationship_parameter_value.setWidget(self.dockWidgetContents_2)
- MainWindow.addDockWidget(Qt.RightDockWidgetArea, self.dockWidget_relationship_parameter_value)
- self.dockWidget_object_parameter_value = QDockWidget(MainWindow)
- self.dockWidget_object_parameter_value.setObjectName(u"dockWidget_object_parameter_value")
- self.dockWidgetContents_3 = QWidget()
- self.dockWidgetContents_3.setObjectName(u"dockWidgetContents_3")
- self.verticalLayout_3 = QVBoxLayout(self.dockWidgetContents_3)
- self.verticalLayout_3.setSpacing(0)
- self.verticalLayout_3.setObjectName(u"verticalLayout_3")
- self.verticalLayout_3.setContentsMargins(0, 0, 0, 0)
- self.tableView_object_parameter_value = ObjectParameterValueTableView(self.dockWidgetContents_3)
- self.tableView_object_parameter_value.setObjectName(u"tableView_object_parameter_value")
- sizePolicy1.setHeightForWidth(self.tableView_object_parameter_value.sizePolicy().hasHeightForWidth())
- self.tableView_object_parameter_value.setSizePolicy(sizePolicy1)
- font = QFont()
- font.setBold(False)
- self.tableView_object_parameter_value.setFont(font)
- self.tableView_object_parameter_value.setMouseTracking(True)
- self.tableView_object_parameter_value.setContextMenuPolicy(Qt.DefaultContextMenu)
- self.tableView_object_parameter_value.setLayoutDirection(Qt.LeftToRight)
- self.tableView_object_parameter_value.setTabKeyNavigation(False)
- self.tableView_object_parameter_value.setSelectionBehavior(QAbstractItemView.SelectItems)
- self.tableView_object_parameter_value.setSortingEnabled(False)
- self.tableView_object_parameter_value.setWordWrap(False)
- self.tableView_object_parameter_value.horizontalHeader().setHighlightSections(False)
- self.tableView_object_parameter_value.horizontalHeader().setStretchLastSection(True)
- self.tableView_object_parameter_value.verticalHeader().setVisible(False)
- self.tableView_object_parameter_value.verticalHeader().setHighlightSections(False)
-
- self.verticalLayout_3.addWidget(self.tableView_object_parameter_value)
-
- self.dockWidget_object_parameter_value.setWidget(self.dockWidgetContents_3)
- MainWindow.addDockWidget(Qt.RightDockWidgetArea, self.dockWidget_object_parameter_value)
- self.dockWidget_object_parameter_definition = QDockWidget(MainWindow)
- self.dockWidget_object_parameter_definition.setObjectName(u"dockWidget_object_parameter_definition")
- self.dockWidgetContents_4 = QWidget()
- self.dockWidgetContents_4.setObjectName(u"dockWidgetContents_4")
- self.verticalLayout_8 = QVBoxLayout(self.dockWidgetContents_4)
- self.verticalLayout_8.setSpacing(0)
- self.verticalLayout_8.setObjectName(u"verticalLayout_8")
- self.verticalLayout_8.setContentsMargins(0, 0, 0, 0)
- self.tableView_object_parameter_definition = ObjectParameterDefinitionTableView(self.dockWidgetContents_4)
- self.tableView_object_parameter_definition.setObjectName(u"tableView_object_parameter_definition")
- sizePolicy1.setHeightForWidth(self.tableView_object_parameter_definition.sizePolicy().hasHeightForWidth())
- self.tableView_object_parameter_definition.setSizePolicy(sizePolicy1)
- self.tableView_object_parameter_definition.setContextMenuPolicy(Qt.DefaultContextMenu)
- self.tableView_object_parameter_definition.setLayoutDirection(Qt.LeftToRight)
- self.tableView_object_parameter_definition.setTabKeyNavigation(False)
- self.tableView_object_parameter_definition.setSelectionBehavior(QAbstractItemView.SelectItems)
- self.tableView_object_parameter_definition.setSortingEnabled(False)
- self.tableView_object_parameter_definition.setWordWrap(False)
- self.tableView_object_parameter_definition.horizontalHeader().setHighlightSections(False)
- self.tableView_object_parameter_definition.horizontalHeader().setProperty("showSortIndicator", False)
- self.tableView_object_parameter_definition.horizontalHeader().setStretchLastSection(True)
- self.tableView_object_parameter_definition.verticalHeader().setVisible(False)
- self.tableView_object_parameter_definition.verticalHeader().setHighlightSections(False)
-
- self.verticalLayout_8.addWidget(self.tableView_object_parameter_definition)
-
- self.dockWidget_object_parameter_definition.setWidget(self.dockWidgetContents_4)
- MainWindow.addDockWidget(Qt.RightDockWidgetArea, self.dockWidget_object_parameter_definition)
- self.dockWidget_relationship_parameter_definition = QDockWidget(MainWindow)
- self.dockWidget_relationship_parameter_definition.setObjectName(u"dockWidget_relationship_parameter_definition")
+ self.tableView_parameter_value = ParameterValueTableView(self.dockWidgetContents_2)
+ self.tableView_parameter_value.setObjectName(u"tableView_parameter_value")
+ self.tableView_parameter_value.setMouseTracking(True)
+ self.tableView_parameter_value.setContextMenuPolicy(Qt.DefaultContextMenu)
+ self.tableView_parameter_value.setLayoutDirection(Qt.LeftToRight)
+ self.tableView_parameter_value.setTabKeyNavigation(False)
+ self.tableView_parameter_value.setSelectionBehavior(QAbstractItemView.SelectItems)
+ self.tableView_parameter_value.setHorizontalScrollMode(QAbstractItemView.ScrollPerPixel)
+ self.tableView_parameter_value.setSortingEnabled(False)
+ self.tableView_parameter_value.setWordWrap(False)
+ self.tableView_parameter_value.horizontalHeader().setHighlightSections(False)
+ self.tableView_parameter_value.verticalHeader().setVisible(False)
+ self.tableView_parameter_value.verticalHeader().setHighlightSections(False)
+
+ self.verticalLayout_5.addWidget(self.tableView_parameter_value)
+
+ self.dockWidget_parameter_value.setWidget(self.dockWidgetContents_2)
+ MainWindow.addDockWidget(Qt.RightDockWidgetArea, self.dockWidget_parameter_value)
+ self.dockWidget_parameter_definition = QDockWidget(MainWindow)
+ self.dockWidget_parameter_definition.setObjectName(u"dockWidget_parameter_definition")
self.dockWidgetContents_5 = QWidget()
self.dockWidgetContents_5.setObjectName(u"dockWidgetContents_5")
self.verticalLayout_10 = QVBoxLayout(self.dockWidgetContents_5)
self.verticalLayout_10.setSpacing(0)
self.verticalLayout_10.setObjectName(u"verticalLayout_10")
self.verticalLayout_10.setContentsMargins(0, 0, 0, 0)
- self.tableView_relationship_parameter_definition = RelationshipParameterDefinitionTableView(self.dockWidgetContents_5)
- self.tableView_relationship_parameter_definition.setObjectName(u"tableView_relationship_parameter_definition")
- sizePolicy1.setHeightForWidth(self.tableView_relationship_parameter_definition.sizePolicy().hasHeightForWidth())
- self.tableView_relationship_parameter_definition.setSizePolicy(sizePolicy1)
- self.tableView_relationship_parameter_definition.setContextMenuPolicy(Qt.DefaultContextMenu)
- self.tableView_relationship_parameter_definition.setLayoutDirection(Qt.LeftToRight)
- self.tableView_relationship_parameter_definition.setTabKeyNavigation(False)
- self.tableView_relationship_parameter_definition.setSelectionBehavior(QAbstractItemView.SelectItems)
- self.tableView_relationship_parameter_definition.setSortingEnabled(False)
- self.tableView_relationship_parameter_definition.setWordWrap(False)
- self.tableView_relationship_parameter_definition.horizontalHeader().setHighlightSections(False)
- self.tableView_relationship_parameter_definition.horizontalHeader().setStretchLastSection(True)
- self.tableView_relationship_parameter_definition.verticalHeader().setVisible(False)
- self.tableView_relationship_parameter_definition.verticalHeader().setHighlightSections(False)
-
- self.verticalLayout_10.addWidget(self.tableView_relationship_parameter_definition)
-
- self.dockWidget_relationship_parameter_definition.setWidget(self.dockWidgetContents_5)
- MainWindow.addDockWidget(Qt.RightDockWidgetArea, self.dockWidget_relationship_parameter_definition)
- self.dockWidget_object_tree = QDockWidget(MainWindow)
- self.dockWidget_object_tree.setObjectName(u"dockWidget_object_tree")
- self.dockWidget_object_tree.setFeatures(QDockWidget.DockWidgetClosable|QDockWidget.DockWidgetFloatable|QDockWidget.DockWidgetMovable)
- self.dockWidget_object_tree.setAllowedAreas(Qt.AllDockWidgetAreas)
+ self.tableView_parameter_definition = ParameterDefinitionTableView(self.dockWidgetContents_5)
+ self.tableView_parameter_definition.setObjectName(u"tableView_parameter_definition")
+ self.tableView_parameter_definition.setContextMenuPolicy(Qt.DefaultContextMenu)
+ self.tableView_parameter_definition.setTabKeyNavigation(False)
+ self.tableView_parameter_definition.setSelectionBehavior(QAbstractItemView.SelectItems)
+ self.tableView_parameter_definition.setHorizontalScrollMode(QAbstractItemView.ScrollPerPixel)
+ self.tableView_parameter_definition.setSortingEnabled(False)
+ self.tableView_parameter_definition.setWordWrap(False)
+ self.tableView_parameter_definition.horizontalHeader().setHighlightSections(False)
+ self.tableView_parameter_definition.verticalHeader().setVisible(False)
+ self.tableView_parameter_definition.verticalHeader().setHighlightSections(False)
+
+ self.verticalLayout_10.addWidget(self.tableView_parameter_definition)
+
+ self.dockWidget_parameter_definition.setWidget(self.dockWidgetContents_5)
+ MainWindow.addDockWidget(Qt.RightDockWidgetArea, self.dockWidget_parameter_definition)
+ self.dockWidget_entity_tree = QDockWidget(MainWindow)
+ self.dockWidget_entity_tree.setObjectName(u"dockWidget_entity_tree")
+ self.dockWidget_entity_tree.setAllowedAreas(Qt.AllDockWidgetAreas)
self.dockWidgetContents_6 = QWidget()
self.dockWidgetContents_6.setObjectName(u"dockWidgetContents_6")
self.verticalLayout_4 = QVBoxLayout(self.dockWidgetContents_6)
self.verticalLayout_4.setSpacing(0)
self.verticalLayout_4.setObjectName(u"verticalLayout_4")
self.verticalLayout_4.setContentsMargins(0, 0, 0, 0)
- self.treeView_object = ObjectTreeView(self.dockWidgetContents_6)
- self.treeView_object.setObjectName(u"treeView_object")
- sizePolicy2 = QSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
- sizePolicy2.setHorizontalStretch(1)
- sizePolicy2.setVerticalStretch(0)
- sizePolicy2.setHeightForWidth(self.treeView_object.sizePolicy().hasHeightForWidth())
- self.treeView_object.setSizePolicy(sizePolicy2)
- self.treeView_object.setContextMenuPolicy(Qt.DefaultContextMenu)
- self.treeView_object.setEditTriggers(QAbstractItemView.EditKeyPressed)
- self.treeView_object.setSelectionMode(QAbstractItemView.ExtendedSelection)
- self.treeView_object.setSelectionBehavior(QAbstractItemView.SelectItems)
- self.treeView_object.setIconSize(QSize(20, 20))
- self.treeView_object.setUniformRowHeights(True)
-
- self.verticalLayout_4.addWidget(self.treeView_object)
-
- self.dockWidget_object_tree.setWidget(self.dockWidgetContents_6)
- MainWindow.addDockWidget(Qt.LeftDockWidgetArea, self.dockWidget_object_tree)
- self.dockWidget_relationship_tree = QDockWidget(MainWindow)
- self.dockWidget_relationship_tree.setObjectName(u"dockWidget_relationship_tree")
- self.dockWidget_relationship_tree.setAllowedAreas(Qt.AllDockWidgetAreas)
- self.dockWidgetContents_7 = QWidget()
- self.dockWidgetContents_7.setObjectName(u"dockWidgetContents_7")
- self.verticalLayout_6 = QVBoxLayout(self.dockWidgetContents_7)
- self.verticalLayout_6.setSpacing(0)
- self.verticalLayout_6.setObjectName(u"verticalLayout_6")
- self.verticalLayout_6.setContentsMargins(0, 0, 0, 0)
- self.treeView_relationship = RelationshipTreeView(self.dockWidgetContents_7)
- self.treeView_relationship.setObjectName(u"treeView_relationship")
- self.treeView_relationship.setContextMenuPolicy(Qt.DefaultContextMenu)
- self.treeView_relationship.setEditTriggers(QAbstractItemView.EditKeyPressed)
- self.treeView_relationship.setSelectionMode(QAbstractItemView.ExtendedSelection)
- self.treeView_relationship.setSelectionBehavior(QAbstractItemView.SelectItems)
- self.treeView_relationship.setIconSize(QSize(20, 20))
- self.treeView_relationship.setUniformRowHeights(True)
-
- self.verticalLayout_6.addWidget(self.treeView_relationship)
-
- self.dockWidget_relationship_tree.setWidget(self.dockWidgetContents_7)
- MainWindow.addDockWidget(Qt.LeftDockWidgetArea, self.dockWidget_relationship_tree)
+ self.treeView_entity = EntityTreeView(self.dockWidgetContents_6)
+ self.treeView_entity.setObjectName(u"treeView_entity")
+ sizePolicy1 = QSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
+ sizePolicy1.setHorizontalStretch(1)
+ sizePolicy1.setVerticalStretch(0)
+ sizePolicy1.setHeightForWidth(self.treeView_entity.sizePolicy().hasHeightForWidth())
+ self.treeView_entity.setSizePolicy(sizePolicy1)
+ self.treeView_entity.setEditTriggers(QAbstractItemView.EditKeyPressed)
+ self.treeView_entity.setSelectionMode(QAbstractItemView.ExtendedSelection)
+ self.treeView_entity.setSelectionBehavior(QAbstractItemView.SelectItems)
+ self.treeView_entity.setIconSize(QSize(20, 20))
+ self.treeView_entity.setUniformRowHeights(False)
+
+ self.verticalLayout_4.addWidget(self.treeView_entity)
+
+ self.dockWidget_entity_tree.setWidget(self.dockWidgetContents_6)
+ MainWindow.addDockWidget(Qt.LeftDockWidgetArea, self.dockWidget_entity_tree)
self.dockWidget_entity_graph = QDockWidget(MainWindow)
self.dockWidget_entity_graph.setObjectName(u"dockWidget_entity_graph")
self.dockWidgetContents_8 = QWidget()
@@ -379,14 +288,32 @@ def setupUi(self, MainWindow):
self.verticalLayout_7.setContentsMargins(0, 0, 0, 0)
self.graphicsView = EntityQGraphicsView(self.dockWidgetContents_8)
self.graphicsView.setObjectName(u"graphicsView")
- sizePolicy1.setHeightForWidth(self.graphicsView.sizePolicy().hasHeightForWidth())
- self.graphicsView.setSizePolicy(sizePolicy1)
+ sizePolicy2 = QSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
+ sizePolicy2.setHorizontalStretch(2)
+ sizePolicy2.setVerticalStretch(0)
+ sizePolicy2.setHeightForWidth(self.graphicsView.sizePolicy().hasHeightForWidth())
+ self.graphicsView.setSizePolicy(sizePolicy2)
self.graphicsView.setMouseTracking(True)
self.graphicsView.setFrameShape(QFrame.NoFrame)
self.graphicsView.setDragMode(QGraphicsView.ScrollHandDrag)
self.verticalLayout_7.addWidget(self.graphicsView)
+ self.time_line_widget = TimeLineWidget(self.dockWidgetContents_8)
+ self.time_line_widget.setObjectName(u"time_line_widget")
+
+ self.verticalLayout_7.addWidget(self.time_line_widget)
+
+ self.legend_widget = LegendWidget(self.dockWidgetContents_8)
+ self.legend_widget.setObjectName(u"legend_widget")
+
+ self.verticalLayout_7.addWidget(self.legend_widget)
+
+ self.progress_bar_widget = ProgressBarWidget(self.dockWidgetContents_8)
+ self.progress_bar_widget.setObjectName(u"progress_bar_widget")
+
+ self.verticalLayout_7.addWidget(self.progress_bar_widget)
+
self.dockWidget_entity_graph.setWidget(self.dockWidgetContents_8)
MainWindow.addDockWidget(Qt.LeftDockWidgetArea, self.dockWidget_entity_graph)
self.dockWidget_pivot_table = QDockWidget(MainWindow)
@@ -401,6 +328,7 @@ def setupUi(self, MainWindow):
self.pivot_table.setObjectName(u"pivot_table")
self.pivot_table.setContextMenuPolicy(Qt.DefaultContextMenu)
self.pivot_table.setTabKeyNavigation(False)
+ self.pivot_table.setHorizontalScrollMode(QAbstractItemView.ScrollPerPixel)
self.verticalLayout_13.addWidget(self.pivot_table)
@@ -450,25 +378,6 @@ def setupUi(self, MainWindow):
self.dockWidget_exports.setWidget(self.dockWidgetContents_12)
MainWindow.addDockWidget(Qt.BottomDockWidgetArea, self.dockWidget_exports)
- self.dockWidget_tool_feature_tree = QDockWidget(MainWindow)
- self.dockWidget_tool_feature_tree.setObjectName(u"dockWidget_tool_feature_tree")
- self.dockWidgetContents_13 = QWidget()
- self.dockWidgetContents_13.setObjectName(u"dockWidgetContents_13")
- self.verticalLayout_2 = QVBoxLayout(self.dockWidgetContents_13)
- self.verticalLayout_2.setSpacing(0)
- self.verticalLayout_2.setObjectName(u"verticalLayout_2")
- self.verticalLayout_2.setContentsMargins(0, 0, 0, 0)
- self.treeView_tool_feature = ToolFeatureTreeView(self.dockWidgetContents_13)
- self.treeView_tool_feature.setObjectName(u"treeView_tool_feature")
- self.treeView_tool_feature.setEditTriggers(QAbstractItemView.AnyKeyPressed|QAbstractItemView.DoubleClicked|QAbstractItemView.EditKeyPressed)
- self.treeView_tool_feature.setDragEnabled(True)
- self.treeView_tool_feature.setDragDropMode(QAbstractItemView.InternalMove)
- self.treeView_tool_feature.setSelectionMode(QAbstractItemView.ExtendedSelection)
-
- self.verticalLayout_2.addWidget(self.treeView_tool_feature)
-
- self.dockWidget_tool_feature_tree.setWidget(self.dockWidgetContents_13)
- MainWindow.addDockWidget(Qt.RightDockWidgetArea, self.dockWidget_tool_feature_tree)
self.metadata_dock_widget = QDockWidget(MainWindow)
self.metadata_dock_widget.setObjectName(u"metadata_dock_widget")
self.metadata_dock_contents = QWidget()
@@ -520,12 +429,33 @@ def setupUi(self, MainWindow):
self.scenario_tree_view.setDragDropMode(QAbstractItemView.DragDrop)
self.scenario_tree_view.setDefaultDropAction(Qt.MoveAction)
self.scenario_tree_view.setSelectionMode(QAbstractItemView.ExtendedSelection)
- self.scenario_tree_view.setUniformRowHeights(True)
+ self.scenario_tree_view.setUniformRowHeights(False)
self.verticalLayout_12.addWidget(self.scenario_tree_view)
self.scenario_dock_widget.setWidget(self.dockWidgetContents_9)
MainWindow.addDockWidget(Qt.LeftDockWidgetArea, self.scenario_dock_widget)
+ self.dockWidget_entity_alternative = QDockWidget(MainWindow)
+ self.dockWidget_entity_alternative.setObjectName(u"dockWidget_entity_alternative")
+ self.dockWidgetContents_3 = QWidget()
+ self.dockWidgetContents_3.setObjectName(u"dockWidgetContents_3")
+ self.verticalLayout_2 = QVBoxLayout(self.dockWidgetContents_3)
+ self.verticalLayout_2.setSpacing(0)
+ self.verticalLayout_2.setObjectName(u"verticalLayout_2")
+ self.verticalLayout_2.setContentsMargins(0, 0, 0, 0)
+ self.tableView_entity_alternative = EntityAlternativeTableView(self.dockWidgetContents_3)
+ self.tableView_entity_alternative.setObjectName(u"tableView_entity_alternative")
+ self.tableView_entity_alternative.setTabKeyNavigation(False)
+ self.tableView_entity_alternative.setHorizontalScrollMode(QAbstractItemView.ScrollPerPixel)
+ self.tableView_entity_alternative.setWordWrap(False)
+ self.tableView_entity_alternative.horizontalHeader().setHighlightSections(False)
+ self.tableView_entity_alternative.verticalHeader().setVisible(False)
+ self.tableView_entity_alternative.verticalHeader().setHighlightSections(False)
+
+ self.verticalLayout_2.addWidget(self.tableView_entity_alternative)
+
+ self.dockWidget_entity_alternative.setWidget(self.dockWidgetContents_3)
+ MainWindow.addDockWidget(Qt.RightDockWidgetArea, self.dockWidget_entity_alternative)
self.retranslateUi(MainWindow)
@@ -535,10 +465,16 @@ def setupUi(self, MainWindow):
def retranslateUi(self, MainWindow):
MainWindow.setWindowTitle(QCoreApplication.translate("MainWindow", u"MainWindow", None))
self.actionCommit.setText(QCoreApplication.translate("MainWindow", u"&Commit...", None))
+#if QT_CONFIG(tooltip)
+ self.actionCommit.setToolTip(QCoreApplication.translate("MainWindow", u"Commit
Ctrl+Enter
", None))
+#endif // QT_CONFIG(tooltip)
#if QT_CONFIG(shortcut)
self.actionCommit.setShortcut(QCoreApplication.translate("MainWindow", u"Ctrl+Return", None))
#endif // QT_CONFIG(shortcut)
self.actionRollback.setText(QCoreApplication.translate("MainWindow", u"Roll&back", None))
+#if QT_CONFIG(tooltip)
+ self.actionRollback.setToolTip(QCoreApplication.translate("MainWindow", u"