From 71e12b113b913b60c3ea69cee64e0049c4f21e52 Mon Sep 17 00:00:00 2001 From: Nok Lam Chan Date: Tue, 19 Sep 2023 11:41:35 +0100 Subject: [PATCH] Refactor setuptools function (#3025) * rename cli hooks function to reflect that it supports generic entrypoints not just setuptools Signed-off-by: Nok * Refactor _register_hooks_setuptools Signed-off-by: Nok --------- Signed-off-by: Nok --- kedro/framework/cli/hooks/manager.py | 6 +++--- kedro/framework/hooks/manager.py | 4 ++-- kedro/framework/session/session.py | 4 ++-- kedro/runner/parallel_runner.py | 4 ++-- tests/framework/session/test_session_extension_hooks.py | 4 ++-- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/kedro/framework/cli/hooks/manager.py b/kedro/framework/cli/hooks/manager.py index a1be3e5784..714f8f780e 100644 --- a/kedro/framework/cli/hooks/manager.py +++ b/kedro/framework/cli/hooks/manager.py @@ -30,10 +30,10 @@ class CLIHooksManager(PluginManager): def __init__(self) -> None: super().__init__(CLI_HOOK_NAMESPACE) self.add_hookspecs(CLICommandSpecs) - self._register_cli_hooks_setuptools() + self._register_cli_hooks() - def _register_cli_hooks_setuptools(self) -> None: - """Register CLI hook implementations from setuptools entrypoints""" + def _register_cli_hooks(self) -> None: + """Register CLI hook implementations from plugin CLI entrypoints""" already_registered = self.get_plugins() self.load_setuptools_entrypoints(_CLI_PLUGIN_HOOKS) diff --git a/kedro/framework/hooks/manager.py b/kedro/framework/hooks/manager.py index 13a8e5a8b2..21bbbd0f3f 100644 --- a/kedro/framework/hooks/manager.py +++ b/kedro/framework/hooks/manager.py @@ -49,10 +49,10 @@ def _register_hooks(hook_manager: PluginManager, hooks: Iterable[Any]) -> None: hook_manager.register(hooks_collection) -def _register_hooks_setuptools( +def _register_hooks_entry_points( hook_manager: PluginManager, disabled_plugins: Iterable[str] ) -> None: - """Register pluggy hooks from setuptools entrypoints. + """Register pluggy hooks from python package entrypoints. Args: hook_manager: Hook manager instance to register the hooks with. diff --git a/kedro/framework/session/session.py b/kedro/framework/session/session.py index 9ff9f5c24b..1a997d6d36 100644 --- a/kedro/framework/session/session.py +++ b/kedro/framework/session/session.py @@ -20,7 +20,7 @@ from kedro.framework.context import KedroContext from kedro.framework.context.context import _convert_paths_to_absolute_posix from kedro.framework.hooks import _create_hook_manager -from kedro.framework.hooks.manager import _register_hooks, _register_hooks_setuptools +from kedro.framework.hooks.manager import _register_hooks, _register_hooks_entry_points from kedro.framework.project import ( configure_logging, pipelines, @@ -117,7 +117,7 @@ def __init__( # noqa: too-many-arguments hook_manager = _create_hook_manager() _register_hooks(hook_manager, settings.HOOKS) - _register_hooks_setuptools(hook_manager, settings.DISABLE_HOOKS_FOR_PLUGINS) + _register_hooks_entry_points(hook_manager, settings.DISABLE_HOOKS_FOR_PLUGINS) self._hook_manager = hook_manager self._conf_source = conf_source or str( diff --git a/kedro/runner/parallel_runner.py b/kedro/runner/parallel_runner.py index 860cefed6a..a152a03a1e 100644 --- a/kedro/runner/parallel_runner.py +++ b/kedro/runner/parallel_runner.py @@ -21,7 +21,7 @@ from kedro.framework.hooks.manager import ( _create_hook_manager, _register_hooks, - _register_hooks_setuptools, + _register_hooks_entry_points, ) from kedro.framework.project import settings from kedro.io import DataCatalog, DatasetError, MemoryDataset @@ -134,7 +134,7 @@ def _run_node_synchronization( # noqa: too-many-arguments hook_manager = _create_hook_manager() _register_hooks(hook_manager, settings.HOOKS) - _register_hooks_setuptools(hook_manager, settings.DISABLE_HOOKS_FOR_PLUGINS) + _register_hooks_entry_points(hook_manager, settings.DISABLE_HOOKS_FOR_PLUGINS) return run_node(node, catalog, hook_manager, is_async, session_id) diff --git a/tests/framework/session/test_session_extension_hooks.py b/tests/framework/session/test_session_extension_hooks.py index 75f3568a5e..0e966c7aa3 100644 --- a/tests/framework/session/test_session_extension_hooks.py +++ b/tests/framework/session/test_session_extension_hooks.py @@ -10,7 +10,7 @@ from kedro.framework.context.context import _convert_paths_to_absolute_posix from kedro.framework.hooks import _create_hook_manager, hook_impl -from kedro.framework.hooks.manager import _register_hooks, _register_hooks_setuptools +from kedro.framework.hooks.manager import _register_hooks, _register_hooks_entry_points from kedro.framework.project import ( _ProjectPipelines, _ProjectSettings, @@ -565,7 +565,7 @@ def memory_catalog(): def hook_manager(): hook_manager = _create_hook_manager() _register_hooks(hook_manager, settings.HOOKS) - _register_hooks_setuptools(hook_manager, settings.DISABLE_HOOKS_FOR_PLUGINS) + _register_hooks_entry_points(hook_manager, settings.DISABLE_HOOKS_FOR_PLUGINS) return hook_manager