Merge pull request ckan#8992 from ckan/update-iter-entry-points

Replace usage of pkg_resources.iter_entry_points, update exception message

Author: wardi

changes/8992.misc

@@ -0,0 +1 @@
+Replace usage of pkg_resources.iter_entry_points, update exception message

ckan/cli/cli.py

@@ -4,7 +4,7 @@
 import logging
 from collections import defaultdict
 from typing import Optional
-from pkg_resources import iter_entry_points
+from importlib.metadata import entry_points
 
 import click
 import sys
@@ -187,7 +187,7 @@ def _get_commands_from_entry_point(entry_point: str = 'ckan.click_command'):
 
     """
     registered_entries = {}
-    for entry in iter_entry_points(entry_point):    # type: ignore
+    for entry in entry_points(group=entry_point):
         if entry.name in registered_entries:
             error_shout((
                 u'Attempt to override entry_point `{name}`.\n'

ckan/plugins/base.py

@@ -36,7 +36,10 @@ def __init__(self, name: str):
         self.name = name
 
     def __str__(self):
-        return f"Interface {self.name} does not exist"
+        return (
+            f"Plugin '{self.name}' not found.\n\n"
+            "Did you install the 'ckanext-*' Python package that contains the plugin?"
+        )
 
 
 class Interface:

ckan/plugins/core.py

@@ -7,7 +7,7 @@
 from contextlib import contextmanager
 from typing import Generic, Iterator, TypeVar
 from typing_extensions import TypeGuard
-from pkg_resources import iter_entry_points
+from importlib.metadata import entry_points
 
 
 from ckan.common import config, aslist
@@ -240,10 +240,10 @@ def _get_service(plugin_name: str) -> Plugin:
     >>> assert isinstance(plugin, ActivityPlugin)
     """
     for group in GROUPS:
-        iterator = iter_entry_points(group=group,name=plugin_name)    # type: ignore
-        plugin = next(iterator, None)
-        if plugin:
-            return plugin.load()(name=plugin_name)
+        ep = entry_points(group=group, name=plugin_name)
+        if ep:
+            return ep[plugin_name].load()(name=plugin_name)
+
     raise PluginNotFoundException(plugin_name)