From 5d5241d198e57dd72cf254727bb5e7f8c3780f87 Mon Sep 17 00:00:00 2001
From: Emad Rad <codewithemad@gmail.com>
Date: Sun, 18 Feb 2024 20:23:58 +0330
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.
---
 CHANGELOG.md                                     |  1 +
 docs/migrating-from-v0-plugins.rst               | 11 ++++-------
 .../{{ cookiecutter.module_name }}/plugin.py     | 16 ++++++----------
 3 files changed, 11 insertions(+), 17 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 7161989..d0f841c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -11,6 +11,7 @@ Please respect the following instructions:
 ## 2024-01-01
 
 - [Improvement] Happy New Year!
+  - Fix compatibility issue with Python 3.12 by removing dependency on `pkg_resources`.
   - Cookiecutter hooks to check input data validation.
   - Various licenses support.
   - New documentation format.
diff --git a/docs/migrating-from-v0-plugins.rst b/docs/migrating-from-v0-plugins.rst
index 8054819..836e5e8 100644
--- a/docs/migrating-from-v0-plugins.rst
+++ b/docs/migrating-from-v0-plugins.rst
@@ -83,7 +83,7 @@ The plugin API was upgraded from ``v0`` to ``v1`` in `Tutor v13.2.0 <https://git
         ####### Boilerplate code
         # Add the "templates" folder as a template root
         hooks.Filters.ENV_TEMPLATE_ROOTS.add_item(
-            pkg_resources.resource_filename("tutoryourplugin", "templates")
+            str(importlib_resources.files("tutoryourplugin") / "templates")
         )
         # Render the "build" and "apps" folders
         hooks.Filters.ENV_TEMPLATE_TARGETS.add_items(
@@ -94,10 +94,7 @@ The plugin API was upgraded from ``v0`` to ``v1`` in `Tutor v13.2.0 <https://git
         )
         # Load patches from files
         for path in glob(
-            os.path.join(
-                pkg_resources.resource_filename("tutoryourplugin", "patches"),
-                "*",
-            )
+            str(importlib_resources.files("tutoryourplugin") / "patches" / "*")
         ):
             with open(path, encoding="utf-8") as patch_file:
                 hooks.Filters.ENV_PATCHES.add_item((os.path.basename(path), patch_file.read()))
@@ -118,8 +115,8 @@ The plugin API was upgraded from ``v0`` to ``v1`` in `Tutor v13.2.0 <https://git
         # For each task added to MY_INIT_TASKS, 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, priority in MY_INIT_TASKS:
-            full_path: str = pkg_resources.resource_filename(
-                "tutoryourplugin", os.path.join("templates", *template_path)
+            full_path: str = str(importlib_resources.files(
+                "tutoryourplugin") / os.path.join("templates", *template_path)
             )
             with open(full_path, encoding="utf-8") as init_task_file:
                 init_task: str = init_task_file.read()
diff --git a/{{ cookiecutter.package_name }}/{{ cookiecutter.module_name }}/plugin.py b/{{ cookiecutter.package_name }}/{{ cookiecutter.module_name }}/plugin.py
index f7dc9e7..dd427f7 100644
--- a/{{ cookiecutter.package_name }}/{{ cookiecutter.module_name }}/plugin.py	
+++ b/{{ cookiecutter.package_name }}/{{ cookiecutter.module_name }}/plugin.py	
@@ -4,7 +4,7 @@
 from glob import glob
 
 import click
-import pkg_resources
+import importlib_resources
 from tutor import hooks
 
 from .__about__ import __version__
@@ -63,8 +63,9 @@
 # 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(
-        "{{ cookiecutter.module_name }}", os.path.join("templates", *template_path)
+    full_path: str = str(
+        importlib_resources.files("{{ cookiecutter.module_name }}")
+        / os.path.join("templates", *template_path)
     )
     with open(full_path, encoding="utf-8") as init_task_file:
         init_task: str = init_task_file.read()
@@ -131,7 +132,7 @@
 hooks.Filters.ENV_TEMPLATE_ROOTS.add_items(
     # Root paths for template files, relative to the project root.
     [
-        pkg_resources.resource_filename("{{ cookiecutter.module_name }}", "templates"),
+        str(importlib_resources.files("{{ cookiecutter.module_name }}") / "templates"),
     ]
 )
 
@@ -156,12 +157,7 @@
 
 # For each file in {{ cookiecutter.module_name }}/patches,
 # apply a patch based on the file's name and contents.
-for path in glob(
-    os.path.join(
-        pkg_resources.resource_filename("{{ cookiecutter.module_name }}", "patches"),
-        "*",
-    )
-):
+for path in glob(str(importlib_resources.files("{{ cookiecutter.module_name }}") / "patches" / "*")):
     with open(path, encoding="utf-8") as patch_file:
         hooks.Filters.ENV_PATCHES.add_item((os.path.basename(path), patch_file.read()))