Function test_completion_items_as_choices

tests/test_argparse_utils.py:509–556

Test cmd2's patch to Argparse._check_value() which supports CompletionItems as choices. Choices are compared to CompletionItems.orig_value instead of the CompletionItem instance.

(capsys)

def test_completion_items_as_choices(capsys) -> None:
    """Test cmd2's patch to Argparse._check_value() which supports CompletionItems as choices.
    Choices are compared to CompletionItems.orig_value instead of the CompletionItem instance.
    """

    ##############################################################
    # Test CompletionItems with str values
    ##############################################################
    choices = Choices.from_values(["1", "2"])
    parser = Cmd2ArgumentParser()
    parser.add_argument("choices_arg", type=str, choices=choices)

    # First test valid choices. Confirm the parsed data matches the correct type of str.
    args = parser.parse_args(["1"])
    assert args.choices_arg == "1"

    args = parser.parse_args(["2"])
    assert args.choices_arg == "2"

    # Next test invalid choice
    with pytest.raises(SystemExit):
        args = parser.parse_args(["3"])

    # Confirm error text contains correct value type of str
    _out, err = capsys.readouterr()
    assert "invalid choice: '3' (choose from '1', '2')" in err

    ##############################################################
    # Test CompletionItems with int values
    ##############################################################
    choices = Choices.from_values([1, 2])
    parser = Cmd2ArgumentParser()
    parser.add_argument("choices_arg", type=int, choices=choices)

    # First test valid choices. Confirm the parsed data matches the correct type of int.
    args = parser.parse_args(["1"])
    assert args.choices_arg == 1

    args = parser.parse_args(["2"])
    assert args.choices_arg == 2

    # Next test invalid choice
    with pytest.raises(SystemExit):
        args = parser.parse_args(["3"])

    # Confirm error text contains correct value type of int
    _out, err = capsys.readouterr()
    assert "invalid choice: 3 (choose from 1, 2)" in err


def test_update_prog() -> None: