change LibraryPrefs to allow identical values, add test

Author: yedpodtrzitko

tagstudio/src/core/constants.py

@@ -1,5 +1,3 @@
-from enum import Enum
-
 VERSION: str = "9.3.2"  # Major.Minor.Patch
 VERSION_BRANCH: str = ""  # Usually "" or "Pre-Release"
 
@@ -123,11 +121,3 @@
 
 TAG_FAVORITE = 1
 TAG_ARCHIVED = 0
-
-
-class LibraryPrefs(Enum):
-    IS_EXCLUDE_LIST: bool = True
-    EXTENSION_LIST: list[str] = ["json", "xmp", "aae"]
-    PAGE_SIZE: int = 500
-    # increase in case of db breaking change (for now)
-    DB_VERSION: int = 2

tagstudio/src/core/enums.py

@@ -1,4 +1,6 @@
 import enum
+from typing import Any
+from uuid import uuid4
 
 
 class SettingItems(str, enum.Enum):
@@ -31,3 +33,31 @@ class MacroID(enum.Enum):
     BUILD_URL = "build_url"
     MATCH = "match"
     CLEAN_URL = "clean_url"
+
+
+class DefaultEnum(enum.Enum):
+    """Allow saving multiple identical values in property called .default."""
+
+    default: Any
+
+    def __new__(cls, value):
+        # Create the enum instance
+        obj = object.__new__(cls)
+        # make value random
+        obj._value_ = uuid4()
+        # assign the actual value into .default property
+        obj.default = value
+        return obj
+
+    @property
+    def value(self):
+        raise AttributeError("access the value via .default property instead")
+
+
+class LibraryPrefs(DefaultEnum):
+    """Library preferences with default value accessible via .default property."""
+
+    IS_EXCLUDE_LIST = True
+    EXTENSION_LIST: list[str] = [".json", ".xmp", ".aae"]
+    PAGE_SIZE: int = 500
+    DB_VERSION: int = 2

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

@@ -1,5 +1,6 @@
 import re
 import shutil
+import sys
 import unicodedata
 from dataclasses import dataclass
 from datetime import UTC, datetime
@@ -34,8 +35,8 @@
     TAG_ARCHIVED,
     TAG_FAVORITE,
     TS_FOLDER_NAME,
-    LibraryPrefs,
 )
+from ...enums import LibraryPrefs
 from .db import make_tables
 from .enums import FieldTypeEnum, FilterState, TagColor
 from .fields import (
@@ -164,9 +165,24 @@ def open_library(self, library_dir: Path, storage_path: str | None = None) -> Li
                 # default tags may exist already
                 session.rollback()
 
+            if "pytest" not in sys.modules:
+                db_version = session.scalar(
+                    select(Preferences).where(Preferences.key == LibraryPrefs.DB_VERSION.name)
+                )
+
+                if not db_version:
+                    # TODO - remove after #503 is merged and LibraryPrefs.DB_VERSION increased again
+                    return LibraryStatus(
+                        success=False,
+                        message=(
+                            "Library version mismatch.\n"
+                            f"Found: v0, expected: v{LibraryPrefs.DB_VERSION.default}"
+                        ),
+                    )
+
             for pref in LibraryPrefs:
                 try:
-                    session.add(Preferences(key=pref.name, value=pref.value))
+                    session.add(Preferences(key=pref.name, value=pref.default))
                     session.commit()
                 except IntegrityError:
                     logger.debug("preference already exists", pref=pref)
@@ -192,18 +208,18 @@ def open_library(self, library_dir: Path, storage_path: str | None = None) -> Li
                 select(Preferences).where(Preferences.key == LibraryPrefs.DB_VERSION.name)
             )
             # if the db version is different, we cant proceed
-            if db_version.value != LibraryPrefs.DB_VERSION.value:
+            if db_version.value != LibraryPrefs.DB_VERSION.default:
                 logger.error(
                     "DB version mismatch",
                     db_version=db_version.value,
-                    expected=LibraryPrefs.DB_VERSION.value,
+                    expected=LibraryPrefs.DB_VERSION.default,
                 )
                 # TODO - handle migration
                 return LibraryStatus(
                     success=False,
                     message=(
                         "Library version mismatch.\n"
-                        f"Found: v{db_version.value}, expected: v{LibraryPrefs.DB_VERSION.value}"
+                        f"Found: v{db_version.value}, expected: v{LibraryPrefs.DB_VERSION.default}"
                     ),
                 )
 

tagstudio/src/qt/modals/file_extension.py

@@ -16,7 +16,7 @@
     QVBoxLayout,
     QWidget,
 )
-from src.core.constants import LibraryPrefs
+from src.core.enums import LibraryPrefs
 from src.core.library import Library
 from src.qt.widgets.panel import PanelWidget
 

tagstudio/src/qt/ts_qt.py

@@ -61,10 +61,9 @@
     TAG_FAVORITE,
     VERSION,
     VERSION_BRANCH,
-    LibraryPrefs,
 )
 from src.core.driver import DriverMixin
-from src.core.enums import MacroID, SettingItems
+from src.core.enums import LibraryPrefs, MacroID, SettingItems
 from src.core.library.alchemy.enums import (
     FieldTypeEnum,
     FilterState,

tagstudio/tests/macros/test_refresh_dir.py

@@ -2,7 +2,8 @@
 from tempfile import TemporaryDirectory
 
 import pytest
-from src.core.constants import LibraryPrefs
+from src.core.enums import LibraryPrefs
+from src.core.library import Entry
 from src.core.utils.refresh_dir import RefreshDirTracker
 
 CWD = pathlib.Path(__file__).parent

tagstudio/tests/test_library.py

@@ -2,7 +2,7 @@
 from tempfile import TemporaryDirectory
 
 import pytest
-from src.core.constants import LibraryPrefs
+from src.core.enums import DefaultEnum, LibraryPrefs
 from src.core.library.alchemy import Entry
 from src.core.library.alchemy.enums import FilterState
 from src.core.library.alchemy.fields import TextField, _FieldID
@@ -197,7 +197,7 @@ def test_search_library_case_insensitive(library):
 
 def test_preferences(library):
     for pref in LibraryPrefs:
-        assert library.prefs(pref) == pref.value
+        assert library.prefs(pref) == pref.default
 
 
 def test_save_windows_path(library, generate_tag):
@@ -383,3 +383,21 @@ def test_update_field_order(library, entry_full):
     assert entry.text_fields[0].value == "first"
     assert entry.text_fields[1].position == 1
     assert entry.text_fields[1].value == "second"
+
+
+def test_library_prefs_multiple_identical_vals():
+    # check the preferences are inherited from DefaultEnum
+    assert issubclass(LibraryPrefs, DefaultEnum)
+
+    # create custom settings with identical values
+    class TestPrefs(DefaultEnum):
+        FOO = 1
+        BAR = 1
+
+    assert TestPrefs.FOO.default == 1
+    assert TestPrefs.BAR.default == 1
+    assert TestPrefs.BAR.name == "BAR"
+
+    # accessing .value should raise exception
+    with pytest.raises(AttributeError):
+        assert TestPrefs.BAR.value