Skip to content

Commit

Permalink
Refactor setuptools function (kedro-org#3025)
Browse files Browse the repository at this point in the history
* rename cli hooks function to reflect that it supports generic entrypoints not just setuptools

Signed-off-by: Nok <[email protected]>

* Refactor _register_hooks_setuptools

Signed-off-by: Nok <[email protected]>

---------

Signed-off-by: Nok <[email protected]>
  • Loading branch information
noklam authored Sep 19, 2023
1 parent 2b261a1 commit 71e12b1
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
6 changes: 3 additions & 3 deletions kedro/framework/cli/hooks/manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
4 changes: 2 additions & 2 deletions kedro/framework/hooks/manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions kedro/framework/session/session.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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(
Expand Down
4 changes: 2 additions & 2 deletions kedro/runner/parallel_runner.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)

Expand Down
4 changes: 2 additions & 2 deletions tests/framework/session/test_session_extension_hooks.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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


Expand Down

0 comments on commit 71e12b1

Please sign in to comment.