From d1c67f42d92176737beb29794ab6da17685f6e37 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9gis=20Behmo?= <regis@behmo.com>
Date: Tue, 6 Feb 2024 11:41:23 +0100
Subject: [PATCH] fix: remove pkg_resources for compatibility with python 3.12

pkg_resources is a package that is unavailable in python 3.12, unless
setuptools is explicitely installed. Turns out, there are replacement
functions coming from importlib_resources, which can be obtained from
the importlib-resources pypi package. This package will be installed
with tutor starting from 17.0.2.
---
 .../20240212_115536_regis_pkg_resources.md    |  1 +
 tutorxqueue/plugin.py                         | 41 +++++++------------
 2 files changed, 15 insertions(+), 27 deletions(-)
 create mode 100644 changelog.d/20240212_115536_regis_pkg_resources.md

diff --git a/changelog.d/20240212_115536_regis_pkg_resources.md b/changelog.d/20240212_115536_regis_pkg_resources.md
new file mode 100644
index 0000000..35b6d20
--- /dev/null
+++ b/changelog.d/20240212_115536_regis_pkg_resources.md
@@ -0,0 +1 @@
+- [Bugfix] Make plugin compatible with Python 3.12 by removing dependency on `pkg_resources`. (by @regisb)
diff --git a/tutorxqueue/plugin.py b/tutorxqueue/plugin.py
index d5f143a..25ac8e3 100644
--- a/tutorxqueue/plugin.py
+++ b/tutorxqueue/plugin.py
@@ -6,10 +6,9 @@
 from typing import Any, Literal, Optional, Union
 
 import click
-import pkg_resources
+import importlib_resources
 import requests  # type: ignore
 from tutor import config as tutor_config
-from tutor.__about__ import __version_suffix__
 from tutor import exceptions
 from tutor import hooks as tutor_hooks
 from tutor.__about__ import __version_suffix__
@@ -39,22 +38,17 @@
 }
 
 # Initialization hooks
-
-# To add a custom initialization task, create a bash script template under:
-# tutorxqueue/templates/xqueue/tasks/
-# and then add it to the MY_INIT_TASKS list. Each task is in the format:
-# ("<service>", ("<path>", "<to>", "<script>", "<template>"))
-MY_INIT_TASKS: list[tuple[str, tuple[str, ...]]] = [
-    ("mysql", ("xqueue", "tasks", "mysql", "init")),
-    ("xqueue", ("xqueue", "tasks", "xqueue", "init")),
-]
-
-# For each task added to MY_INIT_TASKS, we load the task template
+# For each service that needs to be initialized, we load the task template
 # and add it to the CLI_DO_INIT_TASKS filter, which tells Tutor to
 # run it as part of the `init` job.
-for service, template_path in MY_INIT_TASKS:
-    full_path: str = pkg_resources.resource_filename(
-        "tutorxqueue", os.path.join("templates", *template_path)
+for service in ["mysql", "xqueue"]:
+    full_path: str = str(
+        importlib_resources.files("tutorxqueue")
+        / "templates"
+        / "xqueue"
+        / "tasks"
+        / service
+        / "init"
     )
     with open(full_path, encoding="utf-8") as init_task_file:
         init_task: str = init_task_file.read()
@@ -185,7 +179,7 @@ def __init__(self, user_config: dict[str, Any], url: str = "") -> None:
         if not self.base_url:
             scheme = "https" if user_config["ENABLE_HTTPS"] else "http"
             host = user_config["XQUEUE_HOST"]
-            self.base_url = "{}://{}".format(scheme, host)
+            self.base_url = f"{scheme}://{host}"
         self.login()
 
     @property
@@ -208,9 +202,7 @@ def login(self) -> None:
         message = response.get("content")
         if message != "Logged in":
             raise exceptions.TutorError(
-                "Could not login to xqueue server at {}. Response: '{}'".format(
-                    self.base_url, message
-                )
+                f"Could not login to xqueue server at {self.base_url}. Response: '{message}'"
             )
 
     def show_submission(self, queue: str) -> Union[dict[str, Any], Any]:
@@ -280,7 +272,7 @@ def request(
 
 # Add the "templates" folder as a template root
 tutor_hooks.Filters.ENV_TEMPLATE_ROOTS.add_item(
-    pkg_resources.resource_filename("tutorxqueue", "templates")
+    str(importlib_resources.files("tutorxqueue") / "templates")
 )
 # Render the "build" and "apps" folders
 tutor_hooks.Filters.ENV_TEMPLATE_TARGETS.add_items(
@@ -290,12 +282,7 @@ def request(
     ],
 )
 # Load patches from files
-for path in glob(
-    os.path.join(
-        pkg_resources.resource_filename("tutorxqueue", "patches"),
-        "*",
-    )
-):
+for path in glob(str(importlib_resources.files("tutorxqueue") / "patches" / "*")):
     with open(path, encoding="utf-8") as patch_file:
         tutor_hooks.Filters.ENV_PATCHES.add_item(
             (os.path.basename(path), patch_file.read())