From 62c4f79c6792aea4b6f4ffd7ab897a1c2bbe9cc5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9gis=20Behmo?= 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. --- changelog.d/20240212_115536_regis_pkg_resources.md | 1 + tutorecommerce/plugin.py | 8 ++++---- 2 files changed, 5 insertions(+), 4 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 00000000..35b6d201 --- /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/tutorecommerce/plugin.py b/tutorecommerce/plugin.py index 1fe6d2b2..4560ab99 100644 --- a/tutorecommerce/plugin.py +++ b/tutorecommerce/plugin.py @@ -4,7 +4,7 @@ import typing as t from glob import glob -import pkg_resources +import importlib_resources from tutor import hooks as tutor_hooks from tutor.__about__ import __version_suffix__ from tutormfe.hooks import MFE_APPS, MFE_ATTRS_TYPE @@ -88,7 +88,7 @@ def _add_ecommerce_mfe_apps( for service in ("mysql", "lms", "ecommerce"): with open( os.path.join( - pkg_resources.resource_filename("tutorecommerce", "templates"), + str(importlib_resources.files("tutorecommerce") / "templates"), "ecommerce", "tasks", service, @@ -156,7 +156,7 @@ def _add_ecommerce_mfe_apps( ####### Boilerplate code # Add the "templates" folder as a template root tutor_hooks.Filters.ENV_TEMPLATE_ROOTS.add_item( - pkg_resources.resource_filename("tutorecommerce", "templates") + str(importlib_resources.files("tutorecommerce") / "templates") ) # Render the "build" and "apps" folders tutor_hooks.Filters.ENV_TEMPLATE_TARGETS.add_items( @@ -168,7 +168,7 @@ def _add_ecommerce_mfe_apps( # Load patches from files for path in glob( os.path.join( - pkg_resources.resource_filename("tutorecommerce", "patches"), + str(importlib_resources.files("tutorecommerce") / "patches"), "*", ) ):