refactor: use entry IDs instead of objects and indices

- fixes preview panel not updating after entry edits
- fixes slow selection performance
- fixes double render call

Author: CyanVoxel

tagstudio/src/core/library/alchemy/library.py

@@ -420,7 +420,7 @@ def get_entry(self, entry_id: int) -> Entry | None:
             return entry
 
     def get_entry_full(self, entry_id: int) -> Entry | None:
-        """Load entry an join with all joins and all tags."""
+        """Load entry and join with all joins and all tags."""
         with Session(self.engine) as session:
             statement = select(Entry).where(Entry.id == entry_id)
             statement = (
@@ -454,7 +454,9 @@ def get_entries(self, with_joins: bool = False) -> Iterator[Entry]:
             if with_joins:
                 # load Entry with all joins and all tags
                 stmt = (
-                    stmt.outerjoin(Entry.text_fields).outerjoin(Entry.datetime_fields)
+                    stmt.outerjoin(Entry.text_fields)
+                    .outerjoin(Entry.datetime_fields)
+                    .outerjoin(Entry.tags)
                     # .outerjoin(Entry.tag_box_fields)
                 )
                 stmt = stmt.options(
@@ -929,6 +931,7 @@ def add_tag(
                 return None
 
     def add_tags_to_entry(self, entry_id: int, tag_ids: int | list[int] | set[int]) -> bool:
+        """Add one or more tags to an entry."""
         tag_ids_ = [tag_ids] if isinstance(tag_ids, int) else tag_ids
         with Session(self.engine, expire_on_commit=False) as session:
             try:
@@ -937,6 +940,30 @@ def add_tags_to_entry(self, entry_id: int, tag_ids: int | list[int] | set[int])
                     session.flush()
                 session.commit()
                 return True
+            except IntegrityError as e:
+                logger.warning("[add_tags_to_entry]", warning=e)
+                session.rollback()
+                return False
+
+    def remove_tags_from_entry(self, entry_id: int, tag_ids: int | list[int] | set[int]) -> bool:
+        """Remove one or more tags from an entry."""
+        tag_ids_ = [tag_ids] if isinstance(tag_ids, int) else tag_ids
+        with Session(self.engine, expire_on_commit=False) as session:
+            try:
+                for tag_id in tag_ids_:
+                    tag_entry = session.scalars(
+                        select(TagEntry).where(
+                            and_(
+                                TagEntry.tag_id == tag_id,
+                                TagEntry.entry_id == entry_id,
+                            )
+                        )
+                    ).first()
+                    if tag_entry:
+                        session.delete(tag_entry)
+                        session.commit()
+                session.commit()
+                return True
             except IntegrityError as e:
                 logger.exception(e)
                 session.rollback()

tagstudio/src/core/library/alchemy/models.py

@@ -146,7 +146,7 @@ def fields(self) -> list[BaseField]:
         return fields
 
     @property
-    def is_favorited(self) -> bool:
+    def is_favorite(self) -> bool:
         return any(tag.id == TAG_FAVORITE for tag in self.tags)
 
     @property

tagstudio/src/qt/ts_qt.py

@@ -16,7 +16,6 @@
 import time
 import webbrowser
 from collections.abc import Sequence
-from itertools import zip_longest
 from pathlib import Path
 from queue import Queue
 
@@ -53,8 +52,6 @@
     QWidget,
 )
 from src.core.constants import (
-    TAG_ARCHIVED,
-    TAG_FAVORITE,
     VERSION,
     VERSION_BRANCH,
 )
@@ -136,7 +133,7 @@ def __init__(self, backend, args):
         self.rm: ResourceManager = ResourceManager()
         self.args = args
         self.filter = FilterState.show_all()
-        self.frame_content: list[Entry] = []
+        self.frame_content: list[int] = []  # List of Entry IDs on the current page
         self.pages_count = 0
 
         self.scrollbar_pos = 0
@@ -150,9 +147,7 @@ def __init__(self, backend, args):
         self.thumb_job_queue: Queue = Queue()
         self.thumb_threads: list[Consumer] = []
         self.thumb_cutoff: float = time.time()
-
-        # grid indexes of selected items
-        self.selected: list[int] = []
+        self.selected: list[int] = []  # Selected Entry IDs
 
         self.SIGTERM.connect(self.handle_sigterm)
 
@@ -546,11 +541,13 @@ def init_library_window(self):
         self.preview_panel.update_widgets()
 
     def toggle_libs_list(self, value: bool):
-        if value:
-            self.preview_panel.libs_flow_container.show()
-        else:
-            self.preview_panel.libs_flow_container.hide()
-        self.preview_panel.update()
+        # TODO: Reimplement or remove
+        # if value:
+        #     self.preview_panel.libs_flow_container.show()
+        # else:
+        #     self.preview_panel.libs_flow_container.hide()
+        # self.preview_panel.update()
+        pass
 
     def show_grid_filenames(self, value: bool):
         for thumb in self.item_thumbs:
@@ -643,10 +640,12 @@ def add_tag_action_callback(self):
         self.modal.show()
 
     def select_all_action_callback(self):
-        self.selected = list(range(0, len(self.frame_content)))
-
-        for grid_idx in self.selected:
-            self.item_thumbs[grid_idx].thumb_button.set_selected(True)
+        """Set the selection to all visible items."""
+        self.selected.clear()
+        for item in self.item_thumbs:
+            if item.mode and item.item_id not in self.selected:
+                self.selected.append(item.item_id)
+                item.thumb_button.set_selected(True)
 
         self.set_macro_menu_viability()
         self.preview_panel.update_widgets()
@@ -766,14 +765,14 @@ def new_file_macros_runnable(self, new_ids):
         # sleep(5)
         # pb.deleteLater()
 
-    def run_macros(self, name: MacroID, grid_idx: list[int]):
+    def run_macros(self, name: MacroID, entry_ids: list[int]):
         """Run a specific Macro on a group of given entry_ids."""
-        for gid in grid_idx:
-            self.run_macro(name, gid)
+        for entry_id in entry_ids:
+            self.run_macro(name, entry_id)
 
-    def run_macro(self, name: MacroID, grid_idx: int):
+    def run_macro(self, name: MacroID, entry_id: int):
         """Run a specific Macro on an Entry given a Macro name."""
-        entry: Entry = self.frame_content[grid_idx]
+        entry: Entry = self.lib.get_entry(entry_id)
         full_path = self.lib.library_dir / entry.path
         source = "" if entry.path.parent == Path(".") else entry.path.parts[0].lower()
 
@@ -782,14 +781,14 @@ def run_macro(self, name: MacroID, grid_idx: int):
             source=source,
             macro=name,
             entry_id=entry.id,
-            grid_idx=grid_idx,
+            grid_idx=entry_id,
         )
 
         if name == MacroID.AUTOFILL:
             for macro_id in MacroID:
                 if macro_id == MacroID.AUTOFILL:
                     continue
-                self.run_macro(macro_id, grid_idx)
+                self.run_macro(macro_id, entry_id)
 
         elif name == MacroID.SIDECAR:
             parsed_items = TagStudioCore.get_gdl_sidecar(full_path, source)
@@ -886,13 +885,12 @@ def _init_thumb_grid(self):
         layout.setAlignment(Qt.AlignmentFlag.AlignCenter)
 
         # TODO - init after library is loaded, it can have different page_size
-        for grid_idx in range(self.filter.page_size):
+        for _ in range(self.filter.page_size):
             item_thumb = ItemThumb(
                 None,
                 self.lib,
                 self,
                 (self.thumb_size, self.thumb_size),
-                grid_idx,
                 bool(
                     self.settings.value(SettingItems.SHOW_FILENAMES, defaultValue=True, type=bool)
                 ),
@@ -909,44 +907,55 @@ def _init_thumb_grid(self):
         sa.setWidgetResizable(True)
         sa.setWidget(self.flow_container)
 
-    def select_item(self, grid_index: int, append: bool, bridge: bool):
+    def select_item(self, item_id: int, append: bool, bridge: bool):
         """Select one or more items in the Thumbnail Grid."""
-        logger.info("selecting item", grid_index=grid_index, append=append, bridge=bridge)
+        logger.info("[QtDriver] Selecting Items:", item_id=item_id, append=append, bridge=bridge)
         if append:
-            if grid_index not in self.selected:
-                self.selected.append(grid_index)
-                self.item_thumbs[grid_index].thumb_button.set_selected(True)
+            if item_id not in self.selected:
+                self.selected.append(item_id)
+                for it in self.item_thumbs:
+                    if it.item_id == item_id:
+                        it.thumb_button.set_selected(True)
             else:
-                self.selected.remove(grid_index)
-                self.item_thumbs[grid_index].thumb_button.set_selected(False)
+                self.selected.remove(item_id)
+                for it in self.item_thumbs:
+                    if it.item_id == item_id:
+                        it.thumb_button.set_selected(False)
 
         elif bridge and self.selected:
-            select_from = min(self.selected)
-            select_to = max(self.selected)
-
-            if select_to < grid_index:
-                index_range = range(select_from, grid_index + 1)
-            else:
-                index_range = range(grid_index, select_to + 1)
-
-            self.selected = list(index_range)
+            contents = self.frame_content
+            last_index = self.frame_content.index(self.selected[-1])
+            current_index = self.frame_content.index(item_id)
+            index_range: list = contents[
+                min(last_index, current_index) : max(last_index, current_index) + 1
+            ]
+            # Preserve bridge direction for correct appending order.
+            if last_index < current_index:
+                index_range.reverse()
+            for entry_id in index_range:
+                for it in self.item_thumbs:
+                    if it.item_id == entry_id:
+                        it.thumb_button.set_selected(True)
+                        if entry_id not in self.selected:
+                            self.selected.append(entry_id)
 
-            for selected_idx in self.selected:
-                self.item_thumbs[selected_idx].thumb_button.set_selected(True)
         else:
-            self.selected = [grid_index]
-            for thumb_idx, item_thumb in enumerate(self.item_thumbs):
-                item_matched = thumb_idx == grid_index
-                item_thumb.thumb_button.set_selected(item_matched)
-
-        # NOTE: By using the preview panel's "set_tags_updated_slot" method,
-        # only the last of multiple identical item selections are connected.
-        # If attaching the slot to multiple duplicate selections is needed,
-        # just bypass the method and manually disconnect and connect the slots.
-        if len(self.selected) == 1:
+            self.selected.clear()
+            self.selected.append(item_id)
             for it in self.item_thumbs:
-                if it.item_id == id:
-                    self.preview_panel.set_tags_updated_slot(it.refresh_badge)
+                if it.item_id == item_id:
+                    it.thumb_button.set_selected(True)
+                else:
+                    it.thumb_button.set_selected(False)
+
+        # # NOTE: By using the preview panel's "set_tags_updated_slot" method,
+        # # only the last of multiple identical item selections are connected.
+        # # If attaching the slot to multiple duplicate selections is needed,
+        # # just bypass the method and manually disconnect and connect the slots.
+        # if len(self.selected) == 1:
+        #     for it in self.item_thumbs:
+        #         if it.item_id == item_id:
+        #             self.preview_panel.set_tags_updated_slot(it.refresh_badge)
 
         self.set_macro_menu_viability()
         self.preview_panel.update_widgets()
@@ -1043,18 +1052,26 @@ def update_thumbs(self):
         self.main_window.update()
 
         is_grid_thumb = True
-        # Show loading placeholder icons
-        for entry, item_thumb in zip_longest(self.frame_content, self.item_thumbs):
-            if not entry:
+        logger.info("[QtDriver] Loading Entries...")
+        # TODO: Grab all entries at once
+        entries: list[Entry] = [self.lib.get_entry_full(e_id) for e_id in self.frame_content]
+        logger.info("[QtDriver] Building Filenames...")
+        filenames: list[Path] = [self.lib.library_dir / e.path for e in entries]
+        logger.info("[QtDriver] Done! Processing ItemThumbs...")
+        for index, item_thumb in enumerate(self.item_thumbs, start=0):
+            entry = None
+            try:
+                entry = entries[index]
+            except IndexError:
                 item_thumb.hide()
                 continue
-
+            if not entry:
+                continue
             item_thumb.set_mode(ItemType.ENTRY)
-            item_thumb.set_item_id(entry)
+            item_thumb.set_item_id(entry.id)
 
             # TODO - show after item is rendered
             item_thumb.show()
-
             is_loading = True
             self.thumb_job_queue.put(
                 (
@@ -1064,29 +1081,29 @@ def update_thumbs(self):
             )
 
         # Show rendered thumbnails
-        for idx, (entry, item_thumb) in enumerate(
-            zip_longest(self.frame_content, self.item_thumbs)
-        ):
+        for index, item_thumb in enumerate(self.item_thumbs, start=0):
+            entry = None
+            try:
+                entry = entries[index]
+            except IndexError:
+                item_thumb.hide()
+                continue
             if not entry:
                 continue
 
-            filepath = self.lib.library_dir / entry.path
             is_loading = False
-
             self.thumb_job_queue.put(
                 (
                     item_thumb.renderer.render,
-                    (time.time(), filepath, base_size, ratio, is_loading, is_grid_thumb),
+                    (time.time(), filenames[index], base_size, ratio, is_loading, is_grid_thumb),
                 )
             )
-
-            entry_tag_ids = {tag.id for tag in entry.tags}
-            item_thumb.assign_badge(BadgeType.ARCHIVED, TAG_ARCHIVED in entry_tag_ids)
-            item_thumb.assign_badge(BadgeType.FAVORITE, TAG_FAVORITE in entry_tag_ids)
+            item_thumb.assign_badge(BadgeType.ARCHIVED, entry.is_archived)
+            item_thumb.assign_badge(BadgeType.FAVORITE, entry.is_favorite)
             item_thumb.update_clickable(
                 clickable=(
-                    lambda checked=False, index=idx: self.select_item(
-                        index,
+                    lambda checked=False, item_id=entry.id: self.select_item(
+                        item_id,
                         append=(
                             QGuiApplication.keyboardModifiers()
                             == Qt.KeyboardModifier.ControlModifier
@@ -1102,24 +1119,15 @@ def update_thumbs(self):
             is_selected = (item_thumb.mode, item_thumb.item_id) in self.selected
             item_thumb.thumb_button.set_selected(is_selected)
 
-            self.thumb_job_queue.put(
-                (
-                    item_thumb.renderer.render,
-                    (time.time(), filepath, base_size, ratio, False, True),
-                )
-            )
-
-    def update_badges(self, grid_item_ids: Sequence[int] = None):
-        if not grid_item_ids:
+    def update_badges(self, item_ids: Sequence[int] = None):
+        if not item_ids:
             # no items passed, update all items in grid
-            grid_item_ids = range(min(len(self.item_thumbs), len(self.frame_content)))
-
-        logger.info("updating badges for items", grid_item_ids=grid_item_ids)
+            item_ids = range(min(len(self.item_thumbs), len(self.frame_content)))
 
-        for grid_idx in grid_item_ids:
-            # get the entry from grid to avoid loading from db again
-            entry = self.frame_content[grid_idx]
-            self.item_thumbs[grid_idx].refresh_badge(entry)
+        item_ids_ = set(item_ids)
+        for it in self.item_thumbs:
+            if it.item_id in item_ids_:
+                it.refresh_badge()
 
     def filter_items(self, filter: FilterState | None = None) -> None:
         if not self.lib.library_dir:
@@ -1150,7 +1158,7 @@ def filter_items(self, filter: FilterState | None = None) -> None:
         )
 
         # update page content
-        self.frame_content = results.items
+        self.frame_content = [item.id for item in results.items]
         self.update_thumbs()
 
         # update pagination