CLI: fix choices of InteractiveOption not being displayed

[sphuber]

Fixes #5406

The choices of interactive options were not being displayed in
interactive mode when the special character ? was passed. This bug was
introduced when click_completion was dropped for the tab-completion
feature that ships with click itself as of v8.0. The complete method
changed from complete to shell_complete and the get_help_message
of the InteractiveOption was not properly updated.

[mbercx]

Doing a bit of field testing... Seems that the help message doesn't show properly for ON_COMPUTER option:

Installed on target computer? [Y/n]: ?
Error: invalid input

And some options show None next to the choices:

Computer: ?     
Name of the computer, on which the code is installed.
Select one of:
localhost    None

Default calculation input plugin: ?
Entry point name of the default calculation plugin (as listed in 'verdi plugin list aiida.calculations').
Select one of:
aiida.calculations:arithmetic.add None
aiida.calculations:core.arithmetic.add None
[...]

I'm assuming because choice.help is None, but not sure when this is not the case?

[sphuber]

yeah the help always being shown is my bad, pushed a fix. The first problem you highlight is due to something else and not related to this fix. I suspect that the validation of type (which is a boolean) is called before it hits our override. Will look into fixing it

[sphuber]

The problem with the help not being displayed for --on-computer is because it is a boolean flag, and click.Option.prompt_for_value makes an exception in the handling for these types. It doesn't call the prompt of our InteractiveOption (which handles the ? characters) but it goes straight to click.confirm which only allows y and n or otherwise prints invalid input. Don't see an easy way to make this behave nicely without entirely replacing part of their implementation which would be sensitive to breaking in the future.

[mbercx]

Alright, I won't push the scope creep since we want this in the release, but maybe we should open an issue for the boolean option prompts?

[sphuber]

Alright, I won't push the scope creep since we want this in the release, but maybe we should open an issue for the boolean option prompts?

Yeah I am working on it now and if I cannot fix it soon, will open an issue and describe what I found so far.