Updated argparse_custom unit tests.

Author: kmvanbrunt

tests/test_argparse.py

@@ -335,9 +335,7 @@ def base_helpless(self, args) -> None:
     parser_bar.set_defaults(func=base_bar)
 
     # create the parser for the "helpless" subcommand
-    # This subcommand has aliases and no help text. It exists to prevent changes to update_prog() which
-    # use an approach which relies on action._choices_actions list. See comment in that function for more
-    # details.
+    # This subcommand has aliases and no help text.
     parser_helpless = base_subparsers.add_parser('helpless', aliases=['helpless_1', 'helpless_2'])
     parser_helpless.add_argument('z', help='string')
     parser_helpless.set_defaults(func=base_helpless)
@@ -445,19 +443,6 @@ def test_subcommand_invalid_help(subcommand_app) -> None:
     assert out[0].startswith('Usage: base')
 
 
-def test_add_another_subcommand(subcommand_app) -> None:
-    """This tests makes sure update_prog() sets _prog_prefix on every _SubParsersAction so that all future calls
-    to add_parser() write the correct prog value to the parser being added.
-    """
-    base_parser = subcommand_app._command_parsers.get(subcommand_app.do_base)
-    for sub_action in base_parser._actions:
-        if isinstance(sub_action, argparse._SubParsersAction):
-            new_parser = sub_action.add_parser('new_sub', help='stuff')
-            break
-
-    assert new_parser.prog == "base new_sub"
-
-
 def test_subcmd_decorator(subcommand_app) -> None:
     # Test subcommand that has help option
     out, err = run_cmd(subcommand_app, 'test_subcmd_decorator subcmd')

tests/test_argparse_custom.py

@@ -14,10 +14,10 @@
 )
 from cmd2.argparse_custom import (
     Cmd2HelpFormatter,
-    Cmd2RichArgparseConsole,
     generate_range_error,
     register_argparse_argument_parameter,
 )
+from cmd2.rich_utils import Cmd2RichArgparseConsole
 
 from .conftest import run_cmd
 
@@ -476,3 +476,59 @@ def side_effect(color, **kwargs):
     assert mock_set_color.call_count == 2
     mock_set_color.assert_any_call(True, file=sys.stdout)
     mock_set_color.assert_any_call(True)
+
+
+def test_update_prog() -> None:
+    """Test Cmd2ArgumentParser.update_prog() across various scenarios."""
+
+    # Set up a complex parser hierarchy
+    old_root = 'old_app'
+    parser = Cmd2ArgumentParser(prog=old_root)
+
+    # Positionals before subcommand
+    parser.add_argument('pos1')
+
+    # Mutually exclusive group with positionals
+    group = parser.add_mutually_exclusive_group(required=True)
+    group.add_argument('posA', nargs='?')
+    group.add_argument('posB', nargs='?')
+
+    # Subparsers with aliases and no help text
+    subparsers = parser.add_subparsers(dest='cmd')
+
+    # Subcommand with aliases
+    sub1 = subparsers.add_parser('sub1', aliases=['s1', 'alias1'], help='help for sub1')
+
+    # Subcommand with no help text
+    sub2 = subparsers.add_parser('sub2')
+
+    # Nested subparser
+    sub2.add_argument('inner_pos')
+    sub2_subparsers = sub2.add_subparsers(dest='sub2_cmd')
+    leaf = sub2_subparsers.add_parser('leaf', help='leaf help')
+
+    # Verify initial progs look correct
+    assert parser.prog == 'old_app'
+    assert sub1.prog == 'old_app pos1 (posA | posB) sub1'
+    assert sub2.prog == 'old_app pos1 (posA | posB) sub2'
+    assert leaf.prog == 'old_app pos1 (posA | posB) sub2 inner_pos leaf'
+
+    # Perform update
+    new_root = 'new_app'
+    parser.update_prog(new_root)
+
+    # Verify new progs look correct
+    assert parser.prog == 'new_app'
+    assert sub1.prog == 'new_app pos1 (posA | posB) sub1'
+    assert sub2.prog == 'new_app pos1 (posA | posB) sub2'
+    assert leaf.prog == 'new_app pos1 (posA | posB) sub2 inner_pos leaf'
+
+    # Verify that action._prog_prefix was updated by adding a new subparser
+    sub3 = subparsers.add_parser('sub3')
+    assert sub3.prog == 'new_app pos1 (posA | posB) sub3'
+
+    # Verify aliases still point to the correct parser
+    for action in parser._actions:
+        if isinstance(action, argparse._SubParsersAction):
+            assert action.choices['s1'].prog == sub1.prog
+            assert action.choices['alias1'].prog == sub1.prog

tests/test_argparse_subcommands.py

@@ -45,9 +45,7 @@ def base_helpless(self, args) -> None:
     parser_bar.set_defaults(func=base_bar)
 
     # create the parser for the "helpless" subcommand
-    # This subcommand has aliases and no help text. It exists to prevent changes to update_prog() which
-    # use an approach which relies on action._choices_actions list. See comment in that function for more
-    # details.
+    # This subcommand has aliases and no help text.
     parser_helpless = base_subparsers.add_parser('helpless', aliases=['helpless_1', 'helpless_2'])
     parser_helpless.add_argument('z', help='string')
     parser_helpless.set_defaults(func=base_helpless)