Use shtab for CLI completion

[tshu-w]

I have rised an issue at omni-us/jsonargparse#108, but pytorch-lightning can also do some work with shtab like limiting matching patterns like https://github.com/iterative/shtab#library-usage

I have also arise an issue before #10786

[tshu-w]

I modified cli.parser currently https://github.com/tshu-w/deep-learning-project-template/blob/master/src/lit_cli.py#L98

[mauvilsa]

In jsonargparse v4.30.0 now there is an experimental native shtab support. See the docs

[tshu-w]

@mauvilsa Hi, Thanks for your efforts.

However, I got error when combined these feature with LightningCLI:

from lightning.pytorch.cli import LightningCLI

if __name__ == "__main__":
    cli = LightningCLI()

If I run python test.py --print_shtab=bash, I got:

/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_completions.py:100: UserWarning: Automatic shtab support is experimental and subject to change.
  warnings.warn("Automatic shtab support is experimental and subject to change.", UserWarning)
Traceback (most recent call last):
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_parameter_resolvers.py", line 1030, in get_signature_parameters
    visitor = ParametersVisitor(function_or_class, method_or_property, logger=logger)
              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_parameter_resolvers.py", line 508, in __init__
    self.component, self.parent, _ = get_component_and_parent(function_or_class, method_or_property)
                                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_parameter_resolvers.py", line 490, in get_component_and_parent
    raise ValueError(
ValueError: Invalid or unsupported input: class=<class 'torch.distributed.distributed_c10d.ProcessGroup'>, method_or_property=__init__

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/home/tianshu2020/lightning-template/test.py", line 4, in <module>
    cli = LightningCLI()
          ^^^^^^^^^^^^^^
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/lightning/pytorch/cli.py", line 383, in __init__
    self.parse_arguments(self.parser, args)
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/lightning/pytorch/cli.py", line 534, in parse_arguments
    self.config = parser.parse_args(args)
                  ^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_deprecated.py", line 123, in patched_parse
    cfg = parse_method(*args, _skip_check=_skip_check, **kwargs)
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_core.py", line 396, in parse_args
    cfg, unk = self.parse_known_args(args=args, namespace=cfg)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_core.py", line 264, in parse_known_args
    namespace, args = self._parse_known_args(args, namespace)
                      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/argparse.py", line 2128, in _parse_known_args
    start_index = consume_optional(start_index)
                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/argparse.py", line 2068, in consume_optional
    take_action(action, args, option_string)
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/argparse.py", line 1983, in take_action
    action(self, namespace, argument_values, option_string)
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_completions.py", line 107, in __call__
    shtab_prepare_actions(parser)
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_completions.py", line 133, in shtab_prepare_actions
    shtab_prepare_actions(subparser)
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_completions.py", line 135, in shtab_prepare_actions
    shtab_prepare_action(action, parser)
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_completions.py", line 167, in shtab_prepare_action
    choices = get_typehint_choices(action._typehint, action.option_strings[0], parser, skip)
              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_completions.py", line 241, in get_typehint_choices
    get_typehint_choices(subtype, prefix, parser, skip, choices, added_subclasses)
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_completions.py", line 244, in get_typehint_choices
    choices.extend(add_subactions_and_get_subclass_choices(typehint, prefix, parser, skip, added_subclasses))
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_completions.py", line 279, in add_subactions_and_get_subclass_choices
    subchoices = get_typehint_choices(subtype, option_string, parser, skip, None, added_subclasses)
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_completions.py", line 241, in get_typehint_choices
    get_typehint_choices(subtype, prefix, parser, skip, choices, added_subclasses)
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_completions.py", line 244, in get_typehint_choices
    choices.extend(add_subactions_and_get_subclass_choices(typehint, prefix, parser, skip, added_subclasses))
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_completions.py", line 279, in add_subactions_and_get_subclass_choices
    subchoices = get_typehint_choices(subtype, option_string, parser, skip, None, added_subclasses)
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_completions.py", line 241, in get_typehint_choices
    get_typehint_choices(subtype, prefix, parser, skip, choices, added_subclasses)
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_completions.py", line 244, in get_typehint_choices
    choices.extend(add_subactions_and_get_subclass_choices(typehint, prefix, parser, skip, added_subclasses))
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_completions.py", line 279, in add_subactions_and_get_subclass_choices
    subchoices = get_typehint_choices(subtype, option_string, parser, skip, None, added_subclasses)
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_completions.py", line 241, in get_typehint_choices
    get_typehint_choices(subtype, prefix, parser, skip, choices, added_subclasses)
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_completions.py", line 244, in get_typehint_choices
    choices.extend(add_subactions_and_get_subclass_choices(typehint, prefix, parser, skip, added_subclasses))
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_completions.py", line 265, in add_subactions_and_get_subclass_choices
    params = get_signature_parameters(cls)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_parameter_resolvers.py", line 1043, in get_signature_parameters
    return get_parameters_by_assumptions(function_or_class, method_or_property, logger)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_parameter_resolvers.py", line 850, in get_parameters_by_assumptions
    component, parent, method_name = get_component_and_parent(function_or_class, method_name)
                                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_parameter_resolvers.py", line 490, in get_component_and_parent
    raise ValueError(
ValueError: Invalid or unsupported input: class=<class 'torch.distributed.distributed_c10d.ProcessGroup'>, method_or_property=__init__

[tshu-w]

Sorry about that. This is now fixed with omni-us/jsonargparse#537

Hi, I installed jonargparse from git but am still facing this error, is there anything I did wrong?

λ pip install git+https://github.com/omni-us/jsonargparse@main
Collecting git+https://github.com/omni-us/jsonargparse@main
  Cloning https://github.com/omni-us/jsonargparse (to revision main) to /tmp/pip-req-build-g8mwhey_
  Running command git clone --filter=blob:none --quiet https://github.com/omni-us/jsonargparse /tmp/pip-req-build-g8mwhey_
  Resolved https://github.com/omni-us/jsonargparse to commit 0a4de3112f3ac39d627ca2e7c59014e5f3b3f521
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... done
Requirement already satisfied: PyYAML>=3.13 in /home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages (from jsonargparse==4.30.0) (6.0.1)

λ python test.py --print_shtab=bash
/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_completions.py:100: UserWarning: Automatic shtab support is experimental and subject to change.
  warnings.warn("Automatic shtab support is experimental and subject to change.", UserWarning)
Traceback (most recent call last):
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_parameter_resolvers.py", line 1030, in get_signature_parameters
    visitor = ParametersVisitor(function_or_class, method_or_property, logger=logger)
              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_parameter_resolvers.py", line 508, in __init__
    self.component, self.parent, _ = get_component_and_parent(function_or_class, method_or_property)
                                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/tianshu2020/.local/share/conda/envs/lit-template/lib/python3.11/site-packages/jsonargparse/_parameter_resolvers.py", line 490, in get_component_and_parent
    raise ValueError(
ValueError: Invalid or unsupported input: class=<class 'torch.distributed.distributed_c10d.ProcessGroup'>, method_or_property=__init__

[mauvilsa]

No idea. Are you sure the main branch was installed correctly? From a git repo I normally install as follows, but it shouldn't make a difference.

pip3 install "jsonargparse[signatures] @ https://github.com/omni-us/jsonargparse/zipball/main"

[tshu-w]

Are you sure the main branch was installed correctly?

I think so, the commit 0a4de3112f3ac39d627ca2e7c59014e5f3b3f521 is the latest commit of the main branch. I also tried your command and got the same error.

[mauvilsa]

Is the error the same as your post from June 22? I mean, the stack trace is long? If so, look at where get_signature_parameters appears. If it is not exactly line 266 of _completions.py, then it is using an old jsonargparse version and something weird happened with the installation.

Also note the changes to the code:
https://github.com/omni-us/jsonargparse/blob/1158f1bb96392718cdda9ea4652d058a8f25eb71/jsonargparse/_completions.py#L264-L269
get_signature_parameters is now inside a try-except block, so I don't see how the program would crash.

[tshu-w]

Sorry to interrupt. I uninstall then reinstall and confirm the latest commit works.