shtab support for optionals parsed as positionals (#700)

Author: mauvilsa

CHANGELOG.rst

@@ -19,6 +19,8 @@ Added
 ^^^^^
 - ``shtab`` hint for positionals in bash now includes the argument name (`#699
   <https://github.com/omni-us/jsonargparse/pull/699>`__).
+- ``shtab`` support for optionals parsed as positionals (`#700
+  <https://github.com/omni-us/jsonargparse/pull/700>`__).
 
 Changed
 ^^^^^^^

jsonargparse/_completions.py

@@ -6,12 +6,14 @@
 from collections import defaultdict
 from contextlib import contextmanager, suppress
 from contextvars import ContextVar
+from copy import deepcopy
 from enum import Enum
 from importlib.util import find_spec
 from subprocess import PIPE, Popen
 from typing import List, Literal, Union
 
 from ._actions import ActionConfigFile, _ActionConfigLoad, _ActionHelpClassPath, remove_actions
+from ._common import get_optionals_as_positionals_actions, get_parsing_setting
 from ._parameter_resolvers import get_signature_parameters
 from ._typehints import (
     ActionTypeHint,
@@ -129,6 +131,12 @@ def shtab_prepare_actions(parser) -> None:
     if parser._subcommands_action:
         for subparser in parser._subcommands_action._name_parser_map.values():
             shtab_prepare_actions(subparser)
+    if get_parsing_setting("parse_optionals_as_positionals"):
+        for action in get_optionals_as_positionals_actions(parser):
+            clone = deepcopy(action)
+            clone.option_strings = []
+            clone.nargs = "?"
+            parser._actions.append(clone)
     for action in parser._actions:
         shtab_prepare_action(action, parser)
 

jsonargparse_tests/test_shtab.py

@@ -10,7 +10,7 @@
 
 import pytest
 
-from jsonargparse import ArgumentParser
+from jsonargparse import ArgumentParser, set_parsing_settings
 from jsonargparse._completions import norm_name
 from jsonargparse._parameter_resolvers import get_signature_parameters
 from jsonargparse._typehints import type_to_str
@@ -196,6 +196,27 @@ def test_bash_positional(parser, subtests):
     )
 
 
+def test_shtab_bash_optionals_as_positionals(parser, subtests):
+    with patch.dict("jsonargparse._common.parsing_settings"):
+        set_parsing_settings(parse_optionals_as_positionals=True)
+        parser.prog = "tool"
+
+        parser.add_argument("job", type=str)
+        parser.add_argument("--amount", type=int, default=0)
+        parser.add_argument("--flag", type=bool, default=False)
+        assert_bash_typehint_completions(
+            subtests,
+            parser,
+            [
+                ("job", str, "", [], None),
+                ("job", str, "easy", [], None),
+                ("amount", int, "easy ", [], None),
+                ("amount", int, "easy 10", [], None),
+                ("flag", bool, "easy 10 x", [], "0/2"),
+            ],
+        )
+
+
 def test_bash_config(parser):
     parser.add_argument("--cfg", action="config")
     shtab_script = get_shtab_script(parser, "bash")