tutor/tutor-cairn
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: remove pkg_resources for compatibility with python 3.12

Browse Source 
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.
This commit is contained in:
Régis Behmo 2024-02-06 11:41:23 +01:00
parent 22e67e757c
commit 97600a5350
2 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/20240212_115536_regis_pkg_resources.md Normal file
View File

@ -0,0 +1 @@
- [Bugfix] Make plugin compatible with Python 3.12 by removing dependency on `pkg_resources`. (by @regisb)

8
tutorcairn/plugin.py
View File

@ -6,7 +6,7 @@ import typing as t
from glob import glob from glob import glob
import click import click
import pkg_resources import importlib_resources
from tutor import hooks from tutor import hooks
from tutor.__about__ import __version_suffix__ from tutor.__about__ import __version_suffix__
@ -188,7 +188,7 @@ hooks.Filters.CLI_DO_COMMANDS.add_item(create_user_command)
####### Boilerplate code ####### Boilerplate code
# Add the "templates" folder as a template root # Add the "templates" folder as a template root
hooks.Filters.ENV_TEMPLATE_ROOTS.add_item( 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 # Render the "build" and "apps" folders
hooks.Filters.ENV_TEMPLATE_TARGETS.add_items( hooks.Filters.ENV_TEMPLATE_TARGETS.add_items(
@ -198,8 +198,6 @@ hooks.Filters.ENV_TEMPLATE_TARGETS.add_items(
], ],
) )
# Load patches from files # Load patches from files
for path in glob( for path in glob(str(importlib_resources.files("tutorcairn") / "patches" / "*")):
os.path.join(pkg_resources.resource_filename("tutorcairn", "patches"), "*")
):
with open(path, encoding="utf-8") as patch_file: with open(path, encoding="utf-8") as patch_file:
hooks.Filters.ENV_PATCHES.add_item((os.path.basename(path), patch_file.read())) hooks.Filters.ENV_PATCHES.add_item((os.path.basename(path), patch_file.read()))