Skip to content

Commit

Permalink
fix: remove pkg_resources for compatibility with python 3.12
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
regisb committed Feb 12, 2024
1 parent 22e67e7 commit 97600a5
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
1 change: 1 addition & 0 deletions changelog.d/20240212_115536_regis_pkg_resources.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- [Bugfix] Make plugin compatible with Python 3.12 by removing dependency on `pkg_resources`. (by @regisb)
8 changes: 3 additions & 5 deletions tutorcairn/plugin.py
Original file line number Diff line number Diff line change
Expand Up @@ -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__

Expand Down Expand Up @@ -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(
Expand All @@ -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()))

0 comments on commit 97600a5

Please sign in to comment.