Merge pull request #106 from dontnod/replace-deprecated-pkg_resources

Replace deprecated pkg resources

Author: Thomas Desveaux

.github/workflows/pylint.yml

@@ -15,13 +15,16 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
+        cache: 'pip'
+        cache-dependency-path: |
+          pyproject.toml
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip

.github/workflows/ruff.yml

@@ -1,10 +1,19 @@
 name: Ruff
-on: [ push, pull_request ]
+on:
+  push:
+    branches:
+      - master
+      - dev
+  pull_request:
+    branches:
+      - master
+      - dev
+
 jobs:
   ruff:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: chartboost/ruff-action@v1
         with:
           src: "./nimp"

.github/workflows/smoke-test.yml

@@ -0,0 +1,32 @@
+name: Smoke test
+on:
+  push:
+    branches:
+      - master
+      - dev
+  pull_request:
+    branches:
+      - master
+      - dev
+
+jobs:
+  smoke:
+    name: Smoke test / python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "${{ matrix.python-version }}"
+          cache: 'pip'
+          cache-dependency-path: |
+            pyproject.toml
+      - name: Install dependencies
+        run: |
+          python -m pip install .
+      - run: nimp check status

nimp/command.py

@@ -23,17 +23,16 @@
 '''Abstract class for commands'''
 
 import abc
+import argparse
 import logging
 import os
-import pkg_resources
 import re
 import sys
-import argparse
 
 import nimp.base_commands
 import nimp.command
-
 from nimp.utils.python import get_class_instances
+from nimp.utils.python import iter_plugins_entry_points
 
 
 class Command(metaclass=abc.ABCMeta):
@@ -142,12 +141,12 @@ def discover(env):
         pass
 
     # Import commands from plugins
-    for entry_point in pkg_resources.iter_entry_points('nimp.plugins'):
+    for entry_point in iter_plugins_entry_points():
         try:
             module = entry_point.load()
             get_class_instances(module, nimp.command.Command, all_commands)
         except Exception as exception:
-            logging.debug("Failed to get platforms from plugin %s", entry_point.module_name, exc_info=exception)
+            logging.debug("Failed to get platforms from plugin %s", entry_point.module, exc_info=exception)
 
     env.command_list = sorted(
         [it for it in all_commands.values() if not it.__class__.__name__.startswith('_')],

nimp/environment.py

@@ -24,21 +24,20 @@
 values and command line parameters set for this nimp execution'''
 
 import argparse
-import re
 import logging
 import os
-import pkg_resources
+import re
 import sys
 import time
 
 import nimp.command
-from nimp.exceptions import NimpCommandFailed
 import nimp.summary
 import nimp.sys.platform
 import nimp.system
 import nimp.unreal
 import nimp.utils.profiling
-
+from nimp.exceptions import NimpCommandFailed
+from nimp.utils.python import iter_plugins_entry_points
 
 _LOG_FORMATS = {  # pylint: disable = invalid-name
     'standard': '%(asctime)s [%(levelname)s] %(message)s'
@@ -394,8 +393,8 @@ def execute_hook(hook_name, *args):
     # Always look for project level hook first
     hook_module = nimp.system.try_import('hooks.' + hook_name)
     if hook_module is None:  # If none found, try plugins level
-        for entry in pkg_resources.iter_entry_points('nimp.plugins'):
-            hook_module = nimp.system.try_import(entry.module_name + '.hooks.' + hook_name)
+        for entry in iter_plugins_entry_points():
+            hook_module = nimp.system.try_import(entry.module + '.hooks.' + hook_name)
             if hook_module:
                 break
     if hook_module is None:

nimp/sys/platform.py

@@ -3,11 +3,10 @@
 import abc
 import logging
 import platform
-import pkg_resources
 
 import nimp.base_platforms
-
 from nimp.utils.python import get_class_instances
+from nimp.utils.python import iter_plugins_entry_points
 
 _all_platforms = {}
 _all_aliases = {}
@@ -74,12 +73,12 @@ def discover(env):
     discovered_platforms = {}
     get_class_instances(nimp.base_platforms, Platform, discovered_platforms, instance_args=[env])
 
-    for module_entrypoint in pkg_resources.iter_entry_points('nimp.plugins'):
+    for module_entrypoint in iter_plugins_entry_points():
         try:
             module = module_entrypoint.load()
             get_class_instances(module, Platform, discovered_platforms, instance_args=[env])
         except Exception as exception:
-            logging.debug("Failed to get platforms from plugin %s", module_entrypoint.module_name, exc_info=exception)
+            logging.debug("Failed to get platforms from plugin %s", module_entrypoint.module, exc_info=exception)
 
     for platform_instance in discovered_platforms.values():
         # Set env.is_win32, env.is_linux, etc. to False by default

nimp/system.py

@@ -23,21 +23,21 @@
 '''System utilities (paths, processes)'''
 
 import fnmatch
+import importlib
 import json
 import logging
 import os
 import re
 import shutil
 import stat
 import time
-import importlib
-import pkg_resources
 
 import glob2
 
 import nimp.environment
 import nimp.sys.platform
 import nimp.sys.process
+from nimp.utils.python import iter_plugins_entry_points
 
 
 def try_import(module_name):
@@ -329,9 +329,9 @@ def load_set(self, set_name):
         try:
             set_module = importlib.import_module('filesets.' + set_module_name)
         except ModuleNotFoundError:
-            for entry in pkg_resources.iter_entry_points('nimp.plugins'):
+            for entry in iter_plugins_entry_points():
                 try:
-                    set_module = importlib.import_module(entry.module_name + '.filesets.' + set_module_name)
+                    set_module = importlib.import_module(entry.module + '.filesets.' + set_module_name)
                     break
                 except ModuleNotFoundError:
                     pass

nimp/utils/python.py

@@ -1,7 +1,15 @@
 '''Helper functions for module handling'''
 
+from __future__ import annotations
+
 import inspect
 import logging
+from importlib.metadata import entry_points
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from importlib.metadata import EntryPoint
+    from typing import Generator
 
 
 def get_class_instances(module, instance_type, result, instance_args=[], instance_kwargs={}):
@@ -32,3 +40,13 @@ def get_class_instances(module, instance_type, result, instance_args=[], instanc
                 result[attribute_value.__name__] = attribute_value(*instance_args, **instance_kwargs)
             except Exception as ex:
                 logging.warning('Error creating %s %s: %s', instance_type.__name__, attribute_value.__name__, ex)
+
+
+def iter_plugins_entry_points() -> Generator[EntryPoint, None, None]:
+    eps = entry_points()
+    if hasattr(eps, "select"):
+        yield from eps.select(group="nimp.plugins")
+    elif hasattr(eps, "get"):
+        yield from eps.get("nimp.plugins", [])
+    else:
+        raise NotImplementedError(f"unexpected value for importlib.metadata.entry_points ({type(eps)})")