shtab support for optionals parsed as positionals

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_parsing_settings.py

@@ -1,5 +1,6 @@
 import re
 from dataclasses import dataclass
+from importlib.util import find_spec
 from typing import Literal, Optional
 from unittest.mock import patch
 
@@ -8,6 +9,7 @@
 from jsonargparse import ActionYesNo, ArgumentError, Namespace, set_parsing_settings
 from jsonargparse._common import get_parsing_setting
 from jsonargparse_tests.conftest import capture_logs, get_parse_args_stdout, get_parser_help
+from jsonargparse_tests.test_shtab import assert_bash_typehint_completions
 from jsonargparse_tests.test_typehints import Optimizer
 
 
@@ -152,3 +154,24 @@ def test_optionals_as_positionals_unsupported_arguments(parser):
 
     help_str = get_parse_args_stdout(parser, ["--o1.help=Adam"])
     assert "extra positionals are parsed as optionals in the order shown above" not in help_str
+
+
+@pytest.mark.skipif(not find_spec("shtab"), reason="shtab package is required")
+def test_shtab_bash_optionals_as_positionals(parser, subtests):
+    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"),
+        ],
+    )