From ee18c31aab0b9d153f1061b0660ce9917cd3e907 Mon Sep 17 00:00:00 2001
From: Maari Tamm <maari.tamm@cleura.com>
Date: Fri, 15 Mar 2024 15:43:07 +0100
Subject: [PATCH] feat: Support Python 3.12

* Replace the use of pkg_resources (from setuptools, which is
  no longer included in virtual environments as of 3.12) with
  importlib.metadata and importlib_resources.

* Add Python 3.12 to the test matrix.
---
 .github/workflows/tox.yml    |  1 +
 CHANGELOG.md                 |  4 ++++
 tox.ini                      |  3 ++-
 tutorretirement/__about__.py |  5 ++---
 tutorretirement/plugin.py    | 20 ++++++++++----------
 5 files changed, 19 insertions(+), 14 deletions(-)

diff --git a/.github/workflows/tox.yml b/.github/workflows/tox.yml
index b45f86e..ca37cd6 100644
--- a/.github/workflows/tox.yml
+++ b/.github/workflows/tox.yml
@@ -14,6 +14,7 @@ jobs:
           - 3.9
           - "3.10"
           - 3.11
+          - 3.12
 
     steps:
     - name: Check out code
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 2c8c4f8..5368264 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## Unreleased
+
+* [Enhancement] Support Python 3.12.
+
 ## Version 3.2.0 (2024-01-12)
 
 * [Enhancement] Support Tutor 17 and Open edX Quince.
diff --git a/tox.ini b/tox.ini
index cf82b1a..9b98fcd 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,5 +1,5 @@
 [tox]
-envlist = gitlint,py{38,39,310,311},flake8
+envlist = gitlint,py{38,39,310,311,312},flake8
 
 [gh-actions]
 python =
@@ -7,6 +7,7 @@ python =
     3.9: gitlint,py39,flake8
     3.10: gitlint,py310,flake8
     3.11: gitlint,py311,flake8
+    3.12: gitlint,py312,flake8
 
 [flake8]
 ignore = E124,W504
diff --git a/tutorretirement/__about__.py b/tutorretirement/__about__.py
index d2c4c20..4b1cc3f 100644
--- a/tutorretirement/__about__.py
+++ b/tutorretirement/__about__.py
@@ -1,9 +1,8 @@
-import pkg_resources
+from importlib import metadata
 # __version__ attribute as suggested by (deferred) PEP 396:
 # https://www.python.org/dev/peps/pep-0396/
 #
 # Single-source package definition as suggested (among several
 # options) by:
 # https://packaging.python.org/guides/single-sourcing-package-version/
-__version__ = pkg_resources.get_distribution(
-    'tutor-contrib-retirement').version
+__version__ = metadata.version('tutor-contrib-retirement')
diff --git a/tutorretirement/plugin.py b/tutorretirement/plugin.py
index c89c8e1..3ad7fd9 100644
--- a/tutorretirement/plugin.py
+++ b/tutorretirement/plugin.py
@@ -1,7 +1,10 @@
 from .__about__ import __version__
 from glob import glob
 import os
-import pkg_resources
+# When Tutor drops support for Python 3.8, we'll need to update this to:
+# from importlib import resources as importlib_resources
+# See: https://github.com/overhangio/tutor/issues/966#issuecomment-1938681102
+import importlib_resources
 import click
 from tutor import hooks
 from tutor import config as tutor_config
@@ -54,7 +57,7 @@ def retire_users(context):
 
 # Add the "templates" folder as a template root
 hooks.Filters.ENV_TEMPLATE_ROOTS.add_item(
-    pkg_resources.resource_filename("tutorretirement", "templates")
+    str(importlib_resources.files("tutorretirement") / "templates")
 )
 # Render the "build" and "apps" folders
 hooks.Filters.ENV_TEMPLATE_TARGETS.add_items(
@@ -64,12 +67,9 @@ def retire_users(context):
     ],
 )
 # Load patches from files
-for path in glob(
-    os.path.join(
-        pkg_resources.resource_filename("tutorretirement", "patches"),
-        "*",
-    )
-):
+for path in glob(str(
+        importlib_resources.files("tutorretirement") / "patches" / "*")):
+
     with open(path, encoding="utf-8") as patch_file:
         hooks.Filters.ENV_PATCHES.add_item(
             (os.path.basename(path), patch_file.read())
@@ -92,8 +92,8 @@ def retire_users(context):
 )
 
 # Add init task
-path = pkg_resources.resource_filename(
-    "tutorretirement", os.path.join(
+path = str(importlib_resources.files(
+    "tutorretirement") / os.path.join(
         "templates", "retirement", "tasks", "lms", "init")
 )
 with open(path, encoding="utf-8") as task_file: