Hi all, I’m trying to implement a CLI hook (

before_command_run

) but it never seems to execute no matter what kind of CLI command I try (

kedro run

,

kedro info

,

kedro ipython

, etc). I’ve looked at examples in the docs, kedro-telemetry, and plugins from the community but can’t figure it out. Does anyone know what I'm missing or have an example they could share? added to

setup.py

setup(
entry_points={"kedro.cli_hooks": ["test_plugin = plugin:cli_hooks"]},
)

`plugin.py`(currently at the same level as

setup.py

)

import logging
from typing import List
from kedro.framework.cli.hooks import cli_hook_impl
from kedro.framework.startup import ProjectMetadata

logger = logging.getLogger(name)

class ProjectCLIHooks:
  @cli_hook_impl
  def before_command_run(
    self, 
    project_metadata: ProjectMetadata, 
    command_args: List[str],
  ):
    <http://logger.info|logger.info>(
      "Command %s will be run for project %s", command_args, project_metadata
    )

cli_hooks = ProjectCLIHooks()

so have you

pip install -e

the plug-in?

If I rmb even if you do pip install -e, if you register a new entrypoint you have to install it again.

So I don't actually have a full plugin written, I was hoping to use it the same way as regular project hooks & just register a single hook by including a

plugin.py

file. Seems like I'm thinking about this incorrectly?

Ah okay I think there is an easier way to achieve that than writing a full plug-in You can actually introduce your own

cli.py

that will override the run command https://docs.kedro.org/en/0.18.12/development/commands_reference.html#customise-or-override-project-specific-kedro-commands

You can just do this and this moves what you pass to params via CLI. I found it be very simple

That’s beautiful @Fazil B. Topal should include this in the docs!

@datajoely I think you tag the wrong person : p

Thank you all so much for the responses!!

Yeah the omegaconf approach is super elegant

sure, this is the command i run

kedro run --env test --params=countryCode='cz',executionDate='2023-08-13'

I use this in my config files:

${runtimeParam:executionDate}/${runtimeParam:countryCode}

Once omegaconf is tries to load them, it parses using what i sent. screenshot is how i use this in the python testing 🙂

This is honestly a work of art

@Fazil B. Topal Registering custom resolvers through

settings.py

is also a feature we’ve merged already and will be out in the next release! (https://github.com/kedro-org/kedro/issues/2622) and docs for it - https://docs.kedro.org/en/latest/configuration/advanced_configuration.html#how-to-use-resolvers-in-the-omegaconfigloader

yes, i am waiting for the next release to just pass them in settings directly 🙂

Thanks @Fazil B. Topal! Let me fix it before the release 😄

If we can get a null/None support that would also be nice as i wanted to pass null as default in some cases but it wasn't possible 😄

Cc @Fazil B. Topal https://github.com/kedro-org/kedro/commit/dfee6436737fe8f4e907dbd9d45ca9a56441296e , we end up going with this approach. 0.18.13 Release is coming either today or tomorrow.

ah, thanks for notifying! Will try to migrate to latest version when it's out thankyou