change: normalize icon names

dzgui/api/mods.py

@@ -2,10 +2,10 @@ import hashlib
 import logging
 import re
 
-from concurrent.futures import ThreadPoolExecutor, wait
+from concurrent.futures import wait
+from concurrent.futures import ThreadPoolExecutor
 from dataclasses import dataclass
 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,7 +18,8 @@ from dzgui.const.constants import (
 
 from dzgui.config.query import lookup
 from dzgui.const.enum import Preferences
-from dzgui.init.migrate import clean_legacy_versions_file
+
+from typing import Any
 
 logger = logging.getLogger(APP_NAME)
 
@@ -132,8 +133,6 @@ def remove_stale_signatures(
         versions.touch()
         return
 
-    clean_legacy_versions_file(versions)
-
     path = lookup(config, Preferences.DEFAULT)
     steam_path = Path(path)
     if ids is None:

dzgui/app_init.py

@@ -18,8 +18,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 (
-    copy_state_files,
     has_new_config,
+    copy_state_files,
     migrate_cols_file,
 )
 from dzgui.init.flock import lock_acquire

dzgui/config/userprefs.py

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

dzgui/const/constants.py

@@ -37,28 +37,6 @@ HEX_GREEN = "#32CD32"
 HEX_RED = "#FF0000"
 HEX_ORANGE = "#FFAC1C"
 
-# TODO: normalize icon names
-CALCULATOR = "accessories-calculator-symbolic"
-CARET_DOWN = "go-down-symbolic"
-CARET_UP = "go-up-symbolic"
-CLIPBOARD = "edit-copy-symbolic"
-CLOSE = "window-close-symbolic"
-FOLDER = "folder-symbolic"
-EDIT_DELETE = "edit-delete-symbolic"
-ERROR = "dialog-error-symbolic"
-HELP_BUBBLE = "help-about-symbolic"
-INPUT_KEYBOARD = "input-keyboard-symbolic"
-LIST_ADD = "list-add-symbolic"
-REFRESH_ICON = "view-refresh-symbolic"
-SEARCH_ICON = "system-search-symbolic"
-STEAM_ICON = "steam-tray-symbolic"
-VIEW_CONCEAL = "view-conceal-symbolic"
-VIEW_REVEAL = "view-reveal-symbolic"
-WARNING = "dialog-warning-symbolic"
-WEB_BROWSER = "web-browser-symbolic"
-DAY_ICON = "weather-clear-symbolic"
-NIGHT_ICON = "weather-clear-night-symbolic"
-
 SEPARATOR = "SEPARATOR"
 
 # TODO: drop

dzgui/const/icons.py

@@ -0,0 +1,20 @@
+ICON_CALCULATOR = "accessories-calculator-symbolic"
+ICON_CARET_DOWN = "go-down-symbolic"
+ICON_CARET_UP = "go-up-symbolic"
+ICON_CLIPBOARD = "edit-copy-symbolic"
+ICON_CLOSE = "window-close-symbolic"
+ICON_DAY = "weather-clear-symbolic"
+ICON_EDIT_DELETE = "edit-delete-symbolic"
+ICON_ERROR = "dialog-error-symbolic"
+ICON_FOLDER = "folder-symbolic"
+ICON_HELP_BUBBLE = "help-about-symbolic"
+ICON_INPUT_KEYBOARD = "input-keyboard-symbolic"
+ICON_LIST_ADD = "list-add-symbolic"
+ICON_NIGHT = "weather-clear-night-symbolic"
+ICON_REFRESH = "view-refresh-symbolic"
+ICON_SEARCH = "system-search-symbolic"
+ICON_STEAM = "steam-tray-symbolic"
+ICON_VIEW_CONCEAL = "view-conceal-symbolic"
+ICON_VIEW_REVEAL = "view-reveal-symbolic"
+ICON_WARNING = "dialog-warning-symbolic"
+ICON_WEB_BROWSER = "web-browser-symbolic"

dzgui/init/migrate.py

@@ -1,21 +1,12 @@
 import json
-import logging
-import re
 import shutil
 
 from pathlib import Path
 from typing import Any
-from dzgui.const.constants import (
-    APP_NAME,
-    LEGACY_CONFIG_PATH,
-    LEGACY_COLS_PATH,
-    LEGACY_IPS_PATH,
-)
+from dzgui.const.constants import 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
@@ -79,15 +70,3 @@ 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/views/components/buttons.py

@@ -7,15 +7,15 @@ from dzgui.util.strings import (
     alert_button_tooltip,
     atomic_buttons,
 )
-from dzgui.const.constants import (
-    CLIPBOARD,
-    CLOSE,
-    INPUT_KEYBOARD,
-    LIST_ADD,
-    REFRESH_ICON,
-    STEAM_ICON,
-    WARNING,
-    WEB_BROWSER,
+from dzgui.const.icons import (
+    ICON_CLIPBOARD,
+    ICON_CLOSE,
+    ICON_INPUT_KEYBOARD,
+    ICON_LIST_ADD,
+    ICON_REFRESH,
+    ICON_STEAM,
+    ICON_WARNING,
+    ICON_WEB_BROWSER,
 )
 from dzgui.strings import connect_panel
 
@@ -102,7 +102,7 @@ class LargeIconTextButton(IconButton):
 
 class ClipboardButton(IconTextButton):
     def __init__(self, controller: Union["Controller", None], func: Callable) -> None:
-        super().__init__(CLIPBOARD, atomic_buttons.copy)
+        super().__init__(ICON_CLIPBOARD, atomic_buttons.copy)
         self.controller = controller
         self.connect("clicked", self._on_button_clicked, func)
 
@@ -131,7 +131,7 @@ class CopyIpButton(ClipboardButton):
 
 class CloseButton(IconTextButton):
     def __init__(self, label: str) -> None:
-        super().__init__(icon=CLOSE, label=label)
+        super().__init__(icon=ICON_CLOSE, label=label)
 
         # TODO: strings
         self.set_tooltip_text("Unset this server as favorite")
@@ -139,14 +139,14 @@ class CloseButton(IconTextButton):
 
 class WebButton(IconTextButton):
     def __init__(self, label: str) -> None:
-        super().__init__(icon=WEB_BROWSER, label=label)
+        super().__init__(icon=ICON_WEB_BROWSER, label=label)
         pass
 
 
 class RefreshButton(IconTextButton):
     def __init__(self, controller: "Controller") -> None:
         super().__init__(
-            icon=REFRESH_ICON,
+            icon=ICON_REFRESH,
             label=atomic_buttons.refresh,
         )
 
@@ -211,7 +211,7 @@ class RefreshButton(IconTextButton):
 
 class KeysButton(IconTextButton):
     def __init__(self, controller: "Controller") -> None:
-        super().__init__(icon=INPUT_KEYBOARD, label=atomic_buttons.keys)
+        super().__init__(icon=ICON_INPUT_KEYBOARD, label=atomic_buttons.keys)
 
         self.controller = controller
         self.set_margin_top(10)
@@ -228,7 +228,7 @@ class KeysButton(IconTextButton):
 
 class SteamConnectButton(LargeIconTextButton):
     def __init__(self) -> None:
-        super().__init__(icon=STEAM_ICON, label=connect_panel.connect_button)
+        super().__init__(icon=ICON_STEAM, label=connect_panel.connect_button)
         self.set_tooltip_text(connect_panel.connect_tooltip)
 
 
@@ -248,7 +248,7 @@ class SteamWorkshopButton(SteamTextButton):
 
 class AddButton(IconTextButton):
     def __init__(self) -> None:
-        super().__init__(icon=LIST_ADD, label=connect_panel.add_button)
+        super().__init__(icon=ICON_LIST_ADD, label=connect_panel.add_button)
         self.set_tooltip_text(connect_panel.add_tooltip)
 
 
@@ -267,7 +267,7 @@ class LoggerAlertsButton(IconTextButton):
             separator = ","
         concat = warnings_text + separator + errors_text
         super().__init__(
-            icon=WARNING,
+            icon=ICON_WARNING,
             label=f"Loaded with{concat}",
         )
         self.set_halign(Gtk.Align.END)

dzgui/views/components/connect_panel.py

@@ -1,6 +1,7 @@
 from typing import Self, TYPE_CHECKING
 
-from dzgui.const.constants import CARET_DOWN, CARET_UP, UDP_PORT
+from dzgui.const.icons import ICON_CARET_DOWN, ICON_CARET_UP
+from dzgui.const.constants import UDP_PORT
 from dzgui.model.servers import ServerModelManager
 from dzgui.strings import connect_panel
 from dzgui.util.keys import is_ctrl_mask
@@ -30,7 +31,7 @@ ROWS = 1
 
 class DockButton(IconButton):
     def __init__(self, child: Gtk.Widget) -> None:
-        super().__init__(CARET_DOWN)
+        super().__init__(ICON_CARET_DOWN)
 
         self.expanded = True
         self.child = child
@@ -43,12 +44,12 @@ class DockButton(IconButton):
         self.set_tooltip_text(self.collapse_text)
 
     def collapse(self) -> None:
-        self.set_image(Icon(CARET_UP))
+        self.set_image(Icon(ICON_CARET_UP))
         self.child.hide()
         self.set_tooltip_text(self.expand_text)
 
     def expand(self) -> None:
-        self.set_image(Icon(CARET_DOWN))
+        self.set_image(Icon(ICON_CARET_DOWN))
         self.child.show()
         self.set_tooltip_text(self.collapse_text)
 

dzgui/views/components/entry.py

@@ -1,7 +1,7 @@
 from typing import Any, Callable, TYPE_CHECKING
 
 from dzgui.api.servers import validate_ip
-from dzgui.const.constants import VIEW_CONCEAL, VIEW_REVEAL
+from dzgui.const.icons import ICON_VIEW_CONCEAL, ICON_VIEW_REVEAL
 from dzgui.util.css import add_class, remove_class
 from dzgui.strings import connect_panel
 from dzgui.strings.errors import api_popover
@@ -147,7 +147,7 @@ class APIEntry(Gtk.Box):
         self.entry = Gtk.Entry(
             width_chars=60, hexpand=True, placeholder_text="Enter API key"
         )
-        self.entry.set_icon_from_icon_name(Gtk.EntryIconPosition.SECONDARY, VIEW_REVEAL)
+        self.entry.set_icon_from_icon_name(Gtk.EntryIconPosition.SECONDARY, ICON_VIEW_REVEAL)
         self.entry.set_icon_activatable(Gtk.EntryIconPosition.SECONDARY, True)
         self.entry.set_visibility(False)
         self.entry.connect("changed", self._on_text_changed)
@@ -206,9 +206,9 @@ class APIEntry(Gtk.Box):
     ) -> None:
         visible = widget.get_visibility()
         if visible:
-            icon, state = VIEW_REVEAL, False
+            icon, state = ICON_VIEW_REVEAL, False
         else:
-            icon, state = VIEW_CONCEAL, True
+            icon, state = ICON_VIEW_CONCEAL, True
         widget.set_icon_from_icon_name(Gtk.EntryIconPosition.SECONDARY, icon)
         widget.set_visibility(state)
 

dzgui/views/components/eventbox.py

@@ -1,7 +1,7 @@
 from typing import TYPE_CHECKING
 
 from dzgui.const.enum import NotebookPage
-from dzgui.const.constants import HELP_BUBBLE
+from dzgui.const.icons import ICON_HELP_BUBBLE
 
 import gi
 
@@ -20,7 +20,7 @@ class InfoEventBox(Gtk.EventBox):
         self.text = text
 
         self.icon = Gtk.Image.new_from_icon_name(
-            HELP_BUBBLE, Gtk.IconSize.LARGE_TOOLBAR
+            ICON_HELP_BUBBLE, Gtk.IconSize.LARGE_TOOLBAR
         )
         self.icon.set_opacity(0.8)
         box = Gtk.Box()

dzgui/views/components/filter_panel.py

@@ -7,8 +7,8 @@ from dzgui.const.constants import (
     NO_EXPAND,
     NO_FILL,
     NO_PADDING,
-    SEARCH_ICON,
 )
+from dzgui.const.icons import ICON_SEARCH
 from dzgui.util.format import format_exception
 from dzgui.util.strings import all_maps
 from dzgui.views.components.maps_combo import MapsCombo
@@ -109,7 +109,7 @@ class KeywordEntry(Gtk.Entry):
         self.connect("key-press-event", self._on_keypress)
         self.connect("icon-release", lambda *args: self.activate())
 
-        self.set_icon_from_icon_name(Gtk.EntryIconPosition.SECONDARY, SEARCH_ICON)
+        self.set_icon_from_icon_name(Gtk.EntryIconPosition.SECONDARY, ICON_SEARCH)
         self.set_icon_activatable(Gtk.EntryIconPosition.SECONDARY, True)
 
         self.emitter.connect("load_maps", self._on_maps_loaded)

dzgui/views/components/misc.py

@@ -1,7 +1,8 @@
 from typing import Self
 from warnings import deprecated
 
-from dzgui.const.constants import ERROR, FLATPAK_RUN_CMD, FLATPAK_SANDBOX, STEAM_CMD
+from dzgui.const.constants import FLATPAK_RUN_CMD, FLATPAK_SANDBOX, STEAM_CMD
+from dzgui.const.icons import ICON_ERROR
 from dzgui.init.prereqs import has_steam_client, has_flatpak_client
 from dzgui.strings import options
 from dzgui.views.components.box import HBox
@@ -73,7 +74,7 @@ class ErrorPopover(Gtk.Popover):
 
         self.hbox = HBox()
         self.label = Gtk.Label(label="", margin_start=10, margin_end=10)
-        error_icon = Icon(ERROR, margin_start=10)
+        error_icon = Icon(ICON_ERROR, margin_start=10)
         self.hbox.extend([error_icon, self.label])
         self.add(self.hbox)
         self.show_all()

dzgui/views/dialogs/calc.py

@@ -3,7 +3,7 @@ from dataclasses import dataclass
 from datetime import datetime, time, timedelta
 from typing import Literal
 
-from dzgui.const.constants import DAY_ICON, NIGHT_ICON
+from dzgui.const.icons import ICON_DAY, ICON_NIGHT
 from dzgui.strings import calc
 from dzgui.views.components.icon import Icon
 from dzgui.views.components.labels import BoldLabel
@@ -385,7 +385,7 @@ class TimePickerFrame(Gtk.Frame):
         h1 = BoldLabel(calc.heading_server_time)
         h2 = BoldLabel(calc.heading_target_time)
 
-        self.icon_indicator = Icon(DAY_ICON)
+        self.icon_indicator = Icon(ICON_DAY)
         self.update_server_icon()
 
         server_time_box = HBox(10)
@@ -411,7 +411,7 @@ class TimePickerFrame(Gtk.Frame):
         self.add(flowbox)
 
     def update_server_icon(self) -> None:
-        icon = DAY_ICON if self.server_time.is_day() else NIGHT_ICON
+        icon = ICON_DAY if self.server_time.is_day() else ICON_NIGHT
         self.icon_indicator.set_icon_name(icon)
 
     def _on_server_clock_increment(self, emitter: Emitter, time_now: datetime) -> None:

dzgui/views/dialogs/servers.py

@@ -2,7 +2,7 @@ import gi
 import html
 from typing import Self, TYPE_CHECKING
 
-from dzgui.const.constants import CALCULATOR
+from dzgui.const.icons import ICON_CALCULATOR
 from dzgui.const.enum import ContextMenuGroup
 from dzgui.model.model_factory import ModelFactory
 from dzgui.util import css
@@ -110,7 +110,7 @@ class ServerDetailsDialog(ServerDialog):
         text = format_hyperlinks(text)
         self.description.set_markup(html.escape(text))
 
-        calc_button = IconTextButton(CALCULATOR, dialogs.toggle_calc)
+        calc_button = IconTextButton(ICON_CALCULATOR, dialogs.toggle_calc)
         calc_button.connect("clicked", self._on_calc_pressed)
         calc_button.set_halign(Gtk.Align.END)
         calc_button.set_valign(Gtk.Align.START)

dzgui/views/pages/offline.py

@@ -3,14 +3,12 @@ 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,
     APPNAME_DAYZ,
     APPNAME_DAYZ_EXP_HUMAN,
-    EDIT_DELETE,
-    FOLDER,
-    WARNING,
 )
 from dzgui.const.enum import ContextMenuGroup, NotebookPage
 from dzgui.managers.offline import OfflineManager
@@ -87,7 +85,7 @@ class FolderHBox(HBox):
         self.emitter = controller.get_emitter()
 
         self.eb = InfoEventBox(eb_text, controller)
-        self.button = IconTextButton(FOLDER, btn_label, Gtk.PositionType.LEFT)
+        self.button = IconTextButton(ICON_FOLDER, btn_label, Gtk.PositionType.LEFT)
         self.button.set_halign(Gtk.Align.START)
         self.button.set_image_position(Gtk.PositionType.LEFT)
 
@@ -99,7 +97,7 @@ class FolderHBox(HBox):
         self.label = Gtk.Label()
         self.scrolled_label.add(self.label)
 
-        self.unset_button = IconTextButton(EDIT_DELETE, offline.unset_button)
+        self.unset_button = IconTextButton(ICON_EDIT_DELETE, offline.unset_button)
         self.unset_button.connect("clicked", self._on_unset_clicked)
 
         self.spinner = Gtk.Spinner()
@@ -195,7 +193,7 @@ class ModFrame(HeadingFrame):
         self.tree_vbox.extend([self.scrolled, self.status])
 
         self.no_mods = HBox(spacing=10)
-        no_mods_icon = Icon(WARNING, margin_start=10)
+        no_mods_icon = Icon(ICON_WARNING, margin_start=10)
         no_mods_label = Gtk.Label(label=offline.no_local_mods, halign=Gtk.Align.START)
         self.no_mods.extend([no_mods_icon, no_mods_label])
 

dzgui/views/pages/options.py

@@ -16,9 +16,8 @@ from dzgui.const.constants import (
     NO_EXPAND,
     NO_FILL,
     NO_PADDING,
-    VIEW_CONCEAL,
-    VIEW_REVEAL,
 )
+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.strings import options
@@ -67,7 +66,7 @@ class SubmitField(Gtk.Box):
         # TODO: audit for all applicable callbacks
         if private:
             self.entry.set_icon_from_icon_name(
-                Gtk.EntryIconPosition.SECONDARY, VIEW_REVEAL
+                Gtk.EntryIconPosition.SECONDARY, ICON_VIEW_REVEAL
             )
             self.entry.set_icon_activatable(Gtk.EntryIconPosition.SECONDARY, True)
             self.entry.connect("icon-release", self._on_icon_release)
@@ -131,9 +130,9 @@ class SubmitField(Gtk.Box):
     ) -> None:
         visible = widget.get_visibility()
         if visible:
-            icon, state = VIEW_REVEAL, False
+            icon, state = ICON_VIEW_REVEAL, False
         else:
-            icon, state = VIEW_CONCEAL, True
+            icon, state = ICON_VIEW_CONCEAL, True
         widget.set_icon_from_icon_name(Gtk.EntryIconPosition.SECONDARY, icon)
         widget.set_visibility(state)
 

dzgui/views/pages/preconnect.py

@@ -1,9 +1,9 @@
 from dataclasses import dataclass
 from typing import Self, Sequence, TYPE_CHECKING
 
-from dzgui.const.constants import (
-    ERROR,
-    WARNING,
+from dzgui.const.icons import (
+    ICON_ERROR,
+    ICON_WARNING,
 )
 from dzgui.const.enum import NotebookPage
 from dzgui.util.css import add_class
@@ -166,7 +166,7 @@ class PreConnectionAssistant(Gtk.Box):
 
         # TODO: abstract into components
         self.warning_box = Gtk.Box(orientation=Gtk.Orientation.VERTICAL)
-        self.warning_tree = MaskedTree(WARNING)
+        self.warning_tree = MaskedTree(ICON_WARNING)
         self.warning_placeholder = Placeholder(preconnect.placeholder_no_warnings)
         self.warning_box.add(self.warning_tree)
         self.warning_box.add(self.warning_placeholder)
@@ -175,7 +175,7 @@ class PreConnectionAssistant(Gtk.Box):
         )
 
         self.error_box = Gtk.Box(orientation=Gtk.Orientation.VERTICAL)
-        self.error_tree = MaskedTree(ERROR)
+        self.error_tree = MaskedTree(ICON_ERROR)
         self.error_placeholder = Placeholder(preconnect.no_errors)
         self.error_box.add(self.error_tree)
         self.error_box.add(self.error_placeholder)

tests/test_legacy_version_file.py

@@ -1,25 +0,0 @@
-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()