Fixed tests in test_argparse_custom.py.

Author: kmvanbrunt

cmd2/argparse_custom.py

@@ -284,6 +284,7 @@ def get_items(self) -> list[CompletionItems]:
 from .completion import (
     ChoicesProviderUnbound,
     CompleterUnbound,
+    CompletionItem,
 )
 from .rich_utils import Cmd2RichArgparseConsole
 from .styles import Cmd2Style
@@ -901,6 +902,34 @@ def _ArgumentParser_set_ap_completer_type(self: argparse.ArgumentParser, ap_comp
 setattr(argparse.ArgumentParser, 'set_ap_completer_type', _ArgumentParser_set_ap_completer_type)
 
 
+############################################################################################################
+# Patch ArgumentParser._check_value to support CompletionItems as choices
+############################################################################################################
+def _ArgumentParser_check_value(_self: argparse.ArgumentParser, action: argparse.Action, value: Any) -> None:  # noqa: N802
+    """Check_value that supports CompletionItems as choices (Custom override of ArgumentParser._check_value).
+
+    When displaying choices, use CompletionItem.value instead of the CompletionItem instance.
+
+    :param self: ArgumentParser instance
+    :param action: the action being populated
+    :param value: value from command line already run through conversion function by argparse
+    """
+    # Import gettext like argparse does
+    from gettext import (
+        gettext as _,
+    )
+
+    if action.choices is not None and value not in action.choices:
+        # If any choice is a CompletionItem, then display its value property.
+        choices = [c.value if isinstance(c, CompletionItem) else c for c in action.choices]
+        args = {'value': value, 'choices': ', '.join(map(repr, choices))}
+        msg = _('invalid choice: %(value)r (choose from %(choices)s)')
+        raise ArgumentError(action, msg % args)
+
+
+setattr(argparse.ArgumentParser, '_check_value', _ArgumentParser_check_value)
+
+
 ############################################################################################################
 # Patch argparse._SubParsersAction to add remove_parser function
 ############################################################################################################

tests/test_argparse_custom.py

@@ -6,6 +6,7 @@
 
 import cmd2
 from cmd2 import (
+    Choices,
     Cmd2ArgumentParser,
     constants,
 )
@@ -292,14 +293,11 @@ 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.
     """
-    from cmd2.argparse_custom import (
-        CompletionItem,
-    )
 
     ##############################################################
     # Test CompletionItems with str values
     ##############################################################
-    choices = [CompletionItem("1", "Description One"), CompletionItem("2", "Two")]
+    choices = Choices.from_values(["1", "2"])
     parser = Cmd2ArgumentParser()
     parser.add_argument("choices_arg", type=str, choices=choices)
 
@@ -321,7 +319,7 @@ def test_completion_items_as_choices(capsys) -> None:
     ##############################################################
     # Test CompletionItems with int values
     ##############################################################
-    choices = [CompletionItem(1, "Description One"), CompletionItem(2, "Two")]
+    choices = Choices.from_values([1, 2])
     parser = Cmd2ArgumentParser()
     parser.add_argument("choices_arg", type=int, choices=choices)