change entries getter

Author: yedpodtrzitko

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

@@ -217,33 +217,28 @@ def entries_count(self) -> int:
         with Session(self.engine) as session:
             return session.scalar(select(func.count(Entry.id)))
 
-    @property
-    def _entries(self) -> Iterator[Entry]:
+    def get_entries(self, with_joins: bool = False) -> Iterator[Entry]:
         """Load entries without joins."""
         with Session(self.engine) as session:
-            entries = session.execute(select(Entry).distinct()).scalars()  # .unique()
-            for entry in entries:
-                yield entry
-                session.expunge(entry)
-
-    @property
-    def _entries_full(self) -> Iterator[Entry]:
-        """Load entries with joins."""
-        with Session(self.engine) as session:
-            stmt = (
-                select(Entry)
-                .outerjoin(Entry.text_fields)
-                .outerjoin(Entry.datetime_fields)
-                .outerjoin(Entry.tag_box_fields)
-                .options(
-                    contains_eager(Entry.text_fields),
-                    contains_eager(Entry.datetime_fields),
-                    contains_eager(Entry.tag_box_fields).selectinload(TagBoxField.tags),
+            stmt = select(Entry)
+            if with_joins:
+                stmt = (
+                    stmt.outerjoin(Entry.text_fields)
+                    .outerjoin(Entry.datetime_fields)
+                    .outerjoin(Entry.tag_box_fields)
+                    .options(
+                        contains_eager(Entry.text_fields),
+                        contains_eager(Entry.datetime_fields),
+                        contains_eager(Entry.tag_box_fields).selectinload(
+                            TagBoxField.tags
+                        ),
+                    )
                 )
-                .distinct()
-            )
+            stmt = stmt.distinct()
 
-            entries = session.execute(stmt).scalars().unique()  # .all()
+            entries = session.execute(stmt).scalars()
+            if with_joins:
+                entries = entries.unique()
 
             for entry in entries:
                 yield entry

tagstudio/src/core/utils/missing_files.py

@@ -29,7 +29,7 @@ def refresh_missing_files(self) -> Iterator[int]:
         """Track the number of Entries that point to an invalid file path."""
         logger.info("refresh_missing_files running")
         self.missing_files = []
-        for i, entry in enumerate(self.library._entries):
+        for i, entry in enumerate(self.library.get_entries()):
             full_path = self.library.library_dir / entry.path
             if not full_path.exists() or not full_path.is_file():
                 self.missing_files.append(entry)

tagstudio/src/qt/modals/folders_to_tags.py

@@ -68,7 +68,7 @@ def add_tag_to_tree(items: list[Tag]):
         reversed_tag = reverse_tag(library, tag, None)
         add_tag_to_tree(reversed_tag)
 
-    for entry in library._entries:
+    for entry in library.get_entries():
         folders = entry.path.parts[1:-1]
         if not folders:
             continue
@@ -121,7 +121,7 @@ def _add_folders_to_tree(items: typing.Sequence[str]) -> BranchData:
         reversed_tag = reverse_tag(library, tag, None)
         add_tag_to_tree(reversed_tag)
 
-    for entry in library._entries:
+    for entry in library.get_entries():
         folders = entry.path.parts[1:-1]
         if not folders:
             continue

tagstudio/tests/conftest.py

@@ -75,6 +75,16 @@ def library(request):
     yield lib
 
 
+@pytest.fixture
+def entry(library):
+    yield next(library.get_entries())
+
+
+@pytest.fixture
+def entry_full(library):
+    yield next(library.get_entries(with_joins=True))
+
+
 @pytest.fixture
 def qt_driver(qtbot, library):
     with TemporaryDirectory() as tmp_dir:
@@ -97,7 +107,7 @@ class Args:
             driver.lib = library
             # TODO - downsize this method and use it
             # driver.start()
-            driver.frame_content = list(library._entries)
+            driver.frame_content = list(library.get_entries())
             yield driver
 
 

tagstudio/tests/macros/test_sidecar.py

@@ -9,19 +9,18 @@
 
 
 @pytest.mark.parametrize("library", [TemporaryDirectory()], indirect=True)
-def test_sidecar_macro(qt_driver, library, cwd):
-    entry = next(library._entries_full)
-    entry.path = Path("newgrounds/foo.txt")
+def test_sidecar_macro(qt_driver, library, cwd, entry_full):
+    entry_full.path = Path("newgrounds/foo.txt")
 
     fixture = cwd / "fixtures/sidecar_newgrounds.json"
-    dst = library.library_dir / "newgrounds" / (entry.path.stem + ".json")
+    dst = library.library_dir / "newgrounds" / (entry_full.path.stem + ".json")
     dst.parent.mkdir()
     shutil.copy(fixture, dst)
 
-    qt_driver.frame_content = [entry]
+    qt_driver.frame_content = [entry_full]
     qt_driver.run_macro(MacroID.SIDECAR, 0)
 
-    entry = next(library._entries_full)
+    entry = next(library.get_entries(with_joins=True))
     new_fields = (
         (_FieldID.DESCRIPTION.name, "NG description"),
         (_FieldID.ARTIST.name, "NG artist"),

tagstudio/tests/qt/test_driver.py

@@ -28,13 +28,11 @@ def test_update_thumbs(qt_driver):
         assert thumb.isVisible() == (idx == 0)
 
 
-def test_select_item_bridge(qt_driver):
+def test_select_item_bridge(qt_driver, entry):
     # mock some props since we're not running `start()`
     qt_driver.autofill_action = Mock()
     qt_driver.sort_fields_action = Mock()
 
-    entry = next(qt_driver.lib._entries)
-
     # set the content manually
     qt_driver.frame_content = [entry] * 3
 

tagstudio/tests/qt/test_item_thumb.py

@@ -5,9 +5,7 @@
 
 
 @pytest.mark.parametrize("new_value", (True, False))
-def test_badge_visual_state(library, qt_driver, new_value):
-    entry = next(qt_driver.lib._entries)
-
+def test_badge_visual_state(library, qt_driver, entry, new_value):
     thumb = ItemThumb(ItemType.ENTRY, qt_driver.lib, qt_driver, (100, 100), 0)
 
     qt_driver.frame_content = [entry]

tagstudio/tests/qt/test_preview_panel.py

@@ -5,7 +5,7 @@
 
 
 def test_update_widgets_not_selected(qt_driver, library):
-    qt_driver.frame_content = list(library._entries)
+    qt_driver.frame_content = list(library.get_entries())
     qt_driver.selected = []
 
     panel = PreviewPanel(library, qt_driver)
@@ -16,7 +16,7 @@ def test_update_widgets_not_selected(qt_driver, library):
 
 
 def test_update_widgets_single_selected(qt_driver, library):
-    qt_driver.frame_content = list(library._entries)
+    qt_driver.frame_content = list(library.get_entries())
     qt_driver.selected = [0]
 
     panel = PreviewPanel(library, qt_driver)
@@ -34,7 +34,7 @@ def test_update_widgets_multiple_selected(qt_driver, library):
     library.add_entries([entry])
     assert library.entries_count == 3
 
-    qt_driver.frame_content = list(library._entries)
+    qt_driver.frame_content = list(library.get_entries())
     qt_driver.selected = [0, 1, 2]
 
     panel = PreviewPanel(library, qt_driver)
@@ -50,13 +50,12 @@ def test_update_widgets_multiple_selected(qt_driver, library):
     }
 
 
-def test_write_container_text_line(qt_driver, library):
+def test_write_container_text_line(qt_driver, entry_full, library):
     # Given
     panel = PreviewPanel(library, qt_driver)
-    entry = next(library._entries_full)
 
-    field = entry.text_fields[0]
-    assert len(entry.text_fields) == 1
+    field = entry_full.text_fields[0]
+    assert len(entry_full.text_fields) == 1
     assert field.type.type == FieldTypeEnum.TEXT_LINE
     assert field.type.name == "Title"
 
@@ -77,42 +76,42 @@ def test_write_container_text_line(qt_driver, library):
     modal.save_button.click()
 
     # Then reload entry
-    entry = next(library._entries_full)
+    entry_full = next(library.get_entries(with_joins=True))
     # the value was updated
-    assert entry.text_fields[0].value == "bar"
+    assert entry_full.text_fields[0].value == "bar"
 
 
 def test_remove_field(qt_driver, library):
     # Given
     panel = PreviewPanel(library, qt_driver)
-    entries = list(library._entries_full)
+    entries = list(library.get_entries(with_joins=True))
     qt_driver.frame_content = entries
     panel.selected = [1]
 
     field = entries[1].text_fields[0]
     panel.write_container(0, field)
     panel.remove_field(field)
 
-    entries = list(library._entries_full)
+    entries = list(library.get_entries(with_joins=True))
     assert not entries[1].text_fields
 
 
 def test_update_field(qt_driver, library):
     panel = PreviewPanel(library, qt_driver)
 
-    qt_driver.frame_content = list(library._entries)[:2]
+    qt_driver.frame_content = list(library.get_entries())[:2]
     qt_driver.selected = [0, 1]
     panel.selected = [0, 1]
 
     field = [
         x
-        for x in next(library._entries_full).text_fields
+        for x in next(library.get_entries(with_joins=True)).text_fields
         if x.type.type == FieldTypeEnum.TEXT_LINE
     ][0]
 
     panel.update_field(field, "meow")
 
-    for entry in list(library._entries_full)[:2]:
+    for entry in library.get_entries(with_joins=True):
         field = [
             x for x in entry.text_fields if x.type.type == FieldTypeEnum.TEXT_LINE
         ][0]

tagstudio/tests/qt/test_tag_widget.py

@@ -1,6 +1,5 @@
 from unittest.mock import patch
 
-from src.core.library import Entry
 from src.core.library.alchemy.fields import _FieldID
 from src.qt.widgets.tag import TagWidget
 from src.qt.widgets.tag_box import TagBoxWidget
@@ -9,7 +8,7 @@
 
 def test_tag_widget(qtbot, library, qt_driver):
     # given
-    entry = next(library._entries_full)
+    entry = next(library.get_entries(with_joins=True))
     field = entry.tag_box_fields[0]
 
     tag_widget = TagBoxWidget(field, "title", qt_driver)
@@ -26,7 +25,7 @@ def test_tag_widget(qtbot, library, qt_driver):
 
 def test_tag_widget_add_existing_raises(qtbot, library, qt_driver):
     # Given
-    entry = next(library._entries_full)
+    entry = next(library.get_entries(with_joins=True))
     tag_field = [f for f in entry.tag_box_fields if f.type_key == _FieldID.TAGS.name][0]
 
     assert len(entry.tags) == 1
@@ -46,7 +45,7 @@ def test_tag_widget_add_existing_raises(qtbot, library, qt_driver):
 
 def test_tag_widget_add_new_pass(qtbot, library, qt_driver, generate_tag):
     # Given
-    entry = next(library._entries_full)
+    entry = next(library.get_entries(with_joins=True))
     field = entry.tag_box_fields[0]
 
     tag = generate_tag(name="new_tag")
@@ -65,14 +64,14 @@ def test_tag_widget_add_new_pass(qtbot, library, qt_driver, generate_tag):
         assert not mocked.emit.called
 
 
-def test_tag_widget_remove(qtbot, qt_driver):
-    entry: Entry = next(qt_driver.lib._entries_full)
-
-    tag = list(entry.tags)[0]
+def test_tag_widget_remove(qtbot, qt_driver, library, entry_full):
+    tag = list(entry_full.tags)[0]
     assert tag
 
-    assert entry.tag_box_fields
-    tag_field = [f for f in entry.tag_box_fields if f.type_key == _FieldID.TAGS.name][0]
+    assert entry_full.tag_box_fields
+    tag_field = [
+        f for f in entry_full.tag_box_fields if f.type_key == _FieldID.TAGS.name
+    ][0]
 
     tag_widget = TagBoxWidget(tag_field, "title", qt_driver)
     tag_widget.driver.selected = [0]
@@ -84,19 +83,19 @@ def test_tag_widget_remove(qtbot, qt_driver):
 
     tag_widget.remove_button.clicked.emit()
 
-    entry: Entry = next(qt_driver.lib._entries_full)
+    entry = next(qt_driver.lib.get_entries(with_joins=True))
     assert not entry.tag_box_fields[0].tags
 
 
-def test_tag_widget_edit(qtbot, qt_driver):
+def test_tag_widget_edit(qtbot, qt_driver, library, entry_full):
     # Given
-    entry: Entry = next(qt_driver.lib._entries_full)
-
-    tag = list(entry.tags)[0]
+    tag = list(entry_full.tags)[0]
     assert tag
 
-    assert entry.tag_box_fields
-    tag_field = [f for f in entry.tag_box_fields if f.type_key == _FieldID.TAGS.name][0]
+    assert entry_full.tag_box_fields
+    tag_field = [
+        f for f in entry_full.tag_box_fields if f.type_key == _FieldID.TAGS.name
+    ][0]
 
     tag_box_widget = TagBoxWidget(tag_field, "title", qt_driver)
     tag_box_widget.driver.selected = [0]

tagstudio/tests/test_folders_tags.py

@@ -3,5 +3,7 @@
 
 def test_folders_to_tags(library):
     folders_to_tags(library)
-    entry = [x for x in library._entries_full if "bar.md" in str(x.path)][0]
+    entry = [
+        x for x in library.get_entries(with_joins=True) if "bar.md" in str(x.path)
+    ][0]
     assert {x.name for x in entry.tags} == {"two", "bar"}