From 97600a53507e6949e69f9d698c0d22d0c3d84654 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 + tutorcairn/plugin.py | 8 +++----- 2 files changed, 4 insertions(+), 5 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/tutorcairn/plugin.py b/tutorcairn/plugin.py index 9834ac4..ab4af53 100644 --- a/tutorcairn/plugin.py +++ b/tutorcairn/plugin.py @@ -6,7 +6,7 @@ from glob import glob import click -import pkg_resources +import importlib_resources from tutor import hooks from tutor.__about__ import __version_suffix__ @@ -188,7 +188,7 @@ def create_user_command( ####### Boilerplate code # Add the "templates" folder as a template root hooks.Filters.ENV_TEMPLATE_ROOTS.add_item( - pkg_resources.resource_filename("tutorcairn", "templates") + str(importlib_resources.files("tutorcairn") / "templates") ) # Render the "build" and "apps" folders hooks.Filters.ENV_TEMPLATE_TARGETS.add_items( @@ -198,8 +198,6 @@ def create_user_command( ], ) # Load patches from files -for path in glob( - os.path.join(pkg_resources.resource_filename("tutorcairn", "patches"), "*") -): +for path in glob(str(importlib_resources.files("tutorcairn") / "patches" / "*")): with open(path, encoding="utf-8") as patch_file: hooks.Filters.ENV_PATCHES.add_item((os.path.basename(path), patch_file.read()))