refactor: use proper type instead of dict for file stats

Author: Computerdores

src/tagstudio/qt/controller/widgets/preview/preview_thumb_controller.py

@@ -14,6 +14,7 @@
 from tagstudio.qt.helpers.file_opener import open_file
 from tagstudio.qt.helpers.file_tester import is_readable_video
 from tagstudio.qt.view.widgets.preview.preview_thumb_view import PreviewThumbView
+from tagstudio.qt.widgets.preview.file_attributes import FileAttributeData
 
 if TYPE_CHECKING:
     from tagstudio.qt.ts_qt import QtDriver
@@ -27,18 +28,18 @@ class PreviewThumb(PreviewThumbView):
     def __init__(self, library: Library, driver: "QtDriver"):
         super().__init__(library, driver)
 
-    def __get_image_stats(self, filepath: Path) -> dict[str, int]:
+    def __get_image_stats(self, filepath: Path) -> FileAttributeData:
         """Get width and height of an image as dict."""
-        stats: dict[str, int] = {}
+        stats = FileAttributeData()
         ext = filepath.suffix.lower()
 
         if MediaCategories.IMAGE_RAW_TYPES.contains(ext, mime_fallback=True):
             try:
                 with rawpy.imread(str(filepath)) as raw:
                     rgb = raw.postprocess()
                     image = Image.new("L", (rgb.shape[1], rgb.shape[0]), color="black")
-                    stats["width"] = image.width
-                    stats["height"] = image.height
+                    stats.width = image.width
+                    stats.height = image.height
             except (
                 rawpy._rawpy._rawpy.LibRawIOError,  # pyright: ignore[reportAttributeAccessIssue]
                 rawpy._rawpy.LibRawFileUnsupportedError,  # pyright: ignore[reportAttributeAccessIssue]
@@ -48,8 +49,8 @@ def __get_image_stats(self, filepath: Path) -> dict[str, int]:
         elif MediaCategories.IMAGE_RASTER_TYPES.contains(ext, mime_fallback=True):
             try:
                 image = Image.open(str(filepath))
-                stats["width"] = image.width
-                stats["height"] = image.height
+                stats.width = image.width
+                stats.height = image.height
             except (
                 DecompressionBombError,
                 FileNotFoundError,
@@ -62,7 +63,7 @@ def __get_image_stats(self, filepath: Path) -> dict[str, int]:
 
         return stats
 
-    def display_file(self, filepath: Path) -> dict[str, int]:
+    def display_file(self, filepath: Path) -> FileAttributeData:
         """Render a single file preview."""
         self.__current_file = filepath
 

src/tagstudio/qt/view/widgets/preview/preview_thumb_view.py

@@ -19,6 +19,7 @@
 from tagstudio.qt.platform_strings import open_file_str, trash_term
 from tagstudio.qt.translations import Translations
 from tagstudio.qt.widgets.media_player import MediaPlayer
+from tagstudio.qt.widgets.preview.file_attributes import FileAttributeData
 from tagstudio.qt.widgets.thumb_renderer import ThumbRenderer
 
 if TYPE_CHECKING:
@@ -249,37 +250,37 @@ def __update_media_player(self, filepath: Path) -> int:
         self.__media_player.play(filepath)
         return self.__media_player.player.duration() * 1000
 
-    def _display_video(self, filepath: Path) -> dict[str, int]:
+    def _display_video(self, filepath: Path) -> FileAttributeData:
         self.__switch_preview(MediaType.VIDEO)
-        stats = {"duration": self.__update_media_player(filepath)}
+        stats = FileAttributeData(duration=self.__update_media_player(filepath))
 
         try:
             success, size = self.__get_video_res(str(filepath))
             if success:
-                self.__image_ratio = size.width() / size.height()
+                stats.width = size.width()
+                stats.height = size.height()
+
+                self.__image_ratio = stats.width / stats.height
                 self.resizeEvent(
                     QResizeEvent(
-                        QSize(size.width(), size.height()),
-                        QSize(size.width(), size.height()),
+                        QSize(stats.width, stats.height),
+                        QSize(stats.width, stats.height),
                     )
                 )
-
-                stats["width"] = size.width()
-                stats["height"] = size.height()
         except cv2.error as e:
             logger.error("[PreviewThumb] Could not play video", filepath=filepath, error=e)
 
         return stats
 
-    def _display_audio(self, filepath: Path) -> dict[str, int]:
+    def _display_audio(self, filepath: Path) -> FileAttributeData:
         self.__switch_preview(MediaType.AUDIO)
         self.__render_thumb(filepath)
-        return {"duration": self.__update_media_player(filepath)}
+        return FileAttributeData(duration=self.__update_media_player(filepath))
 
-    def _display_animated_image(self, filepath: Path) -> dict[str, int] | None:
+    def _display_animated_image(self, filepath: Path) -> FileAttributeData | None:
         """Update the animated image preview from a filepath."""
         ext = filepath.suffix.lower()
-        stats: dict[str, int] = {}
+        stats = FileAttributeData()
 
         # Ensure that any movie and buffer from previous animations are cleared.
         if self.__preview_gif.movie():
@@ -288,8 +289,8 @@ def _display_animated_image(self, filepath: Path) -> dict[str, int] | None:
 
         try:
             image: Image.Image = Image.open(filepath)
-            stats["width"] = image.width
-            stats["height"] = image.height
+            stats.width = image.width
+            stats.height = image.height
 
             self.__image_ratio = image.width / image.height
             if ext == ".apng":
@@ -321,13 +322,13 @@ def _display_animated_image(self, filepath: Path) -> dict[str, int] | None:
             self.__switch_preview(MediaType.IMAGE_ANIMATED)
             self.resizeEvent(
                 QResizeEvent(
-                    QSize(stats["width"], stats["height"]),
-                    QSize(stats["width"], stats["height"]),
+                    QSize(stats.width, stats.height),
+                    QSize(stats.width, stats.height),
                 )
             )
             movie.start()
 
-            stats["duration"] = movie.frameCount() // 60
+            stats.duration = movie.frameCount() // 60
         except (UnidentifiedImageError, FileNotFoundError) as e:
             logger.error("[PreviewThumb] Could not load animated image", filepath=filepath, error=e)
             return None

src/tagstudio/qt/view/widgets/preview_panel_view.py

@@ -22,7 +22,7 @@
 from tagstudio.qt.controller.widgets.preview.preview_thumb_controller import PreviewThumb
 from tagstudio.qt.translations import Translations
 from tagstudio.qt.widgets.preview.field_containers import FieldContainers
-from tagstudio.qt.widgets.preview.file_attributes import FileAttributes
+from tagstudio.qt.widgets.preview.file_attributes import FileAttributeData, FileAttributes
 
 if typing.TYPE_CHECKING:
     from tagstudio.qt.ts_qt import QtDriver
@@ -160,7 +160,7 @@ def set_selection(self, selected: list[int], update_preview: bool = True):
                 filepath: Path = self.lib.library_dir / entry.path
 
                 if update_preview:
-                    stats: dict = self.__thumb.display_file(filepath)
+                    stats: FileAttributeData = self.__thumb.display_file(filepath)
                     self.__file_attrs.update_stats(filepath, stats)
                 self.__file_attrs.update_date_label(filepath)
                 self._fields.update_from_entry(entry_id)

src/tagstudio/qt/widgets/preview/file_attributes.py

@@ -6,6 +6,7 @@
 import os
 import platform
 import typing
+from dataclasses import dataclass
 from datetime import datetime as dt
 from datetime import timedelta
 from pathlib import Path
@@ -29,6 +30,13 @@
 logger = structlog.get_logger(__name__)
 
 
+@dataclass
+class FileAttributeData:
+    width: int | None = None
+    height: int | None = None
+    duration: int | None = None
+
+
 class FileAttributes(QWidget):
     """The Preview Panel Widget."""
 
@@ -131,10 +139,10 @@ def update_date_label(self, filepath: Path | None = None) -> None:
             self.date_created_label.setHidden(True)
             self.date_modified_label.setHidden(True)
 
-    def update_stats(self, filepath: Path | None = None, stats: dict | None = None):
+    def update_stats(self, filepath: Path | None = None, stats: FileAttributeData | None = None):
         """Render the panel widgets with the newest data from the Library."""
         if not stats:
-            stats = {}
+            stats = FileAttributeData()
 
         if not filepath:
             self.layout().setSpacing(0)
@@ -179,16 +187,9 @@ def update_stats(self, filepath: Path | None = None, stats: dict | None = None):
             stats_label_text = ""
             ext_display: str = ""
             file_size: str = ""
-            width_px_text: str = ""
-            height_px_text: str = ""
-            duration_text: str = ""
             font_family: str = ""
 
             # Attempt to populate the stat variables
-            width_px_text = stats.get("width", "")
-            height_px_text = stats.get("height", "")
-            duration_text = stats.get("duration", "")
-            font_family = stats.get("font_family", "")
             ext_display = ext.upper()[1:] or filepath.stem.upper()
             if filepath:
                 try:
@@ -217,14 +218,14 @@ def add_newline(stats_label_text: str) -> str:
             elif file_size:
                 stats_label_text += file_size
 
-            if width_px_text and height_px_text:
+            if stats.width is not None and stats.height is not None:
                 stats_label_text = add_newline(stats_label_text)
-                stats_label_text += f"{width_px_text} x {height_px_text} px"
+                stats_label_text += f"{stats.width} x {stats.height} px"
 
-            if duration_text:
+            if stats.duration is not None:
                 stats_label_text = add_newline(stats_label_text)
                 try:
-                    dur_str = str(timedelta(seconds=float(duration_text)))[:-7]
+                    dur_str = str(timedelta(seconds=float(stats.duration)))[:-7]
                     if dur_str.startswith("0:"):
                         dur_str = dur_str[2:]
                     if dur_str.startswith("0"):