Migrate to importlib.resources

`pkg_resources` is set to be deprecated and removed in the future. Use
the `importlib.resources` standard library module instead to retrieve
resources such as the placeholder icon and script templates.

Author: Matoking

setup.cfg

@@ -28,7 +28,6 @@ package_dir =
     = src
 include_package_data = True
 install_requires =
-    setuptools  # Required for pkg_resources
     vdf>=3.2
     Pillow
 setup_requires =

src/protontricks/cli/desktop_install.py

@@ -3,7 +3,7 @@
 from pathlib import Path
 from subprocess import run
 
-import pkg_resources
+import importlib.resources
 
 from .util import CustomArgumentParser
 
@@ -20,16 +20,19 @@ def install_desktop_entries():
     applications_dir = Path.home() / ".local" / "share" / "applications"
     applications_dir.mkdir(parents=True, exist_ok=True)
 
-    run([
-        "desktop-file-install", "--dir", str(applications_dir),
-        pkg_resources.resource_filename(
-            "protontricks", "data/share/applications/protontricks.desktop"
-        ),
-        pkg_resources.resource_filename(
-            "protontricks",
-            "data/share/applications/protontricks-launch.desktop"
-        )
-    ], check=True)
+    desktop_path_resolver = importlib.resources.path(
+        "protontricks.data.share.applications", "protontricks.desktop"
+    )
+    launch_path_resolver = importlib.resources.path(
+        "protontricks.data.share.applications", "protontricks-launch.desktop"
+    )
+
+    with desktop_path_resolver as desktop_path, \
+            launch_path_resolver as launch_path:
+        run([
+            "desktop-file-install", "--dir", str(applications_dir),
+            str(desktop_path), str(launch_path)
+        ], check=True)
 
     return applications_dir
 

src/protontricks/data/__init__.py

@@ -1,4 +1,5 @@
 import functools
+import importlib.resources
 import itertools
 import json
 import logging
@@ -9,13 +10,12 @@
 from pathlib import Path
 from subprocess import PIPE, CalledProcessError, run
 
-import pkg_resources
 from PIL import Image
 
 from .config import get_config
 from .flatpak import get_inaccessible_paths
-from .util import get_cache_dir
 from .steam import SNAP_STEAM_DIRS
+from .util import get_cache_dir
 
 APP_ICON_SIZE = (32, 32)
 
@@ -60,15 +60,16 @@ def _get_appid2icon(steam_apps):
     Get icons for Steam apps to show in the app selection dialog.
     Return a {appid: icon_path} dict.
     """
-    placeholder_path = Path(
-        pkg_resources.resource_filename(
-            "protontricks", "data/data/icon_placeholder.png"
-        )
-    )
-
     protontricks_icon_dir = get_cache_dir() / "app_icons"
     protontricks_icon_dir.mkdir(exist_ok=True)
 
+    # Write the placeholder from Python package into a more persistent
+    # cache directory
+    with importlib.resources.path(
+            "protontricks.data.data", "icon_placeholder.png") as path:
+        placeholder_path = protontricks_icon_dir / "icon_placeholder.png"
+        placeholder_path.write_bytes(path.read_bytes())
+
     appid2icon = {}
 
     for app in steam_apps:

src/protontricks/data/data/__init__.py

@@ -1,3 +1,4 @@
+import importlib.resources
 import itertools
 import locale
 import logging
@@ -9,8 +10,6 @@
 from pathlib import Path
 from subprocess import DEVNULL, PIPE, Popen, TimeoutExpired, check_output, run
 
-import pkg_resources
-
 __all__ = (
     "SUPPORTED_STEAM_RUNTIMES", "OS_RELEASE_PATHS", "lower_dict",
     "is_steam_deck", "is_steamos", "get_legacy_runtime_library_paths",
@@ -173,26 +172,18 @@ def find_runtime_app_root(runtime_app):
     ])
 
 
-WINE_SCRIPT_TEMPLATE = Path(
-    pkg_resources.resource_filename(
-        "protontricks", "data/scripts/wine_launch.sh"
-    )
-).read_text(encoding="utf-8")
-WINESERVER_KEEPALIVE_SH_SCRIPT = Path(
-    pkg_resources.resource_filename(
-        "protontricks", "data/scripts/wineserver_keepalive.sh"
-    )
-).read_text(encoding="utf-8")
-WINESERVER_KEEPALIVE_BATCH_SCRIPT = Path(
-    pkg_resources.resource_filename(
-        "protontricks", "data/scripts/wineserver_keepalive.bat"
-    )
-).read_text(encoding="utf-8")
-BWRAP_LAUNCHER_SH_SCRIPT = Path(
-    pkg_resources.resource_filename(
-        "protontricks", "data/scripts/bwrap_launcher.sh"
-    )
-).read_text(encoding="utf-8")
+WINE_SCRIPT_TEMPLATE = importlib.resources.read_text(
+    "protontricks.data.scripts", "wine_launch.sh", encoding="utf-8"
+)
+WINESERVER_KEEPALIVE_SH_SCRIPT = importlib.resources.read_text(
+    "protontricks.data.scripts", "wineserver_keepalive.sh", encoding="utf-8"
+)
+WINESERVER_KEEPALIVE_BATCH_SCRIPT = importlib.resources.read_text(
+    "protontricks.data.scripts", "wineserver_keepalive.bat", encoding="utf-8"
+)
+BWRAP_LAUNCHER_SH_SCRIPT = importlib.resources.read_text(
+    "protontricks.data.scripts", "bwrap_launcher.sh", encoding="utf-8"
+)
 
 
 def get_cache_dir():