From 07b78bcdbdba7e9375c8174dd48464521e36eb3a Mon Sep 17 00:00:00 2001 From: kramo Date: Sun, 13 Aug 2023 15:20:36 +0200 Subject: [PATCH 01/13] Add search entry placeholder text --- data/gtk/window.blp | 2 ++ po/cartridges.pot | 42 +++++++++++++++++++++++++----------------- 2 files changed, 27 insertions(+), 17 deletions(-) diff --git a/data/gtk/window.blp b/data/gtk/window.blp index e75ffa2..bf5b6db 100644 --- a/data/gtk/window.blp +++ b/data/gtk/window.blp @@ -269,6 +269,7 @@ template $CartridgesWindow : Adw.ApplicationWindow { tightening-threshold: 500; SearchEntry search_entry { + placeholder-text: _("Search games"); hexpand: true; } } @@ -335,6 +336,7 @@ template $CartridgesWindow : Adw.ApplicationWindow { tightening-threshold: 500; SearchEntry hidden_search_entry { + placeholder-text: _("Search hidden games"); hexpand: true; } } diff --git a/po/cartridges.pot b/po/cartridges.pot index 2308909..55050fe 100644 --- a/po/cartridges.pot +++ b/po/cartridges.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Cartridges\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2023-08-13 12:49+0200\n" +"POT-Creation-Date: 2023-08-13 15:20+0200\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -58,7 +58,7 @@ msgstr "" msgid "Game Details" msgstr "" -#: data/hu.kramo.Cartridges.metainfo.xml.in:42 data/gtk/window.blp:416 +#: data/hu.kramo.Cartridges.metainfo.xml.in:42 data/gtk/window.blp:418 #: src/details_window.py:241 msgid "Preferences" msgstr "" @@ -117,7 +117,7 @@ msgid "Quit" msgstr "" #: data/gtk/help-overlay.blp:19 data/gtk/window.blp:217 data/gtk/window.blp:257 -#: data/gtk/window.blp:323 +#: data/gtk/window.blp:324 msgid "Search" msgstr "" @@ -193,7 +193,7 @@ msgstr "" msgid "Remove All Games" msgstr "" -#: data/gtk/preferences.blp:85 data/gtk/window.blp:27 data/gtk/window.blp:442 +#: data/gtk/preferences.blp:85 data/gtk/window.blp:27 data/gtk/window.blp:444 msgid "Import" msgstr "" @@ -324,7 +324,7 @@ msgstr "" msgid "Games you hide will appear here." msgstr "" -#: data/gtk/window.blp:64 data/gtk/window.blp:304 +#: data/gtk/window.blp:64 data/gtk/window.blp:305 msgid "Back" msgstr "" @@ -336,51 +336,59 @@ msgstr "" msgid "Play" msgstr "" -#: data/gtk/window.blp:243 data/gtk/window.blp:435 +#: data/gtk/window.blp:243 data/gtk/window.blp:437 msgid "Add Game" msgstr "" -#: data/gtk/window.blp:250 data/gtk/window.blp:316 +#: data/gtk/window.blp:250 data/gtk/window.blp:317 msgid "Main Menu" msgstr "" -#: data/gtk/window.blp:311 +#: data/gtk/window.blp:272 +msgid "Search games" +msgstr "" + +#: data/gtk/window.blp:312 msgid "Hidden Games" msgstr "" -#: data/gtk/window.blp:374 +#: data/gtk/window.blp:339 +msgid "Search hidden games" +msgstr "" + +#: data/gtk/window.blp:376 msgid "Sort" msgstr "" -#: data/gtk/window.blp:377 +#: data/gtk/window.blp:379 msgid "A-Z" msgstr "" -#: data/gtk/window.blp:383 +#: data/gtk/window.blp:385 msgid "Z-A" msgstr "" -#: data/gtk/window.blp:389 +#: data/gtk/window.blp:391 msgid "Newest" msgstr "" -#: data/gtk/window.blp:395 +#: data/gtk/window.blp:397 msgid "Oldest" msgstr "" -#: data/gtk/window.blp:401 +#: data/gtk/window.blp:403 msgid "Last Played" msgstr "" -#: data/gtk/window.blp:408 +#: data/gtk/window.blp:410 msgid "Show Hidden" msgstr "" -#: data/gtk/window.blp:421 +#: data/gtk/window.blp:423 msgid "Keyboard Shortcuts" msgstr "" -#: data/gtk/window.blp:426 +#: data/gtk/window.blp:428 msgid "About Cartridges" msgstr "" From 0599a61057d8b7dc0f213a9a936d9d429cd3e23b Mon Sep 17 00:00:00 2001 From: kramo Date: Sun, 13 Aug 2023 16:07:32 +0200 Subject: [PATCH 02/13] Delete unused check_install.py --- src/utils/check_install.py | 32 -------------------------------- 1 file changed, 32 deletions(-) delete mode 100644 src/utils/check_install.py diff --git a/src/utils/check_install.py b/src/utils/check_install.py deleted file mode 100644 index 2f74395..0000000 --- a/src/utils/check_install.py +++ /dev/null @@ -1,32 +0,0 @@ -# check_install.py -# -# Copyright 2022-2023 kramo -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . -# -# SPDX-License-Identifier: GPL-3.0-or-later - -from pathlib import Path - - -# TODO delegate to the sources -def check_install(check, locations, setting=None, subdirs=(Path(),)): - for location in locations: - for subdir in (Path(),) + subdirs: - if (location / subdir / check).exists(): - if setting: - setting[0].set_string(setting[1], str(location / subdir)) - return location / subdir - - return False From 8ca264ff954405effd48f0ae2ac905f68fde20cf Mon Sep 17 00:00:00 2001 From: kramo Date: Tue, 15 Aug 2023 19:04:02 +0200 Subject: [PATCH 03/13] Backport base_source from libadwaita-1.4 --- src/game.py | 1 + 1 file changed, 1 insertion(+) diff --git a/src/game.py b/src/game.py index 34dbf84..44cabc6 100644 --- a/src/game.py +++ b/src/game.py @@ -69,6 +69,7 @@ class Game(Gtk.Box): self.version = shared.SPEC_VERSION self.update_values(data) + self.base_source = self.source.split("_")[0] self.set_play_icon() From 5abf3f300da43dd106b62b2796e452ebec9d2faf Mon Sep 17 00:00:00 2001 From: kramo Date: Tue, 15 Aug 2023 20:11:06 +0200 Subject: [PATCH 04/13] Remove missing games - closes #85 --- data/gtk/preferences.blp | 13 ++++++++++ data/hu.kramo.Cartridges.gschema.xml.in | 3 +++ src/importer/importer.py | 34 +++++++++++++++++++++++++ src/preferences.py | 3 +++ src/store/store.py | 8 +++++- 5 files changed, 60 insertions(+), 1 deletion(-) diff --git a/data/gtk/preferences.blp b/data/gtk/preferences.blp index 9654c29..543a993 100644 --- a/data/gtk/preferences.blp +++ b/data/gtk/preferences.blp @@ -85,6 +85,19 @@ template $PreferencesWindow : Adw.PreferencesWindow { title: _("Import"); icon-name: "document-save-symbolic"; + Adw.PreferencesGroup import_behavior_group { + title: _("Behavior"); + + Adw.ActionRow { + title: _("Remove Missing Games"); + activatable-widget: remove_missing_switch; + + Switch remove_missing_switch { + valign: center; + } + } + } + Adw.PreferencesGroup sources_group { title: _("Sources"); diff --git a/data/hu.kramo.Cartridges.gschema.xml.in b/data/hu.kramo.Cartridges.gschema.xml.in index d31c2ed..9003a93 100644 --- a/data/hu.kramo.Cartridges.gschema.xml.in +++ b/data/hu.kramo.Cartridges.gschema.xml.in @@ -10,6 +10,9 @@ false + + true + true diff --git a/src/importer/importer.py b/src/importer/importer.py index 756ea3b..f3d95cb 100644 --- a/src/importer/importer.py +++ b/src/importer/importer.py @@ -49,8 +49,15 @@ class Importer(ErrorProducer): n_pipelines_done: int = 0 game_pipelines: set[Pipeline] = None + removed_games: set[Game] = set() + def __init__(self): super().__init__() + + # TODO: make this stateful + shared.store.new_game_ids = set() + shared.store.duplicate_game_ids = set() + self.game_pipelines = set() self.sources = set() @@ -217,9 +224,36 @@ class Importer(ErrorProducer): if self.finished: self.import_callback() + def remove_games(self): + """Set removed to True for missing games""" + if not shared.schema.get_boolean("remove-missing"): + return + + for game in shared.store: + if game.removed: + continue + if game.source == "imported": + continue + if not shared.schema.get_boolean(game.base_source): + continue + if game.game_id in shared.store.duplicate_game_ids: + continue + if game.game_id in shared.store.new_game_ids: + continue + + logging.debug("Removing missing game %s (%s)", game.name, game.game_id) + + game.removed = True + game.save() + game.update() + self.removed_games.add(game) + def import_callback(self): """Callback called when importing has finished""" logging.info("Import done") + self.remove_games() + shared.store.new_game_ids = set() + shared.store.duplicate_game_ids = set() self.import_dialog.close() self.summary_toast = self.create_summary_toast() self.create_error_dialog() diff --git a/src/preferences.py b/src/preferences.py index 6b7d105..a3172ac 100644 --- a/src/preferences.py +++ b/src/preferences.py @@ -52,6 +52,8 @@ class PreferencesWindow(Adw.PreferencesWindow): cover_launches_game_switch = Gtk.Template.Child() high_quality_images_switch = Gtk.Template.Child() + remove_missing_switch = Gtk.Template.Child() + steam_expander_row = Gtk.Template.Child() steam_data_action_row = Gtk.Template.Child() steam_data_file_chooser_button = Gtk.Template.Child() @@ -184,6 +186,7 @@ class PreferencesWindow(Adw.PreferencesWindow): "exit-after-launch", "cover-launches-game", "high-quality-images", + "remove-missing", "lutris-import-steam", "lutris-import-flatpak", "heroic-import-epic", diff --git a/src/store/store.py b/src/store/store.py index 231bbdc..0e07749 100644 --- a/src/store/store.py +++ b/src/store/store.py @@ -18,7 +18,7 @@ # SPDX-License-Identifier: GPL-3.0-or-later import logging -from typing import MutableMapping, Generator, Any +from typing import Any, Generator, MutableMapping from src import shared from src.game import Game @@ -33,12 +33,16 @@ class Store: pipeline_managers: set[Manager] pipelines: dict[str, Pipeline] source_games: MutableMapping[str, MutableMapping[str, Game]] + new_game_ids: set[str] + duplicate_game_ids: set[str] def __init__(self) -> None: self.managers = {} self.pipeline_managers = set() self.pipelines = {} self.source_games = {} + self.new_game_ids = set() + self.duplicate_game_ids = set() def __contains__(self, obj: object) -> bool: """Check if the game is present in the store with the `in` keyword""" @@ -114,6 +118,7 @@ class Store: if not stored_game: # New game, do as normal logging.debug("New store game %s (%s)", game.name, game.game_id) + self.new_game_ids.add(game.game_id) elif stored_game.removed: # Will replace a removed game, cleanup its remains logging.debug( @@ -125,6 +130,7 @@ class Store: else: # Duplicate game, ignore it logging.debug("Duplicate store game %s (%s)", game.name, game.game_id) + self.duplicate_game_ids.add(game.game_id) return None # Connect signals From 9b97e8c3550ab36c6fa3dd470dd649447da76cfb Mon Sep 17 00:00:00 2001 From: kramo Date: Tue, 15 Aug 2023 21:10:10 +0200 Subject: [PATCH 05/13] Basic undo system for imports --- src/importer/importer.py | 59 ++++++++++++++++++++++++++++++---------- src/store/store.py | 1 + 2 files changed, 46 insertions(+), 14 deletions(-) diff --git a/src/importer/importer.py b/src/importer/importer.py index f3d95cb..722f2fe 100644 --- a/src/importer/importer.py +++ b/src/importer/importer.py @@ -49,7 +49,8 @@ class Importer(ErrorProducer): n_pipelines_done: int = 0 game_pipelines: set[Pipeline] = None - removed_games: set[Game] = set() + removed_game_ids: set[str] = set() + imported_game_ids: set[str] = set() def __init__(self): super().__init__() @@ -246,12 +247,13 @@ class Importer(ErrorProducer): game.removed = True game.save() game.update() - self.removed_games.add(game) + self.removed_game_ids.add(game.game_id) def import_callback(self): """Callback called when importing has finished""" logging.info("Import done") self.remove_games() + self.imported_game_ids = shared.store.new_game_ids shared.store.new_game_ids = set() shared.store.duplicate_game_ids = set() self.import_dialog.close() @@ -311,27 +313,56 @@ class Importer(ErrorProducer): dialog.present() + def undo_import(self, *_args): + for game_id in self.imported_game_ids: + shared.store[game_id].removed = True + shared.store[game_id].update() + shared.store[game_id].save() + + for game_id in self.removed_game_ids: + shared.store[game_id].removed = False + shared.store[game_id].update() + shared.store[game_id].save() + + self.removed_game_ids = set() + self.summary_toast.dismiss() + def create_summary_toast(self): - """N games imported toast""" + """N games imported, removed toast""" toast = Adw.Toast(timeout=0, priority=Adw.ToastPriority.HIGH) - if self.n_games_added == 0: - toast.set_title(_("No new games found")) - toast.set_button_label(_("Preferences")) - toast.connect( - "button-clicked", - self.dialog_response_callback, - "open_preferences", - "import", - ) + if not self.n_games_added: + toast_title = _("No new games found") + + if not self.removed_game_ids: + toast.set_button_label(_("Preferences")) + toast.connect( + "button-clicked", + self.dialog_response_callback, + "open_preferences", + "import", + ) elif self.n_games_added == 1: - toast.set_title(_("1 game imported")) + toast_title = _("1 game imported") elif self.n_games_added > 1: # The variable is the number of games - toast.set_title(_("{} games imported").format(self.n_games_added)) + toast_title = _("{} games imported").format(self.n_games_added) + + if (removed_length := len(self.removed_game_ids)) == 1: + toast_title += ", " + _("1 game removed") + + elif removed_length > 1: + # The variable is the number of games + toast_title += ", " + _("{} games removed").format(removed_length) + + if self.n_games_added or self.removed_game_ids: + toast.set_button_label(_("Undo")) + toast.connect("button-clicked", self.undo_import) + + toast.set_title(toast_title) shared.win.toast_overlay.add_toast(toast) return toast diff --git a/src/store/store.py b/src/store/store.py index 0e07749..34c036b 100644 --- a/src/store/store.py +++ b/src/store/store.py @@ -127,6 +127,7 @@ class Store: game.game_id, ) self.cleanup_game(stored_game) + self.new_game_ids.add(game.game_id) else: # Duplicate game, ignore it logging.debug("Duplicate store game %s (%s)", game.name, game.game_id) From 555175611175876550b3fa19c824307f88a838b8 Mon Sep 17 00:00:00 2001 From: kramo Date: Tue, 15 Aug 2023 21:19:27 +0200 Subject: [PATCH 06/13] Ctrl + Z for import undo --- src/main.py | 20 ++++++++++---------- src/window.py | 23 +++++++++++++++-------- 2 files changed, 25 insertions(+), 18 deletions(-) diff --git a/src/main.py b/src/main.py index 958aa20..4cd0b6e 100644 --- a/src/main.py +++ b/src/main.py @@ -216,33 +216,33 @@ class CartridgesApplication(Adw.Application): DetailsWindow() def on_import_action(self, *_args): - importer = Importer() + shared.importer = Importer() if shared.schema.get_boolean("lutris"): - importer.add_source(LutrisSource()) + shared.importer.add_source(LutrisSource()) if shared.schema.get_boolean("steam"): - importer.add_source(SteamSource()) + shared.importer.add_source(SteamSource()) if shared.schema.get_boolean("heroic"): - importer.add_source(HeroicSource()) + shared.importer.add_source(HeroicSource()) if shared.schema.get_boolean("bottles"): - importer.add_source(BottlesSource()) + shared.importer.add_source(BottlesSource()) if shared.schema.get_boolean("flatpak"): - importer.add_source(FlatpakSource()) + shared.importer.add_source(FlatpakSource()) if shared.schema.get_boolean("itch"): - importer.add_source(ItchSource()) + shared.importer.add_source(ItchSource()) if shared.schema.get_boolean("legendary"): - importer.add_source(LegendarySource()) + shared.importer.add_source(LegendarySource()) if shared.schema.get_boolean("retroarch"): - importer.add_source(RetroarchSource()) + shared.importer.add_source(RetroarchSource()) - importer.run() + shared.importer.run() def on_remove_game_action(self, *_args): self.win.active_game.remove_game() diff --git a/src/window.py b/src/window.py index 16e3588..37bad99 100644 --- a/src/window.py +++ b/src/window.py @@ -331,13 +331,19 @@ class CartridgesWindow(Adw.ApplicationWindow): def on_undo_action(self, _widget, game=None, undo=None): if not game: # If the action was activated via Ctrl + Z - try: - game = tuple(self.toasts.keys())[-1][0] - undo = tuple(self.toasts.keys())[-1][1] - except IndexError: - return + if shared.importer.imported_game_ids or shared.importer.removed_game_ids: + undo = "import" + else: + try: + game = tuple(self.toasts.keys())[-1][0] + undo = tuple(self.toasts.keys())[-1][1] + except IndexError: + return - if undo == "hide": + if undo == "import": + shared.importer.undo_import() + + elif undo == "hide": game.toggle_hidden(False) elif undo == "remove": @@ -345,8 +351,9 @@ class CartridgesWindow(Adw.ApplicationWindow): game.save() game.update() - self.toasts[(game, undo)].dismiss() - self.toasts.pop((game, undo)) + if game: + self.toasts[(game, undo)].dismiss() + self.toasts.pop((game, undo)) def on_open_menu_action(self, *_args): if self.stack.get_visible_child() == self.library_view: From b466eb7ab2638f4ee6c03af22e7f1f0a3ad25f0d Mon Sep 17 00:00:00 2001 From: kramo Date: Tue, 15 Aug 2023 21:32:24 +0200 Subject: [PATCH 07/13] Dismiss loose toasts when cleaning up games --- src/importer/importer.py | 3 +++ src/store/store.py | 9 ++++++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/src/importer/importer.py b/src/importer/importer.py index 722f2fe..0b9b076 100644 --- a/src/importer/importer.py +++ b/src/importer/importer.py @@ -324,9 +324,12 @@ class Importer(ErrorProducer): shared.store[game_id].update() shared.store[game_id].save() + self.imported_game_ids = set() self.removed_game_ids = set() self.summary_toast.dismiss() + logging.info("Import undone") + def create_summary_toast(self): """N games imported, removed toast""" diff --git a/src/store/store.py b/src/store/store.py index 34c036b..89c7f11 100644 --- a/src/store/store.py +++ b/src/store/store.py @@ -91,7 +91,7 @@ class Store: self.pipeline_managers.discard(self.managers[manager_type]) def cleanup_game(self, game: Game) -> None: - """Remove a game's files""" + """Remove a game's files, dismiss any loose toasts""" for path in ( shared.games_dir / f"{game.game_id}.json", shared.covers_dir / f"{game.game_id}.tiff", @@ -99,6 +99,13 @@ class Store: ): path.unlink(missing_ok=True) + # TODO: don't run this if the state is startup + for undo in ("remove", "hide"): + try: + shared.win.toasts[(game, undo)].dismiss() + except KeyError: + pass + def add_game( self, game: Game, additional_data: dict, run_pipeline=True ) -> Pipeline | None: From cb9513ff1323a021950bd3e5623b4105b67db8f0 Mon Sep 17 00:00:00 2001 From: kramo Date: Tue, 15 Aug 2023 21:46:58 +0200 Subject: [PATCH 08/13] Fix import undo logic --- src/store/store.py | 1 + src/window.py | 4 +++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/src/store/store.py b/src/store/store.py index 89c7f11..a11bf5a 100644 --- a/src/store/store.py +++ b/src/store/store.py @@ -103,6 +103,7 @@ class Store: for undo in ("remove", "hide"): try: shared.win.toasts[(game, undo)].dismiss() + shared.win.toasts.pop((game, undo)) except KeyError: pass diff --git a/src/window.py b/src/window.py index 37bad99..ac2ab42 100644 --- a/src/window.py +++ b/src/window.py @@ -331,7 +331,9 @@ class CartridgesWindow(Adw.ApplicationWindow): def on_undo_action(self, _widget, game=None, undo=None): if not game: # If the action was activated via Ctrl + Z - if shared.importer.imported_game_ids or shared.importer.removed_game_ids: + if shared.importer and ( + shared.importer.imported_game_ids or shared.importer.removed_game_ids + ): undo = "import" else: try: From 16d6a026e5ec376b37f29239455f8c4db4c36944 Mon Sep 17 00:00:00 2001 From: kramo Date: Tue, 15 Aug 2023 22:46:20 +0200 Subject: [PATCH 09/13] Make removed strings clearer --- src/importer/importer.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/importer/importer.py b/src/importer/importer.py index 0b9b076..dbcc715 100644 --- a/src/importer/importer.py +++ b/src/importer/importer.py @@ -355,11 +355,12 @@ class Importer(ErrorProducer): toast_title = _("{} games imported").format(self.n_games_added) if (removed_length := len(self.removed_game_ids)) == 1: - toast_title += ", " + _("1 game removed") + # A single game removed + toast_title += ", " + _("1 removed") elif removed_length > 1: - # The variable is the number of games - toast_title += ", " + _("{} games removed").format(removed_length) + # The variable is the number of games removed + toast_title += ", " + _("{} removed").format(removed_length) if self.n_games_added or self.removed_game_ids: toast.set_button_label(_("Undo")) From dbb6076fdce0a1561fbc30922f6e84e8b11efc31 Mon Sep 17 00:00:00 2001 From: GeoffreyCoulaud Date: Tue, 15 Aug 2023 23:53:18 +0200 Subject: [PATCH 10/13] Various fixes for locations - Simplified some preferences code - Added type hints to locations - Made locations not shared between source instances (source of a bug) - Updated source iter to resolve locations correctly --- src/importer/sources/bottles_source.py | 32 +++++++----- src/importer/sources/flatpak_source.py | 30 ++++++----- src/importer/sources/heroic_source.py | 48 +++++++++-------- src/importer/sources/itch_source.py | 32 +++++++----- src/importer/sources/legendary_source.py | 32 +++++++----- src/importer/sources/location.py | 6 +-- src/importer/sources/lutris_source.py | 56 ++++++++++---------- src/importer/sources/retroarch_source.py | 66 +++++++++++++----------- src/importer/sources/source.py | 10 ++-- src/importer/sources/steam_source.py | 36 +++++++------ src/preferences.py | 29 +++-------- 11 files changed, 199 insertions(+), 178 deletions(-) diff --git a/src/importer/sources/bottles_source.py b/src/importer/sources/bottles_source.py index 041247b..d85529c 100644 --- a/src/importer/sources/bottles_source.py +++ b/src/importer/sources/bottles_source.py @@ -90,18 +90,22 @@ class BottlesSource(URLExecutableSource): url_format = 'bottles:run/"{bottle_name}"/"{game_name}"' available_on = {"linux"} - locations = BottlesLocations( - Location( - schema_key="bottles-location", - candidates=( - shared.flatpak_dir / "com.usebottles.bottles" / "data" / "bottles", - shared.data_dir / "bottles/", - shared.home / ".local" / "share" / "bottles", - ), - paths={ - "library.yml": LocationSubPath("library.yml"), - "data.yml": LocationSubPath("data.yml"), - }, - invalid_subtitle=Location.DATA_INVALID_SUBTITLE, + locations: BottlesLocations + + def __init__(self) -> None: + super().__init__() + self.locations = BottlesLocations( + Location( + schema_key="bottles-location", + candidates=( + shared.flatpak_dir / "com.usebottles.bottles" / "data" / "bottles", + shared.data_dir / "bottles/", + shared.home / ".local" / "share" / "bottles", + ), + paths={ + "library.yml": LocationSubPath("library.yml"), + "data.yml": LocationSubPath("data.yml"), + }, + invalid_subtitle=Location.DATA_INVALID_SUBTITLE, + ) ) - ) diff --git a/src/importer/sources/flatpak_source.py b/src/importer/sources/flatpak_source.py index ee4ebbe..6bb982e 100644 --- a/src/importer/sources/flatpak_source.py +++ b/src/importer/sources/flatpak_source.py @@ -125,17 +125,21 @@ class FlatpakSource(Source): executable_format = "flatpak run {flatpak_id}" available_on = {"linux"} - locations = FlatpakLocations( - Location( - schema_key="flatpak-location", - candidates=( - "/var/lib/flatpak/", - shared.data_dir / "flatpak", - ), - paths={ - "applications": LocationSubPath("exports/share/applications", True), - "icons": LocationSubPath("exports/share/icons", True), - }, - invalid_subtitle=Location.DATA_INVALID_SUBTITLE, + locations: FlatpakLocations + + def __init__(self) -> None: + super().__init__() + self.locations = FlatpakLocations( + Location( + schema_key="flatpak-location", + candidates=( + "/var/lib/flatpak/", + shared.data_dir / "flatpak", + ), + paths={ + "applications": LocationSubPath("exports/share/applications", True), + "icons": LocationSubPath("exports/share/icons", True), + }, + invalid_subtitle=Location.DATA_INVALID_SUBTITLE, + ) ) - ) diff --git a/src/importer/sources/heroic_source.py b/src/importer/sources/heroic_source.py index c06a266..42dc446 100644 --- a/src/importer/sources/heroic_source.py +++ b/src/importer/sources/heroic_source.py @@ -21,12 +21,12 @@ import json import logging from abc import abstractmethod +from functools import cached_property from hashlib import sha256 from json import JSONDecodeError from pathlib import Path from time import time from typing import Iterable, NamedTuple, Optional, TypedDict -from functools import cached_property from src import shared from src.game import Game @@ -108,7 +108,9 @@ class SubSourceIterable(Iterable): "game_id": self.source.game_id_format.format( service=self.service, game_id=app_name ), - "executable": self.source.executable_format.format(runner=runner, app_name=app_name), + "executable": self.source.executable_format.format( + runner=runner, app_name=app_name + ), "hidden": self.source_iterable.is_hidden(app_name), } game = Game(values) @@ -363,27 +365,31 @@ class HeroicSource(URLExecutableSource): url_format = "heroic://launch/{runner}/{app_name}" available_on = {"linux", "win32"} - locations = HeroicLocations( - Location( - schema_key="heroic-location", - candidates=( - shared.config_dir / "heroic", - shared.home / ".config" / "heroic", - shared.flatpak_dir - / "com.heroicgameslauncher.hgl" - / "config" - / "heroic", - shared.appdata_dir / "heroic", - ), - paths={ - "config.json": LocationSubPath("config.json"), - "store_config.json": LocationSubPath("store/config.json"), - }, - invalid_subtitle=Location.CONFIG_INVALID_SUBTITLE, - ) - ) + locations: HeroicLocations @property def game_id_format(self) -> str: """The string format used to construct game IDs""" return self.source_id + "_{service}_{game_id}" + + def __init__(self) -> None: + super().__init__() + self.locations = HeroicLocations( + Location( + schema_key="heroic-location", + candidates=( + shared.config_dir / "heroic", + shared.home / ".config" / "heroic", + shared.flatpak_dir + / "com.heroicgameslauncher.hgl" + / "config" + / "heroic", + shared.appdata_dir / "heroic", + ), + paths={ + "config.json": LocationSubPath("config.json"), + "store_config.json": LocationSubPath("store/config.json"), + }, + invalid_subtitle=Location.CONFIG_INVALID_SUBTITLE, + ) + ) diff --git a/src/importer/sources/itch_source.py b/src/importer/sources/itch_source.py index 36e02e0..e39d090 100644 --- a/src/importer/sources/itch_source.py +++ b/src/importer/sources/itch_source.py @@ -86,18 +86,22 @@ class ItchSource(URLExecutableSource): url_format = "itch://caves/{cave_id}/launch" available_on = {"linux", "win32"} - locations = ItchLocations( - Location( - schema_key="itch-location", - candidates=( - shared.flatpak_dir / "io.itch.itch" / "config" / "itch", - shared.config_dir / "itch", - shared.home / ".config" / "itch", - shared.appdata_dir / "itch", - ), - paths={ - "butler.db": LocationSubPath("db/butler.db"), - }, - invalid_subtitle=Location.CONFIG_INVALID_SUBTITLE, + locations: ItchLocations + + def __init__(self) -> None: + super().__init__() + self.locations = ItchLocations( + Location( + schema_key="itch-location", + candidates=( + shared.flatpak_dir / "io.itch.itch" / "config" / "itch", + shared.config_dir / "itch", + shared.home / ".config" / "itch", + shared.appdata_dir / "itch", + ), + paths={ + "butler.db": LocationSubPath("db/butler.db"), + }, + invalid_subtitle=Location.CONFIG_INVALID_SUBTITLE, + ) ) - ) diff --git a/src/importer/sources/legendary_source.py b/src/importer/sources/legendary_source.py index 03bbdd2..9fdb611 100644 --- a/src/importer/sources/legendary_source.py +++ b/src/importer/sources/legendary_source.py @@ -26,7 +26,7 @@ from typing import NamedTuple from src import shared from src.game import Game from src.importer.sources.location import Location, LocationSubPath -from src.importer.sources.source import Source, SourceIterationResult, SourceIterable +from src.importer.sources.source import Source, SourceIterable, SourceIterationResult class LegendarySourceIterable(SourceIterable): @@ -100,17 +100,21 @@ class LegendarySource(Source): available_on = {"linux"} iterable_class = LegendarySourceIterable - locations = LegendaryLocations( - Location( - schema_key="legendary-location", - candidates=( - shared.config_dir / "legendary", - shared.home / ".config" / "legendary", - ), - paths={ - "installed.json": LocationSubPath("installed.json"), - "metadata": LocationSubPath("metadata", True), - }, - invalid_subtitle=Location.CONFIG_INVALID_SUBTITLE, + locations: LegendaryLocations + + def __init__(self) -> None: + super().__init__() + self.locations = LegendaryLocations( + Location( + schema_key="legendary-location", + candidates=( + shared.config_dir / "legendary", + shared.home / ".config" / "legendary", + ), + paths={ + "installed.json": LocationSubPath("installed.json"), + "metadata": LocationSubPath("metadata", True), + }, + invalid_subtitle=Location.CONFIG_INVALID_SUBTITLE, + ) ) - ) diff --git a/src/importer/sources/location.py b/src/importer/sources/location.py index 55684b4..dde8e3f 100644 --- a/src/importer/sources/location.py +++ b/src/importer/sources/location.py @@ -1,7 +1,7 @@ import logging -from pathlib import Path -from typing import Mapping, Iterable, NamedTuple from os import PathLike +from pathlib import Path +from typing import Iterable, Mapping, NamedTuple from src import shared @@ -70,7 +70,7 @@ class Location: def resolve(self) -> None: """Choose a root path from the candidates for the location. - If none fits, raise a UnresolvableLocationError""" + If none fits, raise an UnresolvableLocationError""" if self.root is not None: return diff --git a/src/importer/sources/lutris_source.py b/src/importer/sources/lutris_source.py index 023d3be..dd5defd 100644 --- a/src/importer/sources/lutris_source.py +++ b/src/importer/sources/lutris_source.py @@ -100,33 +100,37 @@ class LutrisSource(URLExecutableSource): # FIXME possible bug: config picks ~/.var... and cache picks ~/.local... - locations = LutrisLocations( - Location( - schema_key="lutris-location", - candidates=( - shared.flatpak_dir / "net.lutris.Lutris" / "data" / "lutris", - shared.data_dir / "lutris", - shared.home / ".local" / "share" / "lutris", - ), - paths={ - "pga.db": LocationSubPath("pga.db"), - }, - invalid_subtitle=Location.DATA_INVALID_SUBTITLE, - ), - Location( - schema_key="lutris-cache-location", - candidates=( - shared.flatpak_dir / "net.lutris.Lutris" / "cache" / "lutris", - shared.cache_dir / "lutris", - shared.home / ".cache" / "lutris", - ), - paths={ - "coverart": LocationSubPath("coverart", True), - }, - invalid_subtitle=Location.CACHE_INVALID_SUBTITLE, - ), - ) + locations: LutrisLocations @property def game_id_format(self): return self.source_id + "_{runner}_{game_id}" + + def __init__(self) -> None: + super().__init__() + self.locations = LutrisLocations( + Location( + schema_key="lutris-location", + candidates=( + shared.flatpak_dir / "net.lutris.Lutris" / "data" / "lutris", + shared.data_dir / "lutris", + shared.home / ".local" / "share" / "lutris", + ), + paths={ + "pga.db": LocationSubPath("pga.db"), + }, + invalid_subtitle=Location.DATA_INVALID_SUBTITLE, + ), + Location( + schema_key="lutris-cache-location", + candidates=( + shared.flatpak_dir / "net.lutris.Lutris" / "cache" / "lutris", + shared.cache_dir / "lutris", + shared.home / ".cache" / "lutris", + ), + paths={ + "coverart": LocationSubPath("coverart", True), + }, + invalid_subtitle=Location.CACHE_INVALID_SUBTITLE, + ), + ) diff --git a/src/importer/sources/retroarch_source.py b/src/importer/sources/retroarch_source.py index 96b16e1..d69970b 100644 --- a/src/importer/sources/retroarch_source.py +++ b/src/importer/sources/retroarch_source.py @@ -145,28 +145,7 @@ class RetroarchSource(Source): available_on = {"linux"} iterable_class = RetroarchSourceIterable - locations = RetroarchLocations( - Location( - schema_key="retroarch-location", - candidates=[ - shared.flatpak_dir / "org.libretro.RetroArch" / "config" / "retroarch", - shared.config_dir / "retroarch", - shared.home / ".config" / "retroarch", - # TODO: Windows support, waiting for executable path setting improvement - # Path("C:\\RetroArch-Win64"), - # Path("C:\\RetroArch-Win32"), - # TODO: UWP support (URL handler - https://github.com/libretro/RetroArch/pull/13563) - # shared.local_appdata_dir - # / "Packages" - # / "1e4cf179-f3c2-404f-b9f3-cb2070a5aad8_8ngdn9a6dx1ma" - # / "LocalState", - ], - paths={ - "retroarch.cfg": LocationSubPath("retroarch.cfg"), - }, - invalid_subtitle=Location.CONFIG_INVALID_SUBTITLE, - ) - ) + locations: RetroarchLocations @property def executable_format(self): @@ -176,15 +155,6 @@ class RetroarchSource(Source): args = '-L "{core_path}" "{rom_path}"' return f"{base} {args}" - def __init__(self) -> None: - super().__init__() - try: - self.locations.config.candidates.append(self.get_steam_location()) - except (OSError, KeyError, UnresolvableLocationError): - logging.debug("Steam isn't installed") - except ValueError as error: - logging.debug("RetroArch Steam location candiate not found", exc_info=error) - def get_steam_location(self) -> str: """ Get the RetroArch installed via Steam location @@ -214,3 +184,37 @@ class RetroarchSource(Source): return Path(f"{library_path}/steamapps/common/RetroArch") # Not found raise ValueError("RetroArch not found in Steam library") + + def __init__(self) -> None: + super().__init__() + self.locations = RetroarchLocations( + Location( + schema_key="retroarch-location", + candidates=[ + shared.flatpak_dir + / "org.libretro.RetroArch" + / "config" + / "retroarch", + shared.config_dir / "retroarch", + shared.home / ".config" / "retroarch", + # TODO: Windows support, waiting for executable path setting improvement + # Path("C:\\RetroArch-Win64"), + # Path("C:\\RetroArch-Win32"), + # TODO: UWP support (URL handler - https://github.com/libretro/RetroArch/pull/13563) + # shared.local_appdata_dir + # / "Packages" + # / "1e4cf179-f3c2-404f-b9f3-cb2070a5aad8_8ngdn9a6dx1ma" + # / "LocalState", + ], + paths={ + "retroarch.cfg": LocationSubPath("retroarch.cfg"), + }, + invalid_subtitle=Location.CONFIG_INVALID_SUBTITLE, + ) + ) + try: + self.locations.config.candidates.append(self.get_steam_location()) + except (OSError, KeyError, UnresolvableLocationError): + logging.debug("Steam isn't installed") + except ValueError as error: + logging.debug("RetroArch Steam location candiate not found", exc_info=error) diff --git a/src/importer/sources/source.py b/src/importer/sources/source.py index 26b2a84..499881a 100644 --- a/src/importer/sources/source.py +++ b/src/importer/sources/source.py @@ -20,7 +20,7 @@ import sys from abc import abstractmethod from collections.abc import Iterable -from typing import Any, Generator, Collection +from typing import Any, Collection, Generator from src.game import Game from src.importer.sources.location import Location @@ -56,6 +56,9 @@ class Source(Iterable): variant: str = None available_on: set[str] = set() iterable_class: type[SourceIterable] + + # NOTE: Locations must be set at __init__ time, not in the class definition. + # They must not be shared between source instances. locations: Collection[Location] @property @@ -85,10 +88,7 @@ class Source(Iterable): Get an iterator for the source :raises UnresolvableLocationError: Not iterable if any of the locations are unresolvable """ - for location_name in ("data", "cache", "config"): - location = getattr(self, f"{location_name}_location", None) - if location is None: - continue + for location in self.locations: location.resolve() return iter(self.iterable_class(self)) diff --git a/src/importer/sources/steam_source.py b/src/importer/sources/steam_source.py index 904fb0b..90460bd 100644 --- a/src/importer/sources/steam_source.py +++ b/src/importer/sources/steam_source.py @@ -120,19 +120,25 @@ class SteamSource(URLExecutableSource): iterable_class = SteamSourceIterable url_format = "steam://rungameid/{game_id}" - locations = SteamLocations( - Location( - schema_key="steam-location", - candidates=( - shared.home / ".steam" / "steam", - shared.data_dir / "Steam", - shared.flatpak_dir / "com.valvesoftware.Steam" / "data" / "Steam", - shared.programfiles32_dir / "Steam", - ), - paths={ - "libraryfolders.vdf": LocationSubPath("steamapps/libraryfolders.vdf"), - "librarycache": LocationSubPath("appcache/librarycache", True), - }, - invalid_subtitle=Location.DATA_INVALID_SUBTITLE, + locations: SteamLocations + + def __init__(self) -> None: + super().__init__() + self.locations = SteamLocations( + Location( + schema_key="steam-location", + candidates=( + shared.home / ".steam" / "steam", + shared.data_dir / "Steam", + shared.flatpak_dir / "com.valvesoftware.Steam" / "data" / "Steam", + shared.programfiles32_dir / "Steam", + ), + paths={ + "libraryfolders.vdf": LocationSubPath( + "steamapps/libraryfolders.vdf" + ), + "librarycache": LocationSubPath("appcache/librarycache", True), + }, + invalid_subtitle=Location.DATA_INVALID_SUBTITLE, + ) ) - ) diff --git a/src/preferences.py b/src/preferences.py index a3172ac..6b3d766 100644 --- a/src/preferences.py +++ b/src/preferences.py @@ -255,20 +255,16 @@ class PreferencesWindow(Adw.PreferencesWindow): shared.win.get_application().quit() - def update_source_action_row_paths(self, source): + def update_source_action_row_paths(self, source: Source): """Set the dir subtitle for a source's action rows""" - for location in ("data", "config", "cache"): + for location_name, location in source.locations._asdict().items(): # Get the action row to subtitle action_row = getattr( - self, f"{source.source_id}_{location}_action_row", None + self, f"{source.source_id}_{location_name}_action_row", None ) if not action_row: continue - - infix = "-cache" if location == "cache" else "" - key = f"{source.source_id}{infix}-location" - path = Path(shared.schema.get_string(key)).expanduser() - + path = Path(shared.schema.get_string(location.schema_key)).expanduser() # Remove the path prefix if picked via Flatpak portal subtitle = re.sub("/run/user/\\d*/doc/.*/", "", str(path)) action_row.set_subtitle(subtitle) @@ -338,28 +334,17 @@ class PreferencesWindow(Adw.PreferencesWindow): return # Good picked location - location = getattr(source.locations, location_name) + location = source.locations._asdict()[location_name] if location.check_candidate(path): - # Set the schema - match location_name: - case "config" | "data": - infix = "" - case _: - infix = f"-{location_name}" - key = f"{source.source_id}{infix}-location" - value = str(path) - shared.schema.set_string(key, value) - # Update the row + shared.schema.set_string(location.schema_key, str(path)) self.update_source_action_row_paths(source) - if self.warning_menu_buttons.get(source.source_id): action_row = getattr( self, f"{source.source_id}_{location_name}_action_row", None ) action_row.remove(self.warning_menu_buttons[source.source_id]) self.warning_menu_buttons.pop(source.source_id) - - logging.debug("User-set value for schema key %s: %s", key, value) + logging.debug("User-set value for %s is %s", location.schema_key, path) # Bad picked location, inform user else: From 73897a9ed3cfae4244649bd848fc2abb62f83f40 Mon Sep 17 00:00:00 2001 From: kramo Date: Wed, 16 Aug 2023 11:07:41 +0200 Subject: [PATCH 11/13] Update translations --- data/gtk/preferences.blp | 2 +- po/POTFILES | 1 + po/cartridges.pot | 127 +++++++++++++++++++++++++-------------- src/game.py | 5 +- 4 files changed, 88 insertions(+), 47 deletions(-) diff --git a/data/gtk/preferences.blp b/data/gtk/preferences.blp index 543a993..c779347 100644 --- a/data/gtk/preferences.blp +++ b/data/gtk/preferences.blp @@ -89,7 +89,7 @@ template $PreferencesWindow : Adw.PreferencesWindow { title: _("Behavior"); Adw.ActionRow { - title: _("Remove Missing Games"); + title: _("Remove Uninstalled Games"); activatable-widget: remove_missing_switch; Switch remove_missing_switch { diff --git a/po/POTFILES b/po/POTFILES index d48bf15..c46d11b 100644 --- a/po/POTFILES +++ b/po/POTFILES @@ -15,6 +15,7 @@ src/game.py src/preferences.py src/utils/create_dialog.py +src/importer/importer.py src/importer/sources/source.py src/importer/sources/location.py src/store/managers/sgdb_manager.py \ No newline at end of file diff --git a/po/cartridges.pot b/po/cartridges.pot index 55050fe..cc46d3b 100644 --- a/po/cartridges.pot +++ b/po/cartridges.pot @@ -8,13 +8,13 @@ msgid "" msgstr "" "Project-Id-Version: Cartridges\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2023-08-13 15:20+0200\n" +"POT-Creation-Date: 2023-08-16 11:06+0200\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" "Language: \n" "MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=CHARSET\n" +"Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" #: data/hu.kramo.Cartridges.desktop.in:3 @@ -59,7 +59,8 @@ msgid "Game Details" msgstr "" #: data/hu.kramo.Cartridges.metainfo.xml.in:42 data/gtk/window.blp:418 -#: src/details_window.py:241 +#: src/details_window.py:241 src/importer/importer.py:292 +#: src/importer/importer.py:342 msgid "Preferences" msgstr "" @@ -129,7 +130,8 @@ msgstr "" msgid "Shortcuts" msgstr "" -#: data/gtk/help-overlay.blp:34 src/game.py:102 src/preferences.py:118 +#: data/gtk/help-overlay.blp:34 src/game.py:103 src/preferences.py:120 +#: src/importer/importer.py:366 msgid "Undo" msgstr "" @@ -157,7 +159,8 @@ msgstr "" msgid "Remove game" msgstr "" -#: data/gtk/preferences.blp:13 data/gtk/preferences.blp:291 +#: data/gtk/preferences.blp:13 data/gtk/preferences.blp:89 +#: data/gtk/preferences.blp:304 msgid "Behavior" msgstr "" @@ -197,106 +200,110 @@ msgstr "" msgid "Import" msgstr "" -#: data/gtk/preferences.blp:89 +#: data/gtk/preferences.blp:92 +msgid "Remove Uninstalled Games" +msgstr "" + +#: data/gtk/preferences.blp:102 msgid "Sources" msgstr "" -#: data/gtk/preferences.blp:92 +#: data/gtk/preferences.blp:105 msgid "Steam" msgstr "" -#: data/gtk/preferences.blp:96 data/gtk/preferences.blp:110 -#: data/gtk/preferences.blp:151 data/gtk/preferences.blp:201 -#: data/gtk/preferences.blp:215 data/gtk/preferences.blp:229 -#: data/gtk/preferences.blp:243 data/gtk/preferences.blp:257 +#: data/gtk/preferences.blp:109 data/gtk/preferences.blp:123 +#: data/gtk/preferences.blp:164 data/gtk/preferences.blp:214 +#: data/gtk/preferences.blp:228 data/gtk/preferences.blp:242 +#: data/gtk/preferences.blp:256 data/gtk/preferences.blp:270 msgid "Install Location" msgstr "" -#: data/gtk/preferences.blp:106 +#: data/gtk/preferences.blp:119 msgid "Lutris" msgstr "" -#: data/gtk/preferences.blp:119 +#: data/gtk/preferences.blp:132 msgid "Cache Location" msgstr "" -#: data/gtk/preferences.blp:128 +#: data/gtk/preferences.blp:141 msgid "Import Steam Games" msgstr "" -#: data/gtk/preferences.blp:137 +#: data/gtk/preferences.blp:150 msgid "Import Flatpak Games" msgstr "" -#: data/gtk/preferences.blp:147 +#: data/gtk/preferences.blp:160 msgid "Heroic" msgstr "" -#: data/gtk/preferences.blp:160 +#: data/gtk/preferences.blp:173 msgid "Import Epic Games" msgstr "" -#: data/gtk/preferences.blp:169 +#: data/gtk/preferences.blp:182 msgid "Import GOG Games" msgstr "" -#: data/gtk/preferences.blp:178 +#: data/gtk/preferences.blp:191 msgid "Import Amazon Games" msgstr "" -#: data/gtk/preferences.blp:187 +#: data/gtk/preferences.blp:200 msgid "Import Sideloaded Games" msgstr "" -#: data/gtk/preferences.blp:197 +#: data/gtk/preferences.blp:210 msgid "Bottles" msgstr "" -#: data/gtk/preferences.blp:211 +#: data/gtk/preferences.blp:224 msgid "itch" msgstr "" -#: data/gtk/preferences.blp:225 +#: data/gtk/preferences.blp:238 msgid "Legendary" msgstr "" -#: data/gtk/preferences.blp:239 +#: data/gtk/preferences.blp:252 msgid "RetroArch" msgstr "" -#: data/gtk/preferences.blp:253 +#: data/gtk/preferences.blp:266 msgid "Flatpak" msgstr "" -#: data/gtk/preferences.blp:266 +#: data/gtk/preferences.blp:279 msgid "Import Game Launchers" msgstr "" -#: data/gtk/preferences.blp:279 +#: data/gtk/preferences.blp:292 msgid "SteamGridDB" msgstr "" -#: data/gtk/preferences.blp:283 +#: data/gtk/preferences.blp:296 msgid "Authentication" msgstr "" -#: data/gtk/preferences.blp:286 +#: data/gtk/preferences.blp:299 msgid "API Key" msgstr "" -#: data/gtk/preferences.blp:294 +#: data/gtk/preferences.blp:307 msgid "Use SteamGridDB" msgstr "" -#: data/gtk/preferences.blp:295 +#: data/gtk/preferences.blp:308 msgid "Download images when adding or importing games" msgstr "" -#: data/gtk/preferences.blp:304 +#: data/gtk/preferences.blp:317 msgid "Prefer Over Official Images" msgstr "" -#: data/gtk/preferences.blp:313 +#: data/gtk/preferences.blp:326 msgid "Prefer Animated Images" msgstr "" @@ -473,52 +480,84 @@ msgid "Couldn't Apply Preferences" msgstr "" #. The variable is the title of the game -#: src/game.py:138 +#: src/game.py:139 msgid "{} launched" msgstr "" #. The variable is the title of the game -#: src/game.py:152 +#: src/game.py:153 msgid "{} hidden" msgstr "" -#: src/game.py:152 +#: src/game.py:153 msgid "{} unhidden" msgstr "" -#: src/game.py:169 +#. The variable is the title of the game +#. The variable is the number of games removed +#: src/game.py:170 src/importer/importer.py:363 msgid "{} removed" msgstr "" -#: src/preferences.py:117 +#: src/preferences.py:119 msgid "All games removed" msgstr "" -#: src/preferences.py:166 +#: src/preferences.py:168 msgid "" "An API key is required to use SteamGridDB. You can generate one {}here{}." msgstr "" -#: src/preferences.py:295 +#: src/preferences.py:294 msgid "Installation Not Found" msgstr "" -#: src/preferences.py:297 +#: src/preferences.py:296 msgid "Select a valid directory." msgstr "" -#: src/preferences.py:363 +#: src/preferences.py:351 msgid "Invalid Directory" msgstr "" -#: src/preferences.py:369 +#: src/preferences.py:357 msgid "Set Location" msgstr "" -#: src/utils/create_dialog.py:25 +#: src/utils/create_dialog.py:25 src/importer/importer.py:291 msgid "Dismiss" msgstr "" +#: src/importer/importer.py:128 +msgid "Importing Games…" +msgstr "" + +#: src/importer/importer.py:290 +msgid "Warning" +msgstr "" + +#: src/importer/importer.py:311 +msgid "The following errors occured during import:" +msgstr "" + +#: src/importer/importer.py:339 +msgid "No new games found" +msgstr "" + +#: src/importer/importer.py:351 +msgid "1 game imported" +msgstr "" + +#. The variable is the number of games +#: src/importer/importer.py:355 +msgid "{} games imported" +msgstr "" + +#. A single game removed +#: src/importer/importer.py:359 +msgid "1 removed" +msgstr "" + #. The variable is the name of the source #: src/importer/sources/location.py:33 msgid "Select the {} cache directory." diff --git a/src/game.py b/src/game.py index 44cabc6..3063633 100644 --- a/src/game.py +++ b/src/game.py @@ -165,9 +165,10 @@ class Game(Gtk.Box): if self.win.stack.get_visible_child() == self.win.details_view: self.win.on_go_back_action() - # The variable is the title of the game self.create_toast( - _("{} removed").format(GLib.markup_escape_text(self.name)), "remove" + # The variable is the title of the game + _("{} removed").format(GLib.markup_escape_text(self.name)), + "remove", ) def set_loading(self, state): From 0d6432388c5a008ddaaae0ca68133a8fd68d3da4 Mon Sep 17 00:00:00 2001 From: kramo Date: Wed, 16 Aug 2023 12:45:32 +0200 Subject: [PATCH 12/13] Handle errors when loading games from disk --- src/main.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/main.py b/src/main.py index 4cd0b6e..96fa420 100644 --- a/src/main.py +++ b/src/main.py @@ -144,7 +144,10 @@ class CartridgesApplication(Adw.Application): def load_games_from_disk(self): if shared.games_dir.is_dir(): for game_file in shared.games_dir.iterdir(): - data = json.load(game_file.open()) + try: + data = json.load(game_file.open()) + except (OSError, json.decoder.JSONDecodeError): + continue game = Game(data) shared.store.add_game(game, {"skip_save": True}) From 8dc96b53b2fc3248599a97dfd9f226e4bc266581 Mon Sep 17 00:00:00 2001 From: kramo Date: Wed, 16 Aug 2023 15:41:40 +0200 Subject: [PATCH 13/13] Type hints for UI code --- src/details_window.py | 40 +++++++++--------- src/game.py | 70 ++++++++++++++++--------------- src/game_cover.py | 45 ++++++++++---------- src/main.py | 51 ++++++++++++----------- src/preferences.py | 47 +++++++++++---------- src/store/pipeline.py | 2 +- src/window.py | 96 ++++++++++++++++++++++--------------------- 7 files changed, 186 insertions(+), 165 deletions(-) diff --git a/src/details_window.py b/src/details_window.py index c437d53..e3cff21 100644 --- a/src/details_window.py +++ b/src/details_window.py @@ -19,6 +19,7 @@ import os from time import time +from typing import Any from gi.repository import Adw, Gio, GLib, Gtk from PIL import Image @@ -52,16 +53,15 @@ class DetailsWindow(Adw.Window): apply_button = Gtk.Template.Child() - cover_changed = False + cover_changed: bool = False - def __init__(self, game=None, **kwargs): + def __init__(self, game: Game | None = None, **kwargs: Any): super().__init__(**kwargs) - self.win = shared.win - self.game = game - self.game_cover = GameCover({self.cover}) + self.game: Game = game + self.game_cover: GameCover = GameCover({self.cover}) - self.set_transient_for(self.win) + self.set_transient_for(shared.win) if self.game: self.set_title(_("Game Details")) @@ -114,7 +114,7 @@ class DetailsWindow(Adw.Window): self.exec_info_label.set_label(exec_info_text) - def clear_info_selection(*_args): + def clear_info_selection(*_args: Any) -> None: self.exec_info_label.select_region(-1, -1) self.exec_info_popover.connect("show", clear_info_selection) @@ -130,13 +130,13 @@ class DetailsWindow(Adw.Window): self.set_focus(self.name) self.present() - def delete_pixbuf(self, *_args): + def delete_pixbuf(self, *_args: Any) -> None: self.game_cover.new_cover() self.cover_button_delete_revealer.set_reveal_child(False) self.cover_changed = True - def apply_preferences(self, *_args): + def apply_preferences(self, *_args: Any) -> None: final_name = self.name.get_text() final_developer = self.developer.get_text() final_executable = self.executable.get_text() @@ -196,10 +196,10 @@ class DetailsWindow(Adw.Window): self.game.developer = final_developer or None self.game.executable = final_executable - if self.game.game_id in self.win.game_covers.keys(): - self.win.game_covers[self.game.game_id].animation = None + if self.game.game_id in shared.win.game_covers.keys(): + shared.win.game_covers[self.game.game_id].animation = None - self.win.game_covers[self.game.game_id] = self.game_cover + shared.win.game_covers[self.game.game_id] = self.game_cover if self.cover_changed: save_cover( @@ -222,9 +222,9 @@ class DetailsWindow(Adw.Window): self.game_cover.pictures.remove(self.cover) self.close() - self.win.show_details_view(self.game) + shared.win.show_details_view(self.game) - def update_cover_callback(self, manager: SGDBManager): + def update_cover_callback(self, manager: SGDBManager) -> None: # Set the game as not loading self.game.set_loading(-1) self.game.update() @@ -241,25 +241,25 @@ class DetailsWindow(Adw.Window): _("Preferences"), ).connect("response", self.update_cover_error_response) - def update_cover_error_response(self, _widget, response): + def update_cover_error_response(self, _widget: Any, response: str) -> None: if response == "open_preferences": shared.win.get_application().on_preferences_action(page_name="sgdb") - def focus_executable(self, *_args): + def focus_executable(self, *_args: Any) -> None: self.set_focus(self.executable) - def toggle_loading(self): + def toggle_loading(self) -> None: self.apply_button.set_sensitive(not self.apply_button.get_sensitive()) self.spinner.set_spinning(not self.spinner.get_spinning()) self.cover_overlay.set_opacity(not self.cover_overlay.get_opacity()) - def set_cover(self, _source, result, *_args): + def set_cover(self, _source: Any, result: Gio.Task, *_args: Any) -> None: try: path = self.file_dialog.open_finish(result).get_path() except GLib.GError: return - def resize(): + def resize() -> None: if cover := resize_cover(path): self.game_cover.new_cover(cover) self.cover_button_delete_revealer.set_reveal_child(True) @@ -269,5 +269,5 @@ class DetailsWindow(Adw.Window): self.toggle_loading() GLib.Thread.new(None, resize) - def choose_cover(self, *_args): + def choose_cover(self, *_args: Any) -> None: self.file_dialog.open(self, None, self.set_cover) diff --git a/src/game.py b/src/game.py index 3063633..edeaad4 100644 --- a/src/game.py +++ b/src/game.py @@ -23,10 +23,12 @@ import shlex import subprocess from pathlib import Path from time import time +from typing import Any from gi.repository import Adw, GLib, GObject, Gtk from src import shared +from src.game_cover import GameCover # pylint: disable=too-many-instance-attributes @@ -45,23 +47,23 @@ class Game(Gtk.Box): game_options = Gtk.Template.Child() hidden_game_options = Gtk.Template.Child() - loading = 0 - filtered = False + loading: int = 0 + filtered: bool = False - added = None - executable = None - game_id = None - source = None - hidden = False - last_played = 0 - name = None - developer = None - removed = False - blacklisted = False - game_cover = None - version = 0 + added: int + executable: str + game_id: str + source: str + hidden: bool = False + last_played: int = 0 + name: str + developer: str | None = None + removed: bool = False + blacklisted: bool = False + game_cover: GameCover = None + version: int = 0 - def __init__(self, data, **kwargs): + def __init__(self, data: dict[str, Any], **kwargs: Any) -> None: super().__init__(**kwargs) self.win = shared.win @@ -82,20 +84,20 @@ class Game(Gtk.Box): shared.schema.connect("changed", self.schema_changed) - def update_values(self, data): + def update_values(self, data: dict[str, Any]) -> None: for key, value in data.items(): # Convert executables to strings if key == "executable" and isinstance(value, list): value = shlex.join(value) setattr(self, key, value) - def update(self): + def update(self) -> None: self.emit("update-ready", {}) - def save(self): + def save(self) -> None: self.emit("save-ready", {}) - def create_toast(self, title, action=None): + def create_toast(self, title: str, action: str | None = None) -> None: toast = Adw.Toast.new(title.format(self.name)) toast.set_priority(Adw.ToastPriority.HIGH) @@ -111,7 +113,7 @@ class Game(Gtk.Box): self.win.toast_overlay.add_toast(toast) - def launch(self): + def launch(self) -> None: self.last_played = int(time()) self.save() self.update() @@ -129,7 +131,7 @@ class Game(Gtk.Box): cwd=Path.home(), shell=True, start_new_session=True, - creationflags=subprocess.CREATE_NEW_PROCESS_GROUP if os.name == "nt" else 0, + creationflags=subprocess.CREATE_NEW_PROCESS_GROUP if os.name == "nt" else 0, # type: ignore ) if shared.schema.get_boolean("exit-after-launch"): @@ -138,7 +140,7 @@ class Game(Gtk.Box): # The variable is the title of the game self.create_toast(_("{} launched")) - def toggle_hidden(self, toast=True): + def toggle_hidden(self, toast: bool = True) -> None: self.hidden = not self.hidden self.save() @@ -156,7 +158,7 @@ class Game(Gtk.Box): "hide", ) - def remove_game(self): + def remove_game(self) -> None: # Add "removed=True" to the game properties so it can be deleted on next init self.removed = True self.save() @@ -171,50 +173,52 @@ class Game(Gtk.Box): "remove", ) - def set_loading(self, state): + def set_loading(self, state: int) -> None: self.loading += state loading = self.loading > 0 self.cover.set_opacity(int(not loading)) self.spinner.set_spinning(loading) - def get_cover_path(self): + def get_cover_path(self) -> Path | None: cover_path = shared.covers_dir / f"{self.game_id}.gif" if cover_path.is_file(): - return cover_path + return cover_path # type: ignore cover_path = shared.covers_dir / f"{self.game_id}.tiff" if cover_path.is_file(): - return cover_path + return cover_path # type: ignore return None - def toggle_play(self, _widget, _prop1, _prop2, state=True): + def toggle_play( + self, _widget: Any, _prop1: Any, _prop2: Any, state: bool = True + ) -> None: if not self.menu_button.get_active(): self.play_revealer.set_reveal_child(not state) self.menu_revealer.set_reveal_child(not state) - def main_button_clicked(self, _widget, button): + def main_button_clicked(self, _widget: Any, button: bool) -> None: if shared.schema.get_boolean("cover-launches-game") ^ button: self.launch() else: self.win.show_details_view(self) - def set_play_icon(self): + def set_play_icon(self) -> None: self.play_button.set_icon_name( "help-about-symbolic" if shared.schema.get_boolean("cover-launches-game") else "media-playback-start-symbolic" ) - def schema_changed(self, _settings, key): + def schema_changed(self, _settings: Any, key: str) -> None: if key == "cover-launches-game": self.set_play_icon() @GObject.Signal(name="update-ready", arg_types=[object]) - def update_ready(self, _additional_data) -> None: + def update_ready(self, _additional_data): # type: ignore """Signal emitted when the game needs updating""" @GObject.Signal(name="save-ready", arg_types=[object]) - def save_ready(self, _additional_data) -> None: + def save_ready(self, _additional_data): # type: ignore """Signal emitted when the game needs saving""" diff --git a/src/game_cover.py b/src/game_cover.py index 073f0c9..24ebf09 100644 --- a/src/game_cover.py +++ b/src/game_cover.py @@ -17,19 +17,22 @@ # # SPDX-License-Identifier: GPL-3.0-or-later -from gi.repository import Gdk, GdkPixbuf, Gio, GLib +from pathlib import Path +from typing import Any, Callable + +from gi.repository import Gdk, GdkPixbuf, Gio, GLib, Gtk from PIL import Image, ImageFilter, ImageStat from src import shared class GameCover: - texture = None - blurred = None - luminance = None - path = None - animation = None - anim_iter = None + texture: Gdk.Texture | None + blurred: Gdk.Texture | None + luminance: tuple[float, float] | None + path: Path | None + animation: GdkPixbuf.PixbufAnimation | None + anim_iter: GdkPixbuf.PixbufAnimationIter | None placeholder = Gdk.Texture.new_from_resource( shared.PREFIX + "/library_placeholder.svg" @@ -38,21 +41,21 @@ class GameCover: shared.PREFIX + "/library_placeholder_small.svg" ) - def __init__(self, pictures, path=None): + def __init__(self, pictures: set[Gtk.Picture], path: Path | None = None) -> None: self.pictures = pictures self.new_cover(path) # Wrap the function in another one as Gio.Task.run_in_thread does not allow for passing args - def create_func(self, path): + def create_func(self, path: Path | None) -> Callable: self.animation = GdkPixbuf.PixbufAnimation.new_from_file(str(path)) self.anim_iter = self.animation.get_iter() - def wrapper(task, *_args): + def wrapper(task: Gio.Task, *_args: Any) -> None: self.update_animation((task, self.animation)) return wrapper - def new_cover(self, path=None): + def new_cover(self, path: Path | None = None) -> None: self.animation = None self.texture = None self.blurred = None @@ -69,14 +72,14 @@ class GameCover: if not self.animation: self.set_texture(self.texture) - def get_texture(self): + def get_texture(self) -> Gdk.Texture: return ( Gdk.Texture.new_for_pixbuf(self.animation.get_static_image()) if self.animation else self.texture ) - def get_blurred(self): + def get_blurred(self) -> Gdk.Texture: if not self.blurred: if self.path: with Image.open(self.path) as image: @@ -94,24 +97,24 @@ class GameCover: stat = ImageStat.Stat(image.convert("L")) # Luminance values for light and dark mode - self.luminance = [ + self.luminance = ( min((stat.mean[0] + stat.extrema[0][0]) / 510, 0.7), max((stat.mean[0] + stat.extrema[0][1]) / 510, 0.3), - ] + ) else: self.blurred = self.placeholder_small self.luminance = (0.3, 0.5) return self.blurred - def add_picture(self, picture): + def add_picture(self, picture: Gtk.Picture) -> None: self.pictures.add(picture) if not self.animation: self.set_texture(self.texture) else: self.update_animation((self.task, self.animation)) - def set_texture(self, texture): + def set_texture(self, texture: Gdk.Texture) -> None: self.pictures.discard( picture for picture in self.pictures if not picture.is_visible() ) @@ -121,13 +124,13 @@ class GameCover: for picture in self.pictures: picture.set_paintable(texture or self.placeholder) - def update_animation(self, data): + def update_animation(self, data: GdkPixbuf.PixbufAnimation) -> None: if self.animation == data[1]: - self.anim_iter.advance() + self.anim_iter.advance() # type: ignore - self.set_texture(Gdk.Texture.new_for_pixbuf(self.anim_iter.get_pixbuf())) + self.set_texture(Gdk.Texture.new_for_pixbuf(self.anim_iter.get_pixbuf())) # type: ignore - delay_time = self.anim_iter.get_delay_time() + delay_time = self.anim_iter.get_delay_time() # type: ignore GLib.timeout_add( 20 if delay_time < 20 else delay_time, self.update_animation, diff --git a/src/main.py b/src/main.py index 96fa420..a1e3fdf 100644 --- a/src/main.py +++ b/src/main.py @@ -21,6 +21,7 @@ import json import lzma import os import sys +from typing import Any import gi @@ -55,15 +56,15 @@ from src.window import CartridgesWindow class CartridgesApplication(Adw.Application): - win = None + win: CartridgesWindow - def __init__(self): + def __init__(self) -> None: shared.store = Store() super().__init__( application_id=shared.APP_ID, flags=Gio.ApplicationFlags.FLAGS_NONE ) - def do_activate(self): # pylint: disable=arguments-differ + def do_activate(self) -> None: # pylint: disable=arguments-differ """Called on app creation""" setup_logging() @@ -141,7 +142,7 @@ class CartridgesApplication(Adw.Application): self.win.present() - def load_games_from_disk(self): + def load_games_from_disk(self) -> None: if shared.games_dir.is_dir(): for game_file in shared.games_dir.iterdir(): try: @@ -151,7 +152,7 @@ class CartridgesApplication(Adw.Application): game = Game(data) shared.store.add_game(game, {"skip_save": True}) - def on_about_action(self, *_args): + def on_about_action(self, *_args: Any) -> None: # Get the debug info from the log files debug_str = "" for i, path in enumerate(shared.log_files): @@ -195,8 +196,12 @@ class CartridgesApplication(Adw.Application): about.present() def on_preferences_action( - self, _action=None, _parameter=None, page_name=None, expander_row=None - ): + self, + _action: Any = None, + _parameter: Any = None, + page_name: (str | None) = None, + expander_row: (str | None) = None, + ) -> CartridgesWindow: win = PreferencesWindow() if page_name: win.set_visible_page_name(page_name) @@ -206,19 +211,19 @@ class CartridgesApplication(Adw.Application): return win - def on_launch_game_action(self, *_args): + def on_launch_game_action(self, *_args: Any) -> None: self.win.active_game.launch() - def on_hide_game_action(self, *_args): + def on_hide_game_action(self, *_args: Any) -> None: self.win.active_game.toggle_hidden() - def on_edit_game_action(self, *_args): + def on_edit_game_action(self, *_args: Any) -> None: DetailsWindow(self.win.active_game) - def on_add_game_action(self, *_args): + def on_add_game_action(self, *_args: Any) -> None: DetailsWindow() - def on_import_action(self, *_args): + def on_import_action(self, *_args: Any) -> None: shared.importer = Importer() if shared.schema.get_boolean("lutris"): @@ -247,35 +252,35 @@ class CartridgesApplication(Adw.Application): shared.importer.run() - def on_remove_game_action(self, *_args): + def on_remove_game_action(self, *_args: Any) -> None: self.win.active_game.remove_game() - def on_remove_game_details_view_action(self, *_args): + def on_remove_game_details_view_action(self, *_args: Any) -> None: if self.win.stack.get_visible_child() == self.win.details_view: self.on_remove_game_action() - def search(self, uri): + def search(self, uri: str) -> None: Gio.AppInfo.launch_default_for_uri(f"{uri}{self.win.active_game.name}") - def on_igdb_search_action(self, *_args): + def on_igdb_search_action(self, *_args: Any) -> None: self.search("https://www.igdb.com/search?type=1&q=") - def on_sgdb_search_action(self, *_args): + def on_sgdb_search_action(self, *_args: Any) -> None: self.search("https://www.steamgriddb.com/search/grids?term=") - def on_protondb_search_action(self, *_args): + def on_protondb_search_action(self, *_args: Any) -> None: self.search("https://www.protondb.com/search?q=") - def on_lutris_search_action(self, *_args): + def on_lutris_search_action(self, *_args: Any) -> None: self.search("https://lutris.net/games?q=") - def on_hltb_search_action(self, *_args): + def on_hltb_search_action(self, *_args: Any) -> None: self.search("https://howlongtobeat.com/?q=") - def on_quit_action(self, *_args): + def on_quit_action(self, *_args: Any) -> None: self.quit() - def create_actions(self, actions): + def create_actions(self, actions: set) -> None: for action in actions: simple_action = Gio.SimpleAction.new(action[0], None) @@ -291,7 +296,7 @@ class CartridgesApplication(Adw.Application): scope.add_action(simple_action) -def main(_version): +def main(_version: int) -> Any: """App entry point""" app = CartridgesApplication() return app.run(sys.argv) diff --git a/src/preferences.py b/src/preferences.py index 6b3d766..c2f2596 100644 --- a/src/preferences.py +++ b/src/preferences.py @@ -21,10 +21,12 @@ import logging import re from pathlib import Path from shutil import rmtree +from typing import Any, Callable from gi.repository import Adw, Gio, GLib, Gtk from src import shared +from src.game import Game from src.importer.sources.bottles_source import BottlesSource from src.importer.sources.flatpak_source import FlatpakSource from src.importer.sources.heroic_source import HeroicSource @@ -107,10 +109,10 @@ class PreferencesWindow(Adw.PreferencesWindow): reset_button = Gtk.Template.Child() remove_all_games_button = Gtk.Template.Child() - removed_games = set() - warning_menu_buttons = {} + removed_games: set[Game] = set() + warning_menu_buttons: dict = {} - def __init__(self, **kwargs): + def __init__(self, **kwargs: Any) -> None: super().__init__(**kwargs) self.win = shared.win self.file_chooser = Gtk.FileDialog() @@ -157,7 +159,7 @@ class PreferencesWindow(Adw.PreferencesWindow): self.init_source_row(source) # SteamGridDB - def sgdb_key_changed(*_args): + def sgdb_key_changed(*_args: Any) -> None: shared.schema.set_string("sgdb-key", self.sgdb_key_entry_row.get_text()) self.sgdb_key_entry_row.set_text(shared.schema.get_string("sgdb-key")) @@ -171,7 +173,7 @@ class PreferencesWindow(Adw.PreferencesWindow): ) ) - def set_sgdb_sensitive(widget): + def set_sgdb_sensitive(widget: Adw.EntryRow) -> None: if not widget.get_text(): shared.schema.set_boolean("sgdb", False) @@ -182,7 +184,7 @@ class PreferencesWindow(Adw.PreferencesWindow): # Switches self.bind_switches( - ( + { "exit-after-launch", "cover-launches-game", "high-quality-images", @@ -197,13 +199,13 @@ class PreferencesWindow(Adw.PreferencesWindow): "sgdb", "sgdb-prefer", "sgdb-animated", - ) + } ) - def get_switch(self, setting): + def get_switch(self, setting: str) -> Any: return getattr(self, f'{setting.replace("-", "_")}_switch') - def bind_switches(self, settings): + def bind_switches(self, settings: set[str]) -> None: for setting in settings: shared.schema.bind( setting, @@ -212,10 +214,12 @@ class PreferencesWindow(Adw.PreferencesWindow): Gio.SettingsBindFlags.DEFAULT, ) - def choose_folder(self, _widget, callback, callback_data=None): + def choose_folder( + self, _widget: Any, callback: Callable, callback_data: str | None = None + ) -> None: self.file_chooser.select_folder(self.win, None, callback, callback_data) - def undo_remove_all(self, *_args): + def undo_remove_all(self, *_args: Any) -> None: for game in self.removed_games: game.removed = False game.save() @@ -224,7 +228,7 @@ class PreferencesWindow(Adw.PreferencesWindow): self.removed_games = set() self.toast.dismiss() - def remove_all_games(self, *_args): + def remove_all_games(self, *_args: Any) -> None: for game in shared.store: if not game.removed: self.removed_games.add(game) @@ -237,7 +241,7 @@ class PreferencesWindow(Adw.PreferencesWindow): self.add_toast(self.toast) - def reset_app(self, *_args): + def reset_app(self, *_args: Any) -> None: rmtree(shared.data_dir / "cartridges", True) rmtree(shared.config_dir / "cartridges", True) rmtree(shared.cache_dir / "cartridges", True) @@ -255,7 +259,7 @@ class PreferencesWindow(Adw.PreferencesWindow): shared.win.get_application().quit() - def update_source_action_row_paths(self, source: Source): + def update_source_action_row_paths(self, source: Source) -> None: """Set the dir subtitle for a source's action rows""" for location_name, location in source.locations._asdict().items(): # Get the action row to subtitle @@ -269,10 +273,10 @@ class PreferencesWindow(Adw.PreferencesWindow): subtitle = re.sub("/run/user/\\d*/doc/.*/", "", str(path)) action_row.set_subtitle(subtitle) - def resolve_locations(self, source: Source): + def resolve_locations(self, source: Source) -> None: """Resolve locations and add a warning if location cannot be found""" - def clear_warning_selection(_widget, label): + def clear_warning_selection(_widget: Any, label: Gtk.Label) -> None: label.select_region(-1, -1) for location_name, location in source.locations._asdict().items(): @@ -322,12 +326,11 @@ class PreferencesWindow(Adw.PreferencesWindow): action_row.add_prefix(menu_button) self.warning_menu_buttons[source.source_id] = menu_button - def init_source_row(self, source: Source): + def init_source_row(self, source: Source) -> None: """Initialize a preference row for a source class""" - def set_dir(_widget, result, location_name): + def set_dir(_widget: Any, result: Gio.Task, location_name: str) -> None: """Callback called when a dir picker button is clicked""" - try: path = Path(self.file_chooser.select_folder_finish(result).get_path()) except GLib.GError: @@ -342,7 +345,9 @@ class PreferencesWindow(Adw.PreferencesWindow): action_row = getattr( self, f"{source.source_id}_{location_name}_action_row", None ) - action_row.remove(self.warning_menu_buttons[source.source_id]) + action_row.remove( # type: ignore + self.warning_menu_buttons[source.source_id] + ) self.warning_menu_buttons.pop(source.source_id) logging.debug("User-set value for %s is %s", location.schema_key, path) @@ -357,7 +362,7 @@ class PreferencesWindow(Adw.PreferencesWindow): _("Set Location"), ) - def on_response(widget, response): + def on_response(widget: Any, response: str) -> None: if response == "choose_folder": self.choose_folder(widget, set_dir, location_name) diff --git a/src/store/pipeline.py b/src/store/pipeline.py index f3f2883..559ee7f 100644 --- a/src/store/pipeline.py +++ b/src/store/pipeline.py @@ -106,5 +106,5 @@ class Pipeline(GObject.Object): self.advance() @GObject.Signal(name="advanced") - def advanced(self) -> None: + def advanced(self): # type: ignore """Signal emitted when the pipeline has advanced""" diff --git a/src/window.py b/src/window.py index ac2ab42..6b485d8 100644 --- a/src/window.py +++ b/src/window.py @@ -17,9 +17,13 @@ # # SPDX-License-Identifier: GPL-3.0-or-later -from gi.repository import Adw, Gtk +from typing import Any + +from gi.repository import Adw, Gio, GLib, Gtk from src import shared +from src.game import Game +from src.game_cover import GameCover from src.utils.relative_date import relative_date @@ -64,13 +68,13 @@ class CartridgesWindow(Adw.ApplicationWindow): hidden_search_entry = Gtk.Template.Child() hidden_search_button = Gtk.Template.Child() - game_covers = {} - toasts = {} - active_game = None - details_view_game_cover = None - sort_state = "a-z" + game_covers: dict = {} + toasts: dict = {} + active_game: Game + details_view_game_cover: GameCover | None = None + sort_state: str = "a-z" - def __init__(self, **kwargs): + def __init__(self, **kwargs: Any) -> None: super().__init__(**kwargs) self.previous_page = self.library_view @@ -110,11 +114,11 @@ class CartridgesWindow(Adw.ApplicationWindow): style_manager.connect("notify::dark", self.set_details_view_opacity) style_manager.connect("notify::high-contrast", self.set_details_view_opacity) - def search_changed(self, _widget, hidden): + def search_changed(self, _widget: Any, hidden: bool) -> None: # Refresh search filter on keystroke in search box (self.hidden_library if hidden else self.library).invalidate_filter() - def set_library_child(self): + def set_library_child(self) -> None: child, hidden_child = self.notice_empty, self.hidden_notice_empty for game in shared.store: @@ -134,7 +138,7 @@ class CartridgesWindow(Adw.ApplicationWindow): self.library_bin.set_child(child) self.hidden_library_bin.set_child(hidden_child) - def filter_func(self, child): + def filter_func(self, child: Gtk.Widget) -> bool: game = child.get_child() text = ( ( @@ -156,10 +160,10 @@ class CartridgesWindow(Adw.ApplicationWindow): return not filtered - def set_active_game(self, _widget, _pspec, game): + def set_active_game(self, _widget: Any, _pspec: Any, game: Game) -> None: self.active_game = game - def show_details_view(self, game): + def show_details_view(self, game: Game) -> None: self.active_game = game self.details_view_cover.set_opacity(int(not game.loading)) @@ -207,7 +211,7 @@ class CartridgesWindow(Adw.ApplicationWindow): self.set_details_view_opacity() - def set_details_view_opacity(self, *_args): + def set_details_view_opacity(self, *_args: Any) -> None: if self.stack.get_visible_child() != self.details_view: return @@ -218,12 +222,12 @@ class CartridgesWindow(Adw.ApplicationWindow): return self.details_view_blurred_cover.set_opacity( - 1 - self.details_view_game_cover.luminance[0] + 1 - self.details_view_game_cover.luminance[0] # type: ignore if style_manager.get_dark() - else self.details_view_game_cover.luminance[1] + else self.details_view_game_cover.luminance[1] # type: ignore ) - def sort_func(self, child1, child2): + def sort_func(self, child1: Gtk.Widget, child2: Gtk.Widget) -> int: var, order = "name", True if self.sort_state in ("newest", "oldest"): @@ -233,7 +237,7 @@ class CartridgesWindow(Adw.ApplicationWindow): elif self.sort_state == "a-z": order = False - def get_value(index): + def get_value(index: int) -> str: return str( getattr((child1.get_child(), child2.get_child())[index], var) ).lower() @@ -243,7 +247,7 @@ class CartridgesWindow(Adw.ApplicationWindow): return ((get_value(0) > get_value(1)) ^ order) * 2 - 1 - def navigate(self, next_page): + def navigate(self, next_page: Gtk.Widget) -> None: levels = (self.library_view, self.hidden_library_view, self.details_view) self.stack.set_transition_type( Gtk.StackTransitionType.UNDER_RIGHT @@ -260,13 +264,13 @@ class CartridgesWindow(Adw.ApplicationWindow): self.stack.set_visible_child(next_page) - def on_go_back_action(self, *_args): + def on_go_back_action(self, *_args: Any) -> None: if self.stack.get_visible_child() == self.hidden_library_view: self.navigate(self.library_view) elif self.stack.get_visible_child() == self.details_view: self.on_go_to_parent_action() - def on_go_to_parent_action(self, *_args): + def on_go_to_parent_action(self, *_args: Any) -> None: if self.stack.get_visible_child() == self.details_view: self.navigate( self.hidden_library_view @@ -274,20 +278,20 @@ class CartridgesWindow(Adw.ApplicationWindow): else self.library_view ) - def on_go_home_action(self, *_args): + def on_go_home_action(self, *_args: Any) -> None: self.navigate(self.library_view) - def on_show_hidden_action(self, *_args): + def on_show_hidden_action(self, *_args: Any) -> None: self.navigate(self.hidden_library_view) - def on_sort_action(self, action, state): + def on_sort_action(self, action: Gio.SimpleAction, state: GLib.Variant) -> None: action.set_state(state) self.sort_state = str(state).strip("'") self.library.invalidate_sort() shared.state_schema.set_string("sort-mode", self.sort_state) - def on_toggle_search_action(self, *_args): + def on_toggle_search_action(self, *_args: Any) -> None: if self.stack.get_visible_child() == self.library_view: search_bar = self.search_bar search_entry = self.search_entry @@ -304,7 +308,7 @@ class CartridgesWindow(Adw.ApplicationWindow): search_entry.set_text("") - def on_escape_action(self, *_args): + def on_escape_action(self, *_args: Any) -> None: if ( self.get_focus() == self.search_entry.get_focus_child() or self.hidden_search_entry.get_focus_child() @@ -313,7 +317,7 @@ class CartridgesWindow(Adw.ApplicationWindow): else: self.on_go_back_action() - def show_details_view_search(self, widget): + def show_details_view_search(self, widget: Gtk.Widget) -> None: library = ( self.hidden_library if widget == self.hidden_search_entry else self.library ) @@ -329,39 +333,39 @@ class CartridgesWindow(Adw.ApplicationWindow): index += 1 - def on_undo_action(self, _widget, game=None, undo=None): + def on_undo_action( + self, _widget: Any, game: Game | None = None, undo: str | None = None + ) -> None: if not game: # If the action was activated via Ctrl + Z if shared.importer and ( shared.importer.imported_game_ids or shared.importer.removed_game_ids ): - undo = "import" - else: - try: - game = tuple(self.toasts.keys())[-1][0] - undo = tuple(self.toasts.keys())[-1][1] - except IndexError: - return + shared.importer.undo_import() + return - if undo == "import": - shared.importer.undo_import() - - elif undo == "hide": - game.toggle_hidden(False) - - elif undo == "remove": - game.removed = False - game.save() - game.update() + try: + game = tuple(self.toasts.keys())[-1][0] + undo = tuple(self.toasts.keys())[-1][1] + except IndexError: + return if game: + if undo == "hide": + game.toggle_hidden(False) + + elif undo == "remove": + game.removed = False + game.save() + game.update() + self.toasts[(game, undo)].dismiss() self.toasts.pop((game, undo)) - def on_open_menu_action(self, *_args): + def on_open_menu_action(self, *_args: Any) -> None: if self.stack.get_visible_child() == self.library_view: self.primary_menu_button.popup() elif self.stack.get_visible_child() == self.hidden_library_view: self.hidden_primary_menu_button.popup() - def on_close_action(self, *_args): + def on_close_action(self, *_args: Any) -> None: self.close()