tutor/tutor-notes
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 795ea5966e
commit c5bd0acab1
2 changed files with 13 additions and 19 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)

31
tutornotes/plugin.py
View File

@ -4,7 +4,7 @@ import os
import typing as t import typing as t
from glob import glob from glob import glob
import pkg_resources import importlib_resources
from tutor import hooks as tutor_hooks from tutor import hooks as tutor_hooks
from tutor.__about__ import __version_suffix__ from tutor.__about__ import __version_suffix__
@ -31,19 +31,17 @@ config = {
}, },
} }
# Initialization hooks # For each service, we load the task template
MY_INIT_TASKS: list[tuple[str, tuple[str, ...]]] = [
("mysql", ("notes", "tasks", "mysql", "init")),
("lms", ("notes", "tasks", "lms", "init")),
("notes", ("notes", "tasks", "notes", "init")),
]
# For each task added to MY_INIT_TASKS, we load the task template
# and add it to the CLI_DO_INIT_TASKS filter, which tells Tutor to # and add it to the CLI_DO_INIT_TASKS filter, which tells Tutor to
# run it as part of the `init` job. # run it as part of the `init` job.
for service, template_path in MY_INIT_TASKS: for service in ["mysql", "lms", "notes"]:
full_path: str = pkg_resources.resource_filename( full_path: str = str(
"tutornotes", os.path.join("templates", *template_path) importlib_resources.files("tutornotes")
/ "templates"
/ "notes"
/ "tasks"
/ service
/ "init"
) )
with open(full_path, encoding="utf-8") as init_task_file: with open(full_path, encoding="utf-8") as init_task_file:
init_task: str = init_task_file.read() init_task: str = init_task_file.read()
@ -91,7 +89,7 @@ def _mount_edx_notes_api(
# Add the "templates" folder as a template root # Add the "templates" folder as a template root
tutor_hooks.Filters.ENV_TEMPLATE_ROOTS.add_item( tutor_hooks.Filters.ENV_TEMPLATE_ROOTS.add_item(
pkg_resources.resource_filename("tutornotes", "templates") str(importlib_resources.files("tutornotes") / "templates")
) )
# Render the "build" and "apps" folders # Render the "build" and "apps" folders
tutor_hooks.Filters.ENV_TEMPLATE_TARGETS.add_items( tutor_hooks.Filters.ENV_TEMPLATE_TARGETS.add_items(
@ -101,12 +99,7 @@ tutor_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("tutornotes") / "patches" / "*")):
os.path.join(
pkg_resources.resource_filename("tutornotes", "patches"),
"*",
)
):
with open(path, encoding="utf-8") as patch_file: with open(path, encoding="utf-8") as patch_file:
tutor_hooks.Filters.ENV_PATCHES.add_item( tutor_hooks.Filters.ENV_PATCHES.add_item(
(os.path.basename(path), patch_file.read()) (os.path.basename(path), patch_file.read())