Utility to introspect known command arguments about click

[davidism]

pre-commit only allows adding args to the end

Yeah, but that doesn't prevent you from passing what you want:

command: my_command
additional_args: --opt a my_sub --other b

Besides that, it's already possible to introspect the available options and commands, so I'm not really clear what else would be needed or what it would do.

[LecrisUT]

Let's dig into this a bit more. Consider the .pre-commit-hooks.yaml

- entry: my_command
  args: --opt a my_sub --other b

Now the user would want to add --root /path/to/root to my_command so they write in the .pre-commit-config.yaml

    - id: "..."
      args: [ --root, /path/to/root ]

This is than expanded and used as

$ my_command --opt a my_sub --other b --root /path/to/root

Note how --root is passed to my_sub instead of my_command. I don't remember the documentation page on how to make arguments pass from command to subcommand, but I remember trying that out and having had troubles with clashing kwargs that made adding --root as an option to my_sub and having it transparently passed down to my_command not possible. (Don't remember if it was even possible)

Now handling one argument is doable, but this CLI is growing rather quick and keeping synced all of the possible arguments that it supports can quickly be problematic. That's why it would be useful to write an automatic way of filtering the arguments so that we can re-order the arguments such that internally we have these equivalent:

$ precommit_my_command --opt a my_sub --other b --root /path/to/root
$ my_command --root /path/to/root --opt a my_sub --other b

[LecrisUT]

Besides that, it's already possible to introspect the available options and commands, so I'm not really clear what else would be needed or what it would do.

I couldn't find the relevant API or documentation page.

Oh, if you are referring to inspect.signature, that simply gave me *args, **kwargs.