Add "discover_entry_points_by_name" to "import_tools"

Author: domdfcoding

domdf_python_tools/import_tools.py

@@ -48,15 +48,15 @@
 import inspect
 import pkgutil
 from types import ModuleType
-from typing import Any, Callable, List, Optional, Type, overload
+from typing import Any, Callable, Dict, List, Optional, Type, overload
 
 # 3rd party
 from typing_extensions import Literal
 
 # this package
 from domdf_python_tools.compat import importlib_metadata
 
-__all__ = ["discover", "discover_entry_points"]
+__all__ = ["discover", "discover_entry_points", "discover_entry_points_by_name"]
 
 
 @overload
@@ -158,14 +158,41 @@ def discover_entry_points(
 	:return: List of matching objects.
 	"""
 
-	matching_objects = []
+	return list(discover_entry_points_by_name(group_name, object_match_func=match_func).values())
+
+
+def discover_entry_points_by_name(
+		group_name: str,
+		name_match_func: Optional[Callable[[Any], bool]] = None,
+		object_match_func: Optional[Callable[[Any], bool]] = None,
+		) -> Dict[str, Any]:
+	"""
+	Returns a mapping of entry point names to the entry points in the given category,
+	optionally filtered by ``match_func``.
+
+	.. versionadded:: 2.5.0
+
+	:param group_name: The entry point group name, e.g. ``'entry_points'``.
+	:param name_match_func: Function taking the entry point name and returning :py:obj:`True`
+		if the entry point is to be included in the output.
+	:default name_match_func: :py:obj:`None`, which includes all entry points.
+	:param object_match_func: Function taking an object and returning :py:obj:`True`
+		if the object is to be included in the output.
+	:default object_match_func: :py:obj:`None`, which includes all objects.
+	"""  # noqa: D400
+
+	matching_objects = {}
 
 	for entry_point in importlib_metadata.entry_points().get(group_name, ()):
-		entry_point = entry_point.load()
 
-		if match_func is not None and not match_func(entry_point):
+		if name_match_func is not None and not name_match_func(entry_point.name):
+			continue
+
+		entry_point_obj = entry_point.load()
+
+		if object_match_func is not None and not object_match_func(entry_point_obj):
 			continue
 
-		matching_objects.append(entry_point)
+		matching_objects[entry_point.name] = entry_point_obj
 
 	return matching_objects

tests/test_import_tools.py

@@ -8,7 +8,7 @@
 from pytest_regressions.data_regression import DataRegressionFixture
 
 # this package
-from domdf_python_tools.import_tools import discover, discover_entry_points
+from domdf_python_tools.import_tools import discover, discover_entry_points, discover_entry_points_by_name
 
 sys.path.append('.')
 sys.path.append("tests")
@@ -98,9 +98,19 @@ def test_discover_errors(obj, expects):
 
 
 def test_discover_entry_points(data_regression: DataRegressionFixture):
+	entry_points = discover_entry_points("flake8.extension", lambda f: f.__name__.startswith("break"))
+	data_regression.check([f.__name__ for f in entry_points])
 
-	entry_points = [
-			f.__name__
-			for f in discover_entry_points("flake8.extension", lambda f: f.__name__.startswith("break"))
-			]
-	data_regression.check(entry_points)
+
+def test_discover_entry_points_by_name_object_match_func(data_regression: DataRegressionFixture):
+	entry_points = discover_entry_points_by_name(
+			"flake8.extension", object_match_func=lambda f: f.__name__.startswith("break")
+			)
+	data_regression.check({k: v.__name__ for k, v in entry_points.items()})
+
+
+def test_discover_entry_points_by_name_name_match_func(data_regression: DataRegressionFixture):
+	entry_points = discover_entry_points_by_name(
+			"flake8.extension", name_match_func=lambda n: n.startswith("pycodestyle.")
+			)
+	data_regression.check({k: v.__name__ for k, v in entry_points.items()})

tests/test_import_tools_/test_discover_entry_points_by_name_name_match_func.yml

@@ -0,0 +1,36 @@
+pycodestyle.ambiguous_identifier: ambiguous_identifier
+pycodestyle.bare_except: bare_except
+pycodestyle.blank_lines: blank_lines
+pycodestyle.break_after_binary_operator: break_after_binary_operator
+pycodestyle.break_before_binary_operator: break_before_binary_operator
+pycodestyle.comparison_negative: comparison_negative
+pycodestyle.comparison_to_singleton: comparison_to_singleton
+pycodestyle.comparison_type: comparison_type
+pycodestyle.compound_statements: compound_statements
+pycodestyle.continued_indentation: continued_indentation
+pycodestyle.explicit_line_join: explicit_line_join
+pycodestyle.extraneous_whitespace: extraneous_whitespace
+pycodestyle.imports_on_separate_lines: imports_on_separate_lines
+pycodestyle.indentation: indentation
+pycodestyle.maximum_doc_length: maximum_doc_length
+pycodestyle.maximum_line_length: maximum_line_length
+pycodestyle.missing_whitespace: missing_whitespace
+pycodestyle.missing_whitespace_after_import_keyword: missing_whitespace_after_import_keyword
+pycodestyle.missing_whitespace_around_operator: missing_whitespace_around_operator
+pycodestyle.module_imports_on_top_of_file: module_imports_on_top_of_file
+pycodestyle.python_3000_async_await_keywords: python_3000_async_await_keywords
+pycodestyle.python_3000_backticks: python_3000_backticks
+pycodestyle.python_3000_has_key: python_3000_has_key
+pycodestyle.python_3000_invalid_escape_sequence: python_3000_invalid_escape_sequence
+pycodestyle.python_3000_not_equal: python_3000_not_equal
+pycodestyle.python_3000_raise_comma: python_3000_raise_comma
+pycodestyle.tabs_obsolete: tabs_obsolete
+pycodestyle.tabs_or_spaces: tabs_or_spaces
+pycodestyle.trailing_blank_lines: trailing_blank_lines
+pycodestyle.trailing_whitespace: trailing_whitespace
+pycodestyle.whitespace_around_comma: whitespace_around_comma
+pycodestyle.whitespace_around_keywords: whitespace_around_keywords
+pycodestyle.whitespace_around_named_parameter_equals: whitespace_around_named_parameter_equals
+pycodestyle.whitespace_around_operator: whitespace_around_operator
+pycodestyle.whitespace_before_comment: whitespace_before_comment
+pycodestyle.whitespace_before_parameters: whitespace_before_parameters

tests/test_import_tools_/test_discover_entry_points_by_name_object_match_func.yml

@@ -0,0 +1,2 @@
+pycodestyle.break_after_binary_operator: break_after_binary_operator
+pycodestyle.break_before_binary_operator: break_before_binary_operator