upgrade: replace deprecated pkg_resources with importlib, resolves #966

requirements/base.in

@@ -6,3 +6,5 @@ mypy
 pycryptodome>=3.17.0
 pyyaml>=6.0
 typing-extensions>=4.4.0
+importlib-metadata>=7.0.1
+importlib-resources>=6.1.1

tutor.spec

@@ -1,7 +1,7 @@
 # -*- mode: python -*-
 import importlib
 import os
-import pkg_resources
+from importlib_metadata import entry_points
 
 block_cipher = None
 
@@ -10,7 +10,7 @@ hidden_imports = []
 
 # Auto-discover plugins and include patches & templates folders
 for entrypoint_version in ["tutor.plugin.v0", "tutor.plugin.v1"]:
-    for entrypoint in pkg_resources.iter_entry_points(entrypoint_version):
+    for entrypoint in entry_points().select(group=entrypoint_version):
         plugin_name = entrypoint.name
         try:
             plugin = entrypoint.load()

tutor/env.py

@@ -7,13 +7,15 @@
 from copy import deepcopy
 
 import jinja2
-import pkg_resources
+from importlib_resources import files, as_file
 
 from tutor import exceptions, fmt, hooks, plugins, utils
 from tutor.__about__ import __app__, __version__
 from tutor.types import Config, ConfigValue
 
-TEMPLATES_ROOT = pkg_resources.resource_filename("tutor", "templates")
+ref = files("tutor") / "templates"
+with as_file(ref) as path:
+    TEMPLATES_ROOT = str(path)
 VERSION_FILENAME = "version"
 BIN_FILE_EXTENSIONS = [".ico", ".jpg", ".patch", ".png", ".ttf", ".woff", ".woff2"]
 JinjaFilter = t.Callable[..., t.Any]

tutor/plugins/v0.py

@@ -5,7 +5,7 @@
 from glob import glob
 
 import click
-import pkg_resources
+from importlib_metadata import EntryPoint, entry_points, Distribution
 
 from tutor import env, exceptions, fmt, hooks, serialize
 from tutor.__about__ import __app__
@@ -246,12 +246,12 @@ class EntrypointPlugin(BasePlugin):
 
     ENTRYPOINT = "tutor.plugin.v0"
 
-    def __init__(self, entrypoint: pkg_resources.EntryPoint) -> None:
-        self.loader: pkg_resources.EntryPoint
+    def __init__(self, entrypoint: EntryPoint) -> None:
+        self.loader: EntryPoint = entrypoint
         super().__init__(entrypoint.name, entrypoint)
 
     def _load_obj(self) -> None:
-        self.obj = self.loader.load()
+        self.obj = self.loader.load()  # type: ignore[no-untyped-call]
 
     def _version(self) -> t.Optional[str]:
         if not self.loader.dist:
@@ -260,12 +260,11 @@ def _version(self) -> t.Optional[str]:
 
     @classmethod
     def discover_all(cls) -> None:
-        for entrypoint in pkg_resources.iter_entry_points(cls.ENTRYPOINT):
+        entrypoints = entry_points().select(group=cls.ENTRYPOINT)  # type: ignore[no-untyped-call]
+        for entrypoint in entrypoints:
             try:
                 error: t.Optional[str] = None
                 cls(entrypoint)
-            except pkg_resources.VersionConflict as e:
-                error = e.report()
             except Exception as e:  # pylint: disable=broad-except
                 error = str(e)
             if error:

tutor/plugins/v1.py

@@ -2,7 +2,7 @@
 import os
 from glob import glob
 
-import pkg_resources
+from importlib_metadata import entry_points, EntryPoint
 
 from tutor import hooks
 
@@ -26,7 +26,7 @@ def _discover_entrypoint_plugins() -> None:
     """
     with hooks.Contexts.PLUGINS.enter():
         if "TUTOR_IGNORE_ENTRYPOINT_PLUGINS" not in os.environ:
-            for entrypoint in pkg_resources.iter_entry_points("tutor.plugin.v1"):
+            for entrypoint in entry_points().select(group="tutor.plugin.v1"):  # type: ignore[no-untyped-call]
                 discover_package(entrypoint)
 
 
@@ -56,7 +56,7 @@ def load(plugin_name: str) -> None:
             spec.loader.exec_module(module)
 
 
-def discover_package(entrypoint: pkg_resources.EntryPoint) -> None:
+def discover_package(entrypoint: EntryPoint) -> None:
     """
     Install a plugin from a python package.
     """
@@ -68,10 +68,11 @@ def discover_package(entrypoint: pkg_resources.EntryPoint) -> None:
     # Add plugin information
     if entrypoint.dist is None:
         raise ValueError(f"Could not read plugin version: {name}")
-    hooks.Filters.PLUGINS_INFO.add_item((name, entrypoint.dist.version))
+    dist_version = entrypoint.dist.version if entrypoint.dist else "Unknown"
+    hooks.Filters.PLUGINS_INFO.add_item((name, dist_version))
 
     # Import module on enable
     @hooks.Actions.PLUGIN_LOADED.add()
     def load(plugin_name: str) -> None:
         if name == plugin_name:
-            entrypoint.load()
+            entrypoint.load()  # type: ignore[no-untyped-call]

tutor/templates/apps/openedx/settings/partials/common_all.py

@@ -157,7 +157,6 @@
 warnings.filterwarnings("ignore", category=DeprecationWarning, module="wiki.plugins.links.wiki_plugin")
 warnings.filterwarnings("ignore", category=DeprecationWarning, module="boto.plugin")
 warnings.filterwarnings("ignore", category=DeprecationWarning, module="botocore.vendored.requests.packages.urllib3._collections")
-warnings.filterwarnings("ignore", category=DeprecationWarning, module="pkg_resources")
 warnings.filterwarnings("ignore", category=DeprecationWarning, module="fs")
 warnings.filterwarnings("ignore", category=DeprecationWarning, module="fs.opener")
 SILENCED_SYSTEM_CHECKS = ["2_0.W001", "fields.W903"]