Moved _check_value() override to Cmd2ArgumentParser.

Removed set_ap_completer_type() and get_ap_completer_type() since
ap_completer_type is now a public member of Cmd2ArgumentParser.

Author: kmvanbrunt

CHANGELOG.md

@@ -66,6 +66,8 @@ prompt is displayed.
     - Removed `Cmd.ruler` since `cmd2` no longer uses it.
     - All parsers used with `cmd2` commands much be an instance of `Cmd2ArgumentParser` or a child
       class of it.
+    - Removed `set_ap_completer_type()` and `get_ap_completer_type()` since `ap_completer_type` is
+      now a public member of `Cmd2ArgumentParser`.
 - Enhancements
     - New `cmd2.Cmd` parameters
         - **auto_suggest**: (boolean) if `True`, provide fish shell style auto-suggestions. These

cmd2/argparse_custom.py

@@ -229,11 +229,6 @@ def get_choices(self) -> Choices:
 - ``argparse.Action.get_suppress_tab_hint()`` - See ``_action_get_suppress_tab_hint`` for more details.
 - ``argparse.Action.set_suppress_tab_hint()`` - See ``_action_set_suppress_tab_hint`` for more details.
 
-cmd2 has patched ``argparse.ArgumentParser`` to include the following accessor methods
-
-- ``argparse.ArgumentParser.get_ap_completer_type()`` - See ``_ArgumentParser_get_ap_completer_type`` for more details.
-- ``argparse.Action.set_ap_completer_type()`` - See ``_ArgumentParser_set_ap_completer_type`` for more details.
-
 **Subcommand Manipulation**
 
 cmd2 has patched ``argparse._SubParsersAction`` with new functions to better facilitate the
@@ -810,76 +805,6 @@ def _add_argument_wrapper(
 setattr(argparse._ActionsContainer, 'add_argument', _add_argument_wrapper)
 
 
-############################################################################################################
-# Patch argparse.ArgumentParser with accessors for ap_completer_type attribute
-############################################################################################################
-
-# An ArgumentParser attribute which specifies a subclass of ArgparseCompleter for custom completion behavior on a
-# given parser. If this is None or not present, then cmd2 will use argparse_completer.DEFAULT_AP_COMPLETER when tab
-# completing a parser's arguments
-ATTR_AP_COMPLETER_TYPE = 'ap_completer_type'
-
-
-def _ArgumentParser_get_ap_completer_type(self: argparse.ArgumentParser) -> type['ArgparseCompleter'] | None:  # noqa: N802
-    """Get the ap_completer_type attribute of an argparse ArgumentParser.
-
-    This function is added by cmd2 as a method called ``get_ap_completer_type()`` to ``argparse.ArgumentParser`` class.
-
-    To call: ``parser.get_ap_completer_type()``
-
-    :param self: ArgumentParser being queried
-    :return: An ArgparseCompleter-based class or None if attribute does not exist
-    """
-    return cast(type['ArgparseCompleter'] | None, getattr(self, ATTR_AP_COMPLETER_TYPE, None))
-
-
-setattr(argparse.ArgumentParser, 'get_ap_completer_type', _ArgumentParser_get_ap_completer_type)
-
-
-def _ArgumentParser_set_ap_completer_type(self: argparse.ArgumentParser, ap_completer_type: type['ArgparseCompleter']) -> None:  # noqa: N802
-    """Set the ap_completer_type attribute of an argparse ArgumentParser.
-
-    This function is added by cmd2 as a method called ``set_ap_completer_type()`` to ``argparse.ArgumentParser`` class.
-
-    To call: ``parser.set_ap_completer_type(ap_completer_type)``
-
-    :param self: ArgumentParser being edited
-    :param ap_completer_type: the custom ArgparseCompleter-based class to use when completing arguments for this parser
-    """
-    setattr(self, ATTR_AP_COMPLETER_TYPE, ap_completer_type)
-
-
-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 attach_parser function
 ############################################################################################################
@@ -1221,7 +1146,7 @@ def __init__(
         self.description: RenderableType | None  # type: ignore[assignment]
         self.epilog: RenderableType | None  # type: ignore[assignment]
 
-        self.set_ap_completer_type(ap_completer_type)  # type: ignore[attr-defined]
+        self.ap_completer_type = ap_completer_type
 
     def add_subparsers(self, **kwargs: Any) -> argparse._SubParsersAction:  # type: ignore[type-arg]
         """Add a subcommand parser.
@@ -1296,6 +1221,27 @@ def _match_argument(self, action: argparse.Action, arg_strings_pattern: str) ->
 
         return super()._match_argument(action, arg_strings_pattern)
 
+    def _check_value(self, action: argparse.Action, value: Any) -> None:
+        """Override that supports CompletionItems as choices.
+
+        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)
+
 
 class Cmd2AttributeWrapper:
     """Wraps a cmd2-specific attribute added to an argparse Namespace.

cmd2/cmd2.py

@@ -62,7 +62,6 @@
     TYPE_CHECKING,
     Any,
     TextIO,
-    TypeAlias,
     TypeVar,
     Union,
     cast,
@@ -2351,12 +2350,9 @@ def _determine_ap_completer_type(parser: Cmd2ArgumentParser) -> type[argparse_co
         :param parser: the parser to examine
         :return: type of ArgparseCompleter
         """
-        APCompleterType: TypeAlias = type[argparse_completer.ArgparseCompleter] | None
-        completer_type: APCompleterType = parser.get_ap_completer_type()  # type: ignore[attr-defined]
-
-        if completer_type is None:
-            completer_type = argparse_completer.DEFAULT_AP_COMPLETER
-        return completer_type
+        if parser.ap_completer_type is None:
+            return argparse_completer.DEFAULT_AP_COMPLETER
+        return parser.ap_completer_type
 
     def _perform_completion(
         self, text: str, line: str, begidx: int, endidx: int, custom_settings: utils.CustomCompletionSettings | None = None

tests/test_argparse_completer.py

@@ -1421,8 +1421,10 @@ def test_add_parser_custom_completer() -> None:
     parser = Cmd2ArgumentParser()
     subparsers = parser.add_subparsers()
 
-    no_custom_completer_parser = subparsers.add_parser(name="no_custom_completer")
-    assert no_custom_completer_parser.get_ap_completer_type() is None  # type: ignore[attr-defined]
+    no_custom_completer_parser: Cmd2ArgumentParser = subparsers.add_parser(name="no_custom_completer")
+    assert no_custom_completer_parser.ap_completer_type is None
 
-    custom_completer_parser = subparsers.add_parser(name="custom_completer", ap_completer_type=CustomCompleter)
-    assert custom_completer_parser.get_ap_completer_type() is CustomCompleter  # type: ignore[attr-defined]
+    custom_completer_parser: Cmd2ArgumentParser = subparsers.add_parser(
+        name="custom_completer", ap_completer_type=CustomCompleter
+    )
+    assert custom_completer_parser.ap_completer_type is CustomCompleter