How to get native argument values for postinstall hook?

[mgzenitech]

So in my case I'd need to get the value of --with= when doing poetry install and pass it down to postinstall task. How can I pass the value to my function? For example --with=core,dev

[tool.poe.poetry_hooks]
post_install = "_post_install"

[tool.poe.tasks._post_install]
sequence = [
  "_postinstall:install_node",
  "_postinstall:install_node_packages"
]

[tool.poe.tasks."_postinstall:install_node_packages"]
control.print_result = true
control.script = "lib.utils.nodejs.are_packages_valid:are_packages_valid"
default = "pass"

[[tool.poe.tasks."_postinstall:install_node_packages".switch]]
case = "False"
script = "lib.utils.nodejs.sync_packages:sync_packages"

In this case I'd need to pass this argument to both lib.utils.nodejs.are_packages_valid:are_packages_valid and lib.utils.nodejs.sync_packages:sync_packages.

def are_packages_valid(dependency_groups: list[str] | None = None) -> bool:

def sync_packages(dependency_groups: list[str] | None = None) -> None:

[nat-n]

Hi @mgzenitech, Today this is not possible with the poethepoet poetry plugin.

The first problem with this is to determine whether it's possible with the poetry plugin interface. I'd encourage you to poke around in here if you'f like toto help answer that question.

The second problem is how to structure an API that poe could expose to facilitate configuring this. Ideally without deviating too much from how poe normally handled arguments. How would you expect it to work?

[mgzenitech]

For the interface bit we could probably just define arguments next to hook tasks with same name or options? that way people who need those arguments values would get them sorta similar way? I think --with is just one of the examples, potentially any argument passed to poetry install would be candidate for any postinstall hook.

[tool.poe.poetry_hooks]
post_install = "_post_install"

[tool.poe.tasks._post_install]
sequence = [
  "_postinstall:install_node",
  "_postinstall:install_node_packages"
]

[[tool.poe.tasks._post_install.args]]
name = "dependency_groups"
options = [
  "--with"
]

that should be in-line with current poe interface right?

[mgzenitech]

BTW:
Looks like adding args even now works for internal tasks (_).

[tool.poe.tasks._post_install]
sequence = [
  "_postinstall:install_node",
  "_postinstall:install_node_packages"
]

[[tool.poe.tasks._post_install.args]]
name = "dependency_groups"
options = [
  "--with"
]
required = true

usage: poetry poe _post_install --with DEPENDENCY_GROUPS
poetry poe _post_install: error: the following arguments are required: --with

So the only thing that's needed to change in this case would be somehow patching

[tool.poe.poetry_hooks]
post_install = "_post_install"

to pass all arguments to hooks

[mgzenitech]

and this is what chatgpt spit out. Even if it's incorrect maybe it'll give some ideas on how to implement this...

Step 1: Capture Arguments from the Install Command
This can be done by enhancing the _run method where the command is being processed. You can check if the command is install and then store the arguments that follow.

import cleo.application

continue_run = cleo.application.Application._run

def _run(self, io):
    tokens = io.input._tokens
    task_name_index = _index_of_first_non_option(tokens)
    poe_commands = (prefix,) if prefix else task_names
    # Check if the command is 'install'
    if 0 <= task_name_index < len(tokens) and tokens[task_name_index] == 'install':
        # Capture all arguments after 'install'
        install_args = tokens[task_name_index+1:]
        # Store these args in the application for later use
        self.install_args = install_args
    elif 0 <= task_name_index < len(tokens) and tokens[task_name_index] in poe_commands:
        # Insert '--' to handle other poe commands
        tokens.insert(task_name_index, "--")

    return continue_run(self, io)

cleo.application.Application._run = _run

Step 2: Modify the Event Handler to Forward the Arguments
Now that you have captured the arguments, you need to modify the event handler that executes the postinstall hooks to include these arguments.

def _get_command_event_handler(
    self, hooks: Dict[str, str], application: Application
):
    def command_event_handler(
        event: ConsoleCommandEvent,
        event_name: str,
        dispatcher: EventDispatcher,
    ) -> None:
        task = hooks.get(event.command.name)
        if not task:
            return

        import shlex

        # Get the stored install arguments
        install_args = getattr(application, 'install_args', [])

        # Prepare the full command including the install args
        full_args = shlex.split(task) + install_args

        task_status = PoeCommand.get_poe(application, event.io)(
            cli_args=full_args, internal=True
        )

        if task_status:
            event.io.write_line(
                "<error>Cancelling command due to failed hook task</error>"
            )
            raise SystemExit(task_status)

    return command_event_handler