Replace usages of pkg_resources with importlib (#1428)

Author: pxsit

cms/locale/locale.py

@@ -41,7 +41,7 @@
 import babel.numbers
 import babel.support
 import babel.units
-import pkg_resources
+import importlib.resources
 
 from cms import config
 from cmscommon.datetime import utc
@@ -282,13 +282,25 @@ def get_translations() -> dict[str, Translation]:
     """
     result = {DEFAULT_TRANSLATION.identifier: DEFAULT_TRANSLATION}
 
-    for lang_code in sorted(pkg_resources.resource_listdir("cms.locale", "")):
-        mofile_path = os.path.join(lang_code, "LC_MESSAGES", "cms.mo")
-        if pkg_resources.resource_exists("cms.locale", mofile_path):
-            with pkg_resources.resource_stream("cms.locale", mofile_path) as f:
-                t = Translation(lang_code, f)
-                logger.info("Found translation %s", t.identifier)
-                result[t.identifier] = t
+    try:
+        locale_pkg = importlib.resources.files("cms.locale")
+        for lang_dir in locale_pkg.iterdir():
+            if lang_dir.is_dir():
+                lang_code = lang_dir.name
+                try:
+                    mofile_path = lang_dir / "LC_MESSAGES" / "cms.mo"
+                    with mofile_path.open("rb") as f:
+                        t = Translation(lang_code, f)
+                        logger.info("Found translation %s", t.identifier)
+                        result[t.identifier] = t
+                except Exception:
+                    logger.warning(
+                        "Failed to load translation for %s",
+                        lang_code,
+                        exc_info=True,
+                    )
+    except Exception:
+        logger.warning("Failed to scan locale directory", exc_info=True)
 
     return result
 

cms/plugin.py

@@ -21,7 +21,7 @@
 
 import logging
 
-import pkg_resources
+from importlib.metadata import entry_points
 
 
 logger = logging.getLogger(__name__)
@@ -49,14 +49,17 @@ def plugin_list(entry_point_group: str) -> list[type]:
 
     """
     classes = []
-    for entry_point in pkg_resources.iter_entry_points(entry_point_group):
+    for entry_point in entry_points(group=entry_point_group):
         try:
             classes.append(entry_point.load())
-        except (pkg_resources.UnknownExtra, ImportError):
+        except Exception:
             logger.warning(
-                "Failed to load entry point %s for group %s from %s:%s, "
-                "provided by distribution %s, requiring extras %s.",
-                entry_point.name, entry_point_group, entry_point.module_name,
-                ".".join(entry_point.attrs), entry_point.dist,
-                ", ".join(entry_point.extras), exc_info=True)
+                "Failed to load entry point %s for group %s from %s, "
+                "provided by distribution %s.",
+                entry_point.name,
+                entry_point_group,
+                entry_point.value,
+                entry_point.dist.name if entry_point.dist else "unknown",
+                exc_info=True,
+            )
     return classes

cmsranking/Config.py

@@ -16,14 +16,15 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+import atexit
 import errno
 import logging
 import os
 import sys
 import tomllib
 import typing
 
-import pkg_resources
+import importlib.resources
 
 from cmsranking.Logger import add_file_handler
 
@@ -59,7 +60,11 @@ def __init__(self):
         # Buffers
         self.buffer_size = 100  # Needs to be strictly positive.
 
-        self.web_dir = pkg_resources.resource_filename("cmsranking", "static")
+        # Keep the static files context manager alive for the application lifetime
+        self._static_files_context = importlib.resources.path("cmsranking", "static")
+        self.web_dir = str(self._static_files_context.__enter__())
+        # Register cleanup handler to properly exit the context manager
+        atexit.register(self._static_files_context.__exit__, None, None, None)
 
         # Try to find CMS installation root from the venv in which we run
         self.base_dir = sys.prefix