Function test_subcommand_attachment

tests/test_argparse_utils.py:337–410

Test Cmd2ArgumentParser convenience methods for attaching and detaching subcommands.

()

def test_subcommand_attachment() -> None:
    """Test Cmd2ArgumentParser convenience methods for attaching and detaching subcommands."""

    ###############################
    # Set up parsers
    ###############################
    root_parser = Cmd2ArgumentParser(prog="root", description="root command")
    root_subparsers = root_parser.add_subparsers()

    child_parser = Cmd2ArgumentParser(prog="child", description="child command")
    child_subparsers = child_parser.add_subparsers()  # Must have subparsers to host grandchild

    grandchild_parser = Cmd2ArgumentParser(prog="grandchild", description="grandchild command")

    ###############################
    # Attach subcommands
    ###############################

    # Attach child to root
    root_parser.attach_subcommand(
        [],
        "child",
        child_parser,
        help="a child command",
        aliases=["child_alias"],
    )

    # Attach grandchild to child
    root_parser.attach_subcommand(
        ["child"],
        "grandchild",
        grandchild_parser,
        help="a grandchild command",
    )

    ###############################
    # Verify hierarchy navigation
    ###############################

    assert root_parser.find_parser(["child", "grandchild"]) is grandchild_parser
    assert root_parser.find_parser(["child"]) is child_parser
    assert root_parser.find_parser([]) is root_parser

    ###############################
    # Verify attachments
    ###############################

    # Verify child attachment and aliases
    assert root_subparsers._name_parser_map["child"] is child_parser
    assert root_subparsers._name_parser_map["child_alias"] is child_parser

    # Verify grandchild attachment
    assert child_subparsers._name_parser_map["grandchild"] is grandchild_parser

    # Verify help entries are present
    assert any(action.dest == "child" for action in root_subparsers._choices_actions)
    assert any(action.dest == "grandchild" for action in child_subparsers._choices_actions)