feat: immutable decorator

fix: legacy version file

DEVELOPERS.md

@@ -5,7 +5,7 @@
 ### Fetch submodules
 git submodule update --recursive --init
 
-### Install with dev dependencies
+### Install into editable venv with dev dependencies
 uv pip install -e '.[dev]'
 
 This includes all dependencies for building, linting, testing, and checking in code.
@@ -16,7 +16,7 @@ docs: documentation tools
 lint: code linting, fixing, and type checking
 test: unit and integration tests
 
-## Miscellaneous
+## Build process
 
 ### Setting up precommit hooks
 pre-commit install
@@ -25,6 +25,7 @@ pre-commit install
 sphinx-build -M html source build -a
 
 ### Building standalone release binaries
-1. Set up the build target: `rustup target add x86_64-unknown-linux-musl`
-2. Run `python3 scripts/release.py`
-3. Generate a release and tag against the resulting tarfile generated in `dist`
+1. Install the applicable system package containing the 'musl-gcc' wrapper
+2. Set up the build target: `rustup target add x86_64-unknown-linux-musl`
+3. Run `python3 scripts/release.py`
+4. Generate a release and tag against the resulting tarfile generated in `dist`

dzgui/api/mods.py

@@ -2,10 +2,9 @@ import hashlib
 import logging
 import re
 
-from concurrent.futures import wait
-from concurrent.futures import ThreadPoolExecutor
-from dataclasses import dataclass
+from concurrent.futures import ThreadPoolExecutor, wait
 from pathlib import Path
+from typing import Any
 
 from dzgui.api.steam import get_app_path
 from dzgui.api.servers import get_rules, fqip_to_record
@@ -18,8 +17,7 @@ from dzgui.const.constants import (
 
 from dzgui.config.query import lookup
 from dzgui.const.enum import Preferences
-
-from typing import Any
+from dzgui.init.migrate import clean_legacy_versions_file
 
 logger = logging.getLogger(APP_NAME)
 
@@ -117,10 +115,12 @@ def remove_stale_signatures(
     config: Path, versions: Path, ids: list[int] | None = None
 ) -> None:
     if versions.is_file() is False:
-        logger.warning("Creating new version signatures file")
+        logger.debug("Creating new version signatures file")
         versions.touch()
         return
 
+    clean_legacy_versions_file(versions)
+
     path = lookup(config, Preferences.DEFAULT)
     steam_path = Path(path)
     if ids is None:

dzgui/api/servers.py

@@ -13,6 +13,7 @@ from typing import Any, Optional, TYPE_CHECKING, Union
 
 from dzgui.const.constants import APP_NAME, REQUEST_TIMEOUT
 from dzgui.const.endpoints import STEAM_SERVERS
+from dzgui.model.proxy_model import ServerRow
 from dzgui.util.format import format_exception
 from dzgui.util import strings
 
@@ -141,7 +142,7 @@ def sanitize(name: str) -> str:
 
 def parse_json(
     json: list[dict[str, Any]],
-) -> list[tuple[str, str, str, str, int, int, int, str, int, int, str, bool]]:
+) -> list[ServerRow]:
     """
     Server metadata is underspecified and server operators
     tend to insert random garbage in the headers. In case
@@ -226,7 +227,7 @@ def parse_json(
         mapname = row["map"].lower()
         players = row["players"]
         max_players = row["max_players"]
-        raw = (
+        raw = ServerRow(
             name,
             mapname,
             view,

dzgui/app_init.py

@@ -6,7 +6,6 @@ from importlib import resources
 from pathlib import Path
 from typing import TYPE_CHECKING
 
-
 from dzgui.const.constants import (
     APP_NAME,
     APP_NAME_LOWER,
@@ -18,8 +17,8 @@ from dzgui.config.query import lookup
 from dzgui.config.userprefs import UserPrefs
 from dzgui.config.xdg import get_xdg_paths, parse_filepaths
 from dzgui.init.migrate import (
-    has_new_config,
     copy_state_files,
+    has_new_config,
     migrate_cols_file,
 )
 from dzgui.init.prereqs import has_flatpak_client, has_steam_client
@@ -107,7 +106,7 @@ def load_steam_icon() -> None:
     import gi
 
     gi.require_version("Gtk", "3.0")
-    from gi.repository import Gtk  # noqa
+    from gi.repository import Gtk
 
     try:
         traversable = resources.files(APP_NAME_LOWER).joinpath(ICONS_PATH)

dzgui/config/userprefs.py

@@ -6,7 +6,8 @@ if TYPE_CHECKING:
     from dzgui.util.ip import Coords
 
 
-# NOTE: mutable dataclass, 'use_miles' key changes on demand
+# NOTE: mutable dataclass: 'use_miles' key changes on demand
+# 'frozen' cannot be True
 @dataclass(slots=True)
 class UserPrefs:
     is_steam_deck: bool

dzgui/config/xdg.py

@@ -12,7 +12,7 @@ from dzgui.const.constants import (
 from dzgui.init.proc import is_sandboxed
 
 
-@dataclass
+@dataclass(slots=True, frozen=True)
 class Xdg:
     config: Path
     columns: Path

dzgui/controllers/mc.py

@@ -1,11 +1,11 @@
+import gi
 import logging
 import threading
 
 from typing import Any, TYPE_CHECKING, Union
 
-import dzgui.util._json as JSON  # noqa
-
-
+from dzgui.config.userprefs import UserPrefs
+from dzgui.const.constants import APP_NAME
 from dzgui.const.enum import (
     ButtonType,
     ContextMenuItem,
@@ -14,9 +14,6 @@ from dzgui.const.enum import (
     Preferences,
     ServerTab,
 )
-
-from dzgui.config.userprefs import UserPrefs
-from dzgui.const.constants import APP_NAME
 from dzgui.controllers.emitter import Emitter
 from dzgui.managers.config import ConfigManager
 from dzgui.managers.connection import ConnectionManager
@@ -29,8 +26,6 @@ from dzgui.util.open_links import open_user_workshop, open_workshop_page
 from dzgui.views.dialogs.filepicker import FilePicker
 from dzgui.views.dialogs.generic import ExceptionDialog
 
-import gi
-
 gi.require_version("Gtk", "3.0")
 from gi.repository import Gtk, Gdk, GLib, GObject
 

dzgui/init/migrate.py

@@ -1,12 +1,21 @@
 import json
+import logging
+import re
 import shutil
 
 from pathlib import Path
 from typing import Any
-from dzgui.const.constants import LEGACY_CONFIG_PATH, LEGACY_COLS_PATH, LEGACY_IPS_PATH
+from dzgui.const.constants import (
+    APP_NAME,
+    LEGACY_CONFIG_PATH,
+    LEGACY_COLS_PATH,
+    LEGACY_IPS_PATH,
+)
 from dzgui.config.convert import rc2json
 from dzgui.util._json import read_json, write_json
 
+logger = logging.getLogger(APP_NAME)
+
 
 def migrate_legacy_conf(config: Path) -> Any:
     old_conf = Path.home() / LEGACY_CONFIG_PATH
@@ -70,3 +79,15 @@ def copy_ipdb(ips_path: Path) -> None:
         return
     # TODO: ensure that month file is copied
     shutil.copy(legacy, ips_path)
+
+
+def clean_legacy_versions_file(versions: Path) -> None:
+    # NOTE: handling for #523
+    try:
+        pat = r"^(\d+),(\d+)$"
+        lines = versions.read_text().splitlines()
+        clean = [line for line in lines if re.match(pat, line)]
+        concat = "\n".join(clean)
+        versions.write_text(concat)
+    except Exception as e:
+        logger.warning(e)

dzgui/model/proxy_model.py

@@ -1,7 +1,8 @@
 import re
 
-from dataclasses import dataclass
-from typing import Any, TYPE_CHECKING, Union
+from dataclasses import dataclass, fields
+from operator import attrgetter
+from typing import TYPE_CHECKING
 
 from dzgui.const.enum import FilterMode
 from dzgui.model.model_factory import ModelFactory
@@ -33,6 +34,100 @@ class ServerRow:
     provider: str
     modded: bool
 
+    # NOTE: construct getter once for fast lookup in lieu of field introspection
+    _to_tuple = attrgetter(
+        "name",
+        "mapname",
+        "view",
+        "time",
+        "players",
+        "max_players",
+        "queue",
+        "ip",
+        "qport",
+        "ping",
+        "provider",
+        "modded",
+    )
+
+    @classmethod
+    def marshal_rows(
+        cls, rows: list["ServerRow"]
+    ) -> list[tuple[str, str, str, str, int, int, int, str, int, str, str, bool]]:
+        """Marshals data before passing into FastInsertListStore's extend() method"""
+        getter = cls._to_tuple
+        return [getter(row) for row in rows]
+
+
+class FiltrationManager:
+    def __init__(self) -> None:
+
+        self.filter_map = {
+            strings.filter_3pp: self.filter_3pp,
+            strings.filter_1pp: self.filter_1pp,
+            strings.filter_official: self.filter_official,
+            strings.filter_unofficial: self.filter_unofficial,
+            strings.filter_empty: self.filter_empty,
+            strings.filter_full: self.filter_full,
+            strings.filter_duplicate: self.filter_duplicate,
+            strings.filter_day: self.filter_day,
+            strings.filter_night: self.filter_night,
+            strings.filter_nonascii: self.filter_nonascii,
+            strings.filter_lowpop: self.filter_lowpop,
+            strings.filter_modded: self.filter_modded,
+            strings.filter_unmodded: self.filter_unmodded,
+        }
+
+    def filter_3pp(self, rows: list[ServerRow]) -> list[ServerRow]:
+        return [row for row in rows if row.view != strings.filter_3pp]
+
+    def filter_1pp(self, rows: list[ServerRow]) -> list[ServerRow]:
+        return [row for row in rows if row.view != strings.filter_1pp]
+
+    def filter_official(self, rows: list[ServerRow]) -> list[ServerRow]:
+        return [row for row in rows if row.provider != strings.filter_official]
+
+    def filter_unofficial(self, rows: list[ServerRow]) -> list[ServerRow]:
+        return [row for row in rows if row.provider != strings.filter_unofficial]
+
+    def filter_empty(self, rows: list[ServerRow]) -> list[ServerRow]:
+        return [row for row in rows if row.players != 0]
+
+    def filter_full(self, rows: list[ServerRow]) -> list[ServerRow]:
+        return [row for row in rows if row.players != row.max_players]
+
+    def filter_duplicate(self, rows: list[ServerRow]) -> list[ServerRow]:
+        seen = set()
+        final = []
+        for row in rows:
+            if row.name not in seen:
+                seen.add(row.name)
+                final.append(row)
+        rows = final
+        return rows
+
+    def filter_day(self, rows: list[ServerRow]) -> list[ServerRow]:
+        return [row for row in rows if not re.match(DAY_REG, row.time)]
+
+    def filter_night(self, rows: list[ServerRow]) -> list[ServerRow]:
+        return [row for row in rows if not re.match(NIGHT_REG, row.time)]
+
+    def filter_nonascii(self, rows: list[ServerRow]) -> list[ServerRow]:
+        return [row for row in rows if row.name.isascii()]
+
+    def filter_lowpop(self, rows: list[ServerRow]) -> list[ServerRow]:
+        return [row for row in rows if (row.players / row.max_players * 100) > 30]
+
+    def filter_modded(self, rows: list[ServerRow]) -> list[ServerRow]:
+        return [row for row in rows if not row.modded]
+
+    def filter_unmodded(self, rows: list[ServerRow]) -> list[ServerRow]:
+        return [row for row in rows if row.modded]
+
+    def filter(self, filter_type: str, rows: list[ServerRow]) -> list[ServerRow]:
+        func = self.filter_map[filter_type]
+        return func(rows)
+
 
 class ProxyModelManager:
     """
@@ -49,19 +144,15 @@ class ProxyModelManager:
     def __init__(self, filter_man: "FilterManager") -> None:
         self.filter_cache: dict[
             tuple[str, ...],
-            list[tuple[str, str, str, str, int, int, int, str, int, int, str, bool]],
+            list[ServerRow],
         ] = {}
 
         self.proxy_model: "FastInsertListStore"
         self.filter_man = filter_man
+        self.filtration_manager = FiltrationManager()
 
-        self.control_model: (
-            list[tuple[str, str, str, str, int, int, int, str, int, int, str, bool]]
-            | None
-        ) = None
-        self.filtered: list[
-            tuple[str, str, str, str, int, int, int, str, int, int, str, bool]
-        ] = []
+        self.control_model: list[ServerRow] | None = None
+        self.filtered: list[ServerRow] = []
         self.success = True
 
     def has_control_model(self) -> bool:
@@ -69,9 +160,7 @@ class ProxyModelManager:
             return False
         return True
 
-    def append_row_to_control(
-        self, row: tuple[str, str, str, str, int, int, int, str, int, int, str, bool]
-    ) -> None:
+    def append_row_to_control(self, row: ServerRow) -> None:
         if self.control_model is None:
             raise AttributeError("Trying to add rows to a non-existent model")
         self.control_model.append(row)
@@ -79,21 +168,24 @@ class ProxyModelManager:
 
     def update_playercount(self, playercount: "NewPlayerCount") -> None:
         treeiter = playercount.treeiter
-        self.proxy_model[treeiter][4] = playercount.players
-        self.proxy_model[treeiter][6] = playercount.queue
+        field = [f.name for f in fields(ServerRow)]
+        index_players = field.index("players")
+        index_queue = field.index("queue")
+        self.proxy_model[treeiter][index_players] = playercount.players
+        self.proxy_model[treeiter][index_queue] = playercount.queue
 
     def append_row_to_history(
         self,
-        history: tuple[str, str, str, str, int, int, int, str, int, int, str, bool],
+        history: ServerRow,
     ) -> None:
-        addr = history[7]
-        qport = history[8]
+        addr = history.ip
+        qport = history.qport
 
         if self.control_model is None:
             raise AttributeError("Trying to append row to empty model")
         found = False
         for i, row in enumerate(self.control_model):
-            if addr == row[7] and qport == row[8]:
+            if addr == row.ip and qport == row.qport:
                 item = self.control_model.pop(i)
                 self.control_model.append(item)
                 found = True
@@ -102,6 +194,7 @@ class ProxyModelManager:
         if found is False:
             self.control_model.append(history)
 
+        # NOTE: truncate history to 10 records max
         if len(self.control_model) == 11:
             del self.control_model[0]
 
@@ -113,7 +206,7 @@ class ProxyModelManager:
         addr = f"{record.ip}:{record.gameport}"
         qport = record.qport
         for row in self.control_model:
-            if addr == row[7] and qport == row[8]:
+            if addr == row.ip and qport == row.qport:
                 self.control_model.remove(row)
                 break
         self.wipe_cache()
@@ -122,19 +215,22 @@ class ProxyModelManager:
     def clear_proxy_model(self) -> None:
         self.proxy_model.clear()
 
-    def get_proxy_model(self) -> Union["FastInsertListStore", None]:
+    def get_proxy_model(self) -> "FastInsertListStore | None":
         if hasattr(self, "proxy_model"):
             return self.proxy_model
         return None
 
     def filter(
         self, mode: FilterMode, skip_cache: bool = False
-    ) -> Union["FastInsertListStore", None]:
+    ) -> "FastInsertListStore | None":
         """
         Native Gtk.TreeView.refilter() method was not performant enough
         when running in the main loop with 40k+ records
 
         skip_cache: used when updating a record on Saved Servers/History and forcing a refilter
+
+        NOTE: data must be marshalled from ServerRow format before constructing list stores
+        The "clone" is the proxy model (list of tuples) actually fed into Gtk.TreeView
         """
         # TODO: filter cache: return a dataclass object with clearly enumerated map, keyword, and filter values
         # instead of just a serial list of strings
@@ -143,8 +239,9 @@ class ProxyModelManager:
         if skip_cache is False:
             if filters in self.filter_cache:
                 cached_rows = self.filter_cache[filters]
+                marshalled_rows = ServerRow.marshal_rows(cached_rows)
                 clone = ModelFactory().make_server_store()
-                clone.extend(cached_rows)
+                clone.extend(marshalled_rows)
                 self.set_proxy_model(clone)
                 self.set_filtered(cached_rows)
                 return None
@@ -163,17 +260,18 @@ class ProxyModelManager:
         clone = ModelFactory().make_server_store()
         if len(rows) > 0:
             rows = self.sort_rows(rows)
-            clone.extend(rows)
+            marshalled_rows = ServerRow.marshal_rows(rows)
+            clone.extend(marshalled_rows)
 
         self.set_cache(filters, rows)
         self.set_proxy_model(clone)
         return clone
 
-    def sort_rows(self, rows: list) -> list:
-        rows.sort(key=lambda x: re.sub(r"[^A-Za-z0-9]+", "", x[0].lower()))
+    def sort_rows(self, rows: list[ServerRow]) -> list[ServerRow]:
+        rows.sort(key=lambda x: re.sub(r"[^A-Za-z0-9]+", "", x.name.lower()))
         return rows
 
-    def filter_initial(self, filters: tuple) -> list:
+    def filter_initial(self, filters: tuple[str, ...]) -> list[ServerRow]:
         """
         Simply culls the control model of any disabled filters
         """
@@ -182,7 +280,7 @@ class ProxyModelManager:
             self.set_filtered(self.filter_toggle_off(filters, f))
         return self.filtered
 
-    def filter_map(self, filters: tuple) -> list:
+    def filter_map(self, filters: tuple[str, ...]) -> list[ServerRow]:
         """
         Multi-filtration for any context starts by narrowing by map
         """
@@ -192,10 +290,10 @@ class ProxyModelManager:
         if sel_map == str_filters.all_maps:
             return rows
 
-        rows = [row for row in rows if row[1] == sel_map]
+        rows = [row for row in rows if row.mapname == sel_map]
         return rows
 
-    def filter_keyword(self, filters: tuple) -> list:
+    def filter_keyword(self, filters: tuple[str, ...]) -> list[ServerRow]:
         keyword = self.filter_man.get_active_keyword()
         rows = self.filtered
 
@@ -205,13 +303,15 @@ class ProxyModelManager:
         filtered = [
             row
             for row in rows
-            if keyword in row[0].lower()
-            or keyword in row[1].lower()
-            or keyword in row[7].lower()
+            if keyword in row.name.lower()
+            or keyword in row.mapname.lower()
+            or keyword in row.ip.lower()
         ]
         return filtered
 
-    def filter_toggle_off(self, filters: tuple, filter_type: str) -> list:
+    def filter_toggle_off(
+        self, filters: tuple[str, ...], filter_type: str
+    ) -> list[ServerRow]:
         """
         Sub-filtration of the current model
         """
@@ -225,43 +325,11 @@ class ProxyModelManager:
                 self.set_filtered(None)
                 return []
 
-        rows = self.filtered
-        match filter_type:
-            case strings.filter_3pp:
-                rows = [row for row in rows if row[2] != strings.filter_3pp]
-            case strings.filter_1pp:
-                rows = [row for row in rows if row[2] != strings.filter_1pp]
-            case strings.filter_official:
-                rows = [row for row in rows if row[10] != strings.filter_official]
-            case strings.filter_unofficial:
-                rows = [row for row in rows if row[10] != strings.filter_unofficial]
-            case strings.filter_empty:
-                rows = [row for row in rows if row[4] != 0]
-            case strings.filter_full:
-                rows = [row for row in rows if row[4] != row[5]]
-            case strings.filter_duplicate:
-                seen = set()
-                final = []
-                for row in rows:
-                    if row[0] not in seen:
-                        seen.add(row[0])
-                        final.append(row)
-                rows = final
-            case strings.filter_day:
-                rows = [row for row in rows if not re.match(DAY_REG, row[3])]
-            case strings.filter_night:
-                rows = [row for row in rows if not re.match(NIGHT_REG, row[3])]
-            case strings.filter_nonascii:
-                rows = [row for row in rows if row[0].isascii()]
-            case strings.filter_lowpop:
-                rows = [row for row in rows if (row[4] / row[5] * 100) > 30]
-            case strings.filter_modded:
-                rows = [row for row in rows if not row[11]]
-            case strings.filter_unmodded:
-                rows = [row for row in rows if row[11]]
+        # TODO: pack filter type enum in filter checkbox, rather than stringwise comparison
+        rows = self.filtration_manager.filter(filter_type, self.filtered)
         return rows
 
-    def filter_toggle_on(self, filters: tuple[str, ...]) -> list:
+    def filter_toggle_on(self, filters: tuple[str, ...]) -> list[ServerRow]:
         """Effectively applies all filters"""
         self.set_filtered(self.control_model)
         self.set_filtered(self.filter_map(filters))
@@ -272,31 +340,36 @@ class ProxyModelManager:
             self.set_filtered(self.filter_toggle_off(filters, f))
         return self.filtered
 
-    def set_cache(self, filters: tuple[str, ...], filtered_rows: list[tuple]) -> None:
+    def set_cache(
+        self, filters: tuple[str, ...], filtered_rows: list[ServerRow]
+    ) -> None:
         self.filter_cache[filters] = filtered_rows
 
-    def set_filtered(self, rows: list | None) -> None:
+    def set_filtered(self, rows: list[ServerRow] | None) -> None:
         if rows is None:
             self.filtered = []
         else:
             self.filtered = rows
 
-    def get_filtered(self) -> list:
+    def get_filtered(self) -> list[ServerRow]:
         return self.filtered
 
     def set_proxy_model(self, model: "FastInsertListStore") -> None:
         """
         FastInsertListStore representation of the raw model after filtration
+
+        This attribute is saved from within a thread so that it later be retrieved
+        and safely packed into the TreeView in the main loop, cf. get_proxy_model()
         """
         self.proxy_model = model
 
-    def set_control(self, rows: list) -> None:
+    def set_control(self, rows: list[ServerRow]) -> None:
         """
         Raw data model prior to filtration
         """
         self.control_model = rows
 
-    def get_control(self) -> list[Any]:
+    def get_control(self) -> list[ServerRow]:
         if self.control_model is None:
             raise AttributeError(
                 "Expected a populated control model, but it is Nonetype"
@@ -307,7 +380,7 @@ class ProxyModelManager:
         self.filtered = []
         self.filter_cache = {}
 
-    def push(self, data: list[Any]) -> None:
+    def push(self, data: list[ServerRow]) -> None:
         self.wipe_cache()
         self.set_control(data)
         cur_keyword = self.filter_man.get_active_keyword()

dzgui/model/servers.py

@@ -26,7 +26,7 @@ from gi.repository import Gtk, GLib
 if TYPE_CHECKING:
     from dzgui.api.servers import A2SInfo, Record
     from dzgui.controllers.mc import Controller
-    from dzgui.model.proxy_model import ProxyModelManager
+    from dzgui.model.proxy_model import ProxyModelManager, ServerRow
     from dzgui.views.trees.tree_servers import ServerTreeView
 
 logger = logging.getLogger(APP_NAME)
@@ -34,7 +34,7 @@ LAN_TIMEOUT = 0.5
 API_TIMEOUT = 3
 
 
-@dataclass
+@dataclass(slots=True, frozen=True)
 class NewPlayerCount:
     treeiter: Gtk.TreeIter
     players: int
@@ -241,10 +241,7 @@ class ServerModelManager:
 
     def update_history(
         self,
-        rows: (
-            list[tuple[str, str, str, str, int, int, int, str, int, int, str, bool]]
-            | None
-        ) = None,
+        rows: list["ServerRow"] | None = None,
     ) -> None:
         proxy_man = self._get_proxy_man()
         if rows is not None:
@@ -267,7 +264,6 @@ class ServerModelManager:
         self.first_iteration = False
         self.emitter.emit("load_maps", store)
 
-    # TODO: dataclass for record rows; check for other dict annotations
     def add_to_history(self, data: tuple[dict[str, Any], "Record"]) -> None:
         row, record = data
         proxy_man = self._get_proxy_man()
@@ -457,13 +453,13 @@ class ServerModelManager:
             dialog.show_all()
             dialog.run()  # type: ignore[no-untyped-call]
 
-    def _push_data(self, data: list[Any]) -> None:
+    def _push_data(self, data: list["ServerRow"]) -> None:
         self._get_proxy_man().push(data)
         self._sort_unique_maps(data)
         self.thread_man.set_cleanup_func(StoredFunc(self._cleanup_on_success))
 
     def _sort_unique_maps(self, data: list[Any]) -> None:
-        u_maps = set([row[1] for row in data])
+        u_maps = set([row.mapname for row in data])
         self._set_new_maps(sorted(u_maps))
 
     def _set_new_maps(self, maps: list[str]) -> None:
@@ -477,7 +473,6 @@ class ServerModelManager:
 
     @call_on_thread(dialog.filtering)
     def refilter(self, mode: FilterMode) -> None:
-        # FIXME: causes two wait dialogs when map selection change signal emits after loading servers
         self.first_iteration = False
         proxy_man = self._get_proxy_man()
         proxy_man.filter(mode)

dzgui/util/diag.py

@@ -11,6 +11,7 @@ from dzgui.const.enum import Preferences
 from dzgui.config.query import lookup
 from dzgui.init.prefix import get_version
 from dzgui.util.redact import redact_home
+from dzgui.util.strings import unknown
 
 logger = logging.getLogger(APP_NAME)
 
@@ -27,28 +28,22 @@ def get_cpu_model() -> str:
 
 
 def print_servers(servers: list[str]) -> str:
-    s = ""
-    for server in servers:
-        s += server + "\n"
-    return s
+    return "\n".join(servers)
 
 
 def print_mods(mods: list[int]) -> str:
-    s = ""
-    for mod in mods:
-        s += str(mod) + "\n"
-    return s
+    return "\n".join(map(str, mods))
 
 
 def write_diagnostic(config: Path, outfile: Path) -> None:
     date = datetime.now().isoformat()
 
     try:
-        # FIXME: ID_LIKE not available on CachyOS
+        # NOTE: ID_LIKE not available on CachyOS
         distro = platform.freedesktop_os_release()["ID_LIKE"]
     except Exception as e:
         logger.warn(e)
-        distro = "Unknown"
+        distro = unknown
 
     kernel = os.uname().release
     cpu = get_cpu_model()
@@ -68,7 +63,6 @@ def write_diagnostic(config: Path, outfile: Path) -> None:
     servers = lookup(config, Preferences.IP_LIST)
     servers_pretty = print_servers(servers)
 
-    # FIXME: extraneous newlines in lists of mods
     template = f"""\
     {APP_NAME} version {version}
     Date: {date}
@@ -82,6 +76,7 @@ def write_diagnostic(config: Path, outfile: Path) -> None:
 
     Mods:
     {mods_pretty}
+
     Servers:
     {servers_pretty}
     """

dzgui/util/immutable.py

@@ -0,0 +1,9 @@
+from dataclasses import dataclass
+from typing import Callable
+
+def immutable_dataclass(cls: type | None = None, **kwargs: bool) -> type | Callable[[type], type]:
+    kwargs["slots"] = True
+    kwargs["frozen"] = True
+    if cls is None:
+        return lambda c: dataclass(c, **kwargs)
+    return dataclass(cls, **kwargs)

dzgui/util/ip.py

@@ -1,10 +1,10 @@
 import a2s
-from ipaddress import ip_address
 import requests
 import shutil
 import subprocess
 
 from dataclasses import dataclass
+from ipaddress import ip_address
 from typing import TYPE_CHECKING
 
 from dzgui.api.servers import Record
@@ -12,12 +12,11 @@ from dzgui.config.ipdb import read_from_table
 from dzgui.const.constants import REQUEST_TIMEOUT
 from dzgui.const.endpoints import IP_ECHO
 
-
 if TYPE_CHECKING:
     from pathlib import Path
 
 
-@dataclass
+@dataclass(slots=True, frozen=True)
 class Coords:
     lat: float
     lon: float

dzgui/views/components/box.py

@@ -1,9 +1,9 @@
-from typing import Sequence
-
 import gi
 
+from typing import Sequence
+
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk  # noqa
+from gi.repository import Gtk
 
 
 class GenericBox(Gtk.Box):

dzgui/views/components/buttons.py

@@ -1,4 +1,4 @@
-from typing import Callable, Literal, Self, TYPE_CHECKING, Union
+from typing import Callable, Literal, Self, TYPE_CHECKING
 
 from dzgui.util.clip import copy_clipboard
 from dzgui.strings import buttons

dzgui/views/components/frame.py

@@ -1,10 +1,11 @@
-from typing import Self
-from dzgui.util import css
-
 import gi
 
+from typing import Self
+
+from dzgui.util import css
+
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk  # noqa
+from gi.repository import Gtk
 
 
 # TODO: subclass Gtk.Frame directly

dzgui/views/components/misc.py

@@ -1,3 +1,4 @@
+import gi
 from typing import Self
 from warnings import deprecated
 
@@ -8,10 +9,8 @@ from dzgui.strings import options
 from dzgui.views.components.box import HBox
 from dzgui.views.components.buttons import Icon
 
-import gi
-
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk  # noqa
+from gi.repository import Gtk
 
 
 @deprecated("Client choice is determined at setup time")

dzgui/views/components/scrollable.py

@@ -1,7 +1,7 @@
 import gi
 
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk  # noqa
+from gi.repository import Gtk
 
 
 class NoOverlayScrolledWindow(Gtk.ScrolledWindow):

dzgui/views/dialogs/boot.py

@@ -1,13 +1,9 @@
+import gi
 import sys
+
+from enum import Enum
 from typing import Any, Literal, Self, TYPE_CHECKING
 
-# import time
-from enum import Enum
-
-
-from dzgui.views.mixins.colorscheme import ColorAwareApp
-
-# TODO: import dialog titles
 from dzgui.api.mods import remove_stale_signatures as remove_stale
 from dzgui.config.ipdb import get_ipdb
 from dzgui.const.constants import HEX_GREEN, HEX_RED
@@ -20,12 +16,10 @@ from dzgui.util.format import format_exception
 from dzgui.util.strings import dialog_header
 from dzgui.util.symlink import rebuild_symlinks
 from dzgui.views.components.buttons import ClipboardButton
-
-
-import gi
+from dzgui.views.mixins.colorscheme import ColorAwareApp
 
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk, GLib, Gdk  # noqa
+from gi.repository import Gtk, GLib, Gdk
 
 if TYPE_CHECKING:
     from dzgui.config.xdg import Xdg

dzgui/views/dialogs/servers.py

@@ -15,7 +15,7 @@ from dzgui.views.dialogs.generic import GenericDialog
 from dzgui.views.trees.tree_base import TreeView
 
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk, Gdk, Pango  # noqa
+from gi.repository import Gtk, Gdk, Pango
 
 if TYPE_CHECKING:
     from dzgui.api.servers import Details

dzgui/views/mixins/colorscheme.py

@@ -1,3 +1,5 @@
+import gi
+
 from typing import Any
 
 from dzgui.const.constants import (
@@ -7,10 +9,8 @@ from dzgui.const.constants import (
     GIO_SETTINGS_VAL,
 )
 
-import gi
-
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk, Gio  # noqa
+from gi.repository import Gtk, Gio
 
 
 class ColorAwareApp:

dzgui/views/mixins/help_menu_mixin.py

@@ -1,7 +1,7 @@
 import gi
 
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk, Gdk  # noqa
+from gi.repository import Gtk, Gdk
 
 
 class HelpMenuMixin:

dzgui/views/mixins/scrollable_mixin.py

@@ -1,10 +1,10 @@
+import gi
+
 from dzgui.const.enum import VAdjustment
 from dzgui.const.constants import SCROLL_INCREMENT
 
-import gi
-
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk, Gdk  # noqa
+from gi.repository import Gtk, Gdk
 
 
 class ScrollableMixin:

dzgui/views/pages/mods.py

@@ -1,3 +1,4 @@
+import gi
 from pathlib import Path
 
 from typing import Self, TYPE_CHECKING
@@ -8,10 +9,8 @@ from dzgui.views.components.buttons import SteamWorkshopButton
 from dzgui.views.components.scrollable import NoOverlayScrolledWindow
 from dzgui.views.trees.tree_mods import ModTreeView
 
-import gi
-
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk, Gdk  # noqa
+from gi.repository import Gtk
 
 if TYPE_CHECKING:
     from dzgui.controllers.mc import Controller

dzgui/views/pages/offline.py

@@ -1,9 +1,10 @@
 from __future__ import annotations
+
+import gi
+
 from enum import Enum
 from typing import Self, TYPE_CHECKING, Union
 
-from dzgui.util import css
-from dzgui.const.icons import ICON_EDIT_DELETE, ICON_FOLDER, ICON_WARNING
 from dzgui.const.constants import (
     APPID_DAYZ,
     APPID_DAYZ_EXP,
@@ -11,8 +12,10 @@ from dzgui.const.constants import (
     APPNAME_DAYZ_EXP_HUMAN,
 )
 from dzgui.const.enum import ContextMenuGroup, NotebookPage
+from dzgui.const.icons import ICON_EDIT_DELETE, ICON_FOLDER, ICON_WARNING
 from dzgui.managers.offline import OfflineManager
 from dzgui.strings import generic, offline
+from dzgui.util import css
 from dzgui.views.components.box import HBox, VBox
 from dzgui.views.components.buttons import Icon, IconTextButton
 from dzgui.views.components.eventbox import InfoEventBox
@@ -21,11 +24,8 @@ from dzgui.views.components.scrollable import NoOverlayScrolledWindow
 from dzgui.views.components.misc import ErrorPopover
 from dzgui.views.trees.tree_mods import OfflineModTreeView
 
-
-import gi
-
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk, Gdk, GObject  # noqa
+from gi.repository import Gtk, Gdk
 
 if TYPE_CHECKING:
     from dzgui.controllers.mc import Controller

dzgui/views/pages/options.py

@@ -1,9 +1,10 @@
+import gi
+
 from pathlib import Path
 from typing import Any, Callable, TYPE_CHECKING
 
 from dzgui.api import pefile as PeFile
 from dzgui.api.steam import get_last_updated
-
 from dzgui.config import query
 from dzgui.const.constants import (
     APPID_DAYZ,
@@ -14,12 +15,11 @@ from dzgui.const.constants import (
     FLATPAK_SANDBOX,
     FLATPAK_STEAM_PATH,
 )
-from dzgui.const.icons import ICON_VIEW_CONCEAL, ICON_VIEW_REVEAL
 from dzgui.const.endpoints import STEAM_API_SETUP
 from dzgui.const.enum import Preferences, ServerTab
+from dzgui.const.icons import ICON_VIEW_CONCEAL, ICON_VIEW_REVEAL
 from dzgui.strings import options
 from dzgui.util import strings, css, open_links
-
 from dzgui.views.components.box import ShortHBox, VBox
 from dzgui.views.components.eventbox import InfoEventBox
 from dzgui.views.components.labels import LeftLabel
@@ -29,11 +29,8 @@ from dzgui.views.components.misc import ErrorPopover
 from dzgui.views.dialogs.generic import ExceptionDialog
 from dzgui.views.mixins.scrollable_mixin import ScrollableMixin
 
-
-import gi
-
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk, Gdk  # noqa
+from gi.repository import Gtk, Gdk
 
 if TYPE_CHECKING:
     from dzgui.controllers.mc import Controller
@@ -233,10 +230,19 @@ class ToggleField(Gtk.Box):
         self.pack_start(self.radio1, expand=False, fill=False, padding=0)
         self.pack_start(self.radio2, expand=False, fill=False, padding=0)
 
+        self.signal_id: int | None = None
+
+    def disconnect_signal(self) -> None:
+        if self.signal_id is not None:
+            self.radio1.disconnect(self.signal_id)
+
     def set_suboption_active(self, state: bool) -> None:
         # NOTE: defer connection of signal until after state is set
         self.radio2.set_active(state)
-        self.radio1.connect("toggled", self._on_radio_toggled, self.context)
+        self.disconnect_signal()
+        self.signal_id = self.radio1.connect(
+            "toggled", self._on_radio_toggled, self.context
+        )
 
     def _on_radio_toggled(self, button: Gtk.RadioButton, context: Preferences) -> None:
         self.controller.toggle_config(context)
@@ -486,14 +492,5 @@ class Options(ScrollableMixin, Gtk.ScrolledWindow):  # type: ignore
         start_tab = self.controller.query_config(Preferences.START_TAB)
         self.start_tab_combo.set_active(start_tab)
 
-    def _suppress_toggles(self, state: bool) -> None:
-        for toggle in [
-            self.fullscreen_toggle,
-            self.distance_toggle,
-        ]:
-            self.controller.suppress_signal(
-                self, toggle.get_children()[0], "_on_radio_toggled", state
-            )
-
     def grab_content_area(self) -> None:
         self.grab_focus()

dzgui/views/pages/preconnect.py

@@ -1,11 +1,12 @@
-from dataclasses import dataclass
+import gi
+
 from typing import Self, Sequence, TYPE_CHECKING
 
+from dzgui.const.enum import NotebookPage
 from dzgui.const.icons import (
     ICON_ERROR,
     ICON_WARNING,
 )
-from dzgui.const.enum import NotebookPage
 from dzgui.util.css import add_class
 from dzgui.util.keys import is_ctrl_mask
 from dzgui.util.localize import number
@@ -15,33 +16,15 @@ from dzgui.views.dialogs.generic import DebugDialog
 from dzgui.views.components.frame import HeadingFrame
 from dzgui.views.trees.tree_server_mods import ServerModTreeView
 
-import gi
-
 gi.require_version("Gtk", "3.0")
 from gi.repository import Gdk, Gtk
 
-
 if TYPE_CHECKING:
     from dzgui.managers.connection import Prerequisites
     from dzgui.controllers.mc import Controller
     from dzgui.controllers.emitter import Emitter
 
 
-@dataclass
-class Warnings:
-    passworded: bool
-    dayz_running: bool
-    no_steam: bool
-    wrong_version: bool
-
-
-@dataclass
-class Errors:
-    no_space: bool
-    no_dayz_exp: bool
-    no_dayz: bool
-
-
 class Placeholder(Gtk.Label):
     def __init__(self, text: str) -> None:
         super().__init__(

dzgui/views/trees/tree_base.py

@@ -1,3 +1,4 @@
+import gi
 import logging
 
 from typing import Any, Optional, TYPE_CHECKING
@@ -6,10 +7,8 @@ from dzgui.const.constants import APP_NAME, SEPARATOR
 from dzgui.util.keys import is_ctrl_mask, is_navkey
 from dzgui.views.mixins.cursor_mixin import CursorMixin
 
-import gi
-
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk, GLib, Gdk, GObject, Pango  # noqa
+from gi.repository import Gtk, Gdk, GObject
 
 logger = logging.getLogger(APP_NAME)
 

dzgui/views/trees/tree_menu.py

@@ -10,7 +10,7 @@ from dzgui.views.trees.tree_base import TreeView
 import gi
 
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk, GLib, Gdk, GObject, Pango  # noqa
+from gi.repository import Gtk
 
 logger = logging.getLogger(APP_NAME)
 

dzgui/views/trees/tree_mods.py

@@ -1,4 +1,6 @@
+import gi
 import logging
+
 from typing import Any, TYPE_CHECKING
 
 from dzgui.const.constants import APP_NAME, HEX_RED
@@ -9,10 +11,8 @@ from dzgui.views.mixins.context_mixin import ContextMixin
 from dzgui.views.mixins.mods_mixin import ModsMixin
 from dzgui.views.trees.tree_base import TreeView
 
-import gi
-
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk, GLib, Gdk, GObject, Pango  # noqa
+from gi.repository import Gtk, Gdk
 
 
 if TYPE_CHECKING:

dzgui/views/trees/tree_server_mods.py

@@ -1,15 +1,15 @@
+import gi
+
+from typing import TYPE_CHECKING
+
 from dzgui.const.enum import ContextMenuGroup
 from dzgui.model.model_factory import ModelFactory
 from dzgui.strings import server_mods
 from dzgui.views.mixins.context_mixin import ContextMixin
 from dzgui.views.trees.tree_base import TreeView
 
-from typing import TYPE_CHECKING
-
-import gi
-
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk, GLib, Gdk, Pango  # noqa
+from gi.repository import Gtk, Pango
 
 if TYPE_CHECKING:
     from dzgui.controllers.mc import Controller

dzgui/views/trees/tree_servers.py

@@ -1,8 +1,9 @@
+import gi
 import logging
 import threading
 
 from queue import Queue
-from typing import Any, Self, Union
+from typing import Any, Literal, Self, TYPE_CHECKING, Union
 from warnings import deprecated
 
 from dzgui.api.servers import ping, Record
@@ -14,17 +15,11 @@ from dzgui.util import strings
 from dzgui.util.dist import CalcDist
 from dzgui.util.keys import is_ctrl_mask
 from dzgui.views.mixins.context_mixin import ContextMixin
-from typing import Literal, TYPE_CHECKING
-
-
 from dzgui.views.trees.tree_base import TreeView
 import dzgui.util._json as JSON  # noqa
 
-import gi
-
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk, GLib, Gdk, GObject, Pango  # noqa
-
+from gi.repository import Gtk, GLib, Gdk, GObject
 
 logger = logging.getLogger(APP_NAME)
 
@@ -413,5 +408,10 @@ class ServerTreeView(ContextMixin, TreeView):  # type: ignore
         if row_index >= start[0] <= end[0]:
             # NOTE: fetch raw data rows
             real_model = self.proxy_man.get_control()
-            value = real_model[row_index][col_index]
+            from dataclasses import fields
+            from dzgui.model.proxy_model import ServerRow
+
+            key = fields(ServerRow)[col_index].name
+
+            value = getattr(real_model[row_index], key)
             cell.set_property("text", str(value))

dzgui/views/trees/tree_simple.py

@@ -1,13 +1,13 @@
+import gi
+
 from typing import TYPE_CHECKING, Union
 
+gi.require_version("Gtk", "3.0")
+from gi.repository import Gtk
+
 if TYPE_CHECKING:
     from dzgui.model.model_factory import FastInsertListStore
 
-import gi
-
-gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk  # noqa
-
 
 class SimpleTree(Gtk.ScrolledWindow):
     """Simple scrollable 1-column tree"""

tests/test_colorscheme.py

@@ -1,13 +1,12 @@
+import gi
 import pytest
 import subprocess
 
 from dzgui.const.constants import GIO_SETTINGS_KEY
 from dzgui.views.mixins.colorscheme import ColorAwareApp
 
-import gi
-
 gi.require_version("Gtk", "3.0")
-from gi.repository import Gtk, Gio, GLib  # noqa
+from gi.repository import Gtk, GLib
 
 
 class DummyWidget(ColorAwareApp, Gtk.Button):

tests/test_legacy_version_file.py

@@ -0,0 +1,25 @@
+from typing import TYPE_CHECKING
+
+from dzgui.init.migrate import clean_legacy_versions_file
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+
+def test_null_signature_stripping(tmp_path: "Path") -> None:
+    tmp = tmp_path.joinpath("dzg.versions")
+    lines = [
+        "1111,2222",
+        "3333,4444",
+        "5555,null",
+        "foo",
+        ",4555",
+        "1111",
+        " ",
+        ",,,",
+        "-1",
+    ]
+    expect = ["1111,2222", "3333,4444"]
+    tmp.write_text("\n".join(lines))
+    clean_legacy_versions_file(tmp)
+    assert expect == tmp.read_text().splitlines()

tests/test_mod_signatures.py

@@ -48,5 +48,5 @@ def test_signatures_with_no_ids(monkeypatch, tmp: str, versions: str) -> None:
     monkeypatch.setattr("dzgui.api.mods.lookup", mock_lookup)
     dzgui.api.mods.remove_stale_signatures(path, path)
     with open(tmp, "r") as f:
-        lines = f.readlines()
-    assert lines == ["3410710885,1752864732\n", "3739934289,1780855136\n"]
+        lines = [line.rstrip() for line in f.readlines()]
+    assert lines == ["3410710885,1752864732", "3739934289,1780855136"]

tests/test_row_marshalling.py

@@ -0,0 +1,26 @@
+from dzgui.model.model_factory import ModelFactory
+from dzgui.model.proxy_model import ServerRow
+
+
+def test_row_conversion() -> None:
+    """Converted FastInsertListStore is expected to have identical elements"""
+    data = [
+        "Test Server",
+        "chernarusplus",
+        "1PP",
+        "05:00",
+        10,
+        10,
+        0,
+        "127.0.0.0:27016",
+        27017,
+        99,
+        "Unofficial",
+        False,
+    ]
+    rows = [ServerRow(*data)]
+    marshalled = ServerRow.marshal_rows(rows)
+    store = ModelFactory().make_server_store()
+    store.extend(marshalled)
+    converted = [[el for el in row] for row in store]
+    assert data == converted[0]