Renamed AP_COMMAND_ATTR_SPEC to ARGPARSE_COMMAND_ATTR_SPEC to be more specific.

Author: kmvanbrunt

cmd2/annotated.py

@@ -213,7 +213,7 @@ def do_paint(
 from . import constants
 from .argparse_utils import (
     DEFAULT_ARGUMENT_PARSER,
-    ApCommandSpec,
+    ArgparseCommandSpec,
     Cmd2ArgumentParser,
     SubcommandSpec,
 )
@@ -2329,11 +2329,11 @@ def cmd_wrapper(*args: Any, **kwargs: Any) -> bool | None:
             )
             return result
 
-        ap_command_spec = ApCommandSpec(
+        argparse_command_spec = ArgparseCommandSpec(
             parser_source=parser_builder,
             preserve_quotes=preserve_quotes,
         )
-        setattr(cmd_wrapper, constants.AP_COMMAND_ATTR_SPEC, ap_command_spec)
+        setattr(cmd_wrapper, constants.ARGPARSE_COMMAND_ATTR_SPEC, argparse_command_spec)
 
         return cmd_wrapper
 

cmd2/argparse_utils.py

@@ -292,7 +292,7 @@ def get_choices(self) -> Choices:
 
 
 @dataclass(kw_only=True)
-class ApCommandSpec:
+class ArgparseCommandSpec:
     """Metadata for an argparse-based command function.
 
     :param parser_source: an existing Cmd2ArgumentParser instance or a factory

cmd2/cmd2.py

@@ -111,7 +111,7 @@
 from . import rich_utils as ru
 from . import string_utils as su
 from .argparse_utils import (
-    ApCommandSpec,
+    ArgparseCommandSpec,
     Cmd2ArgumentParser,
     ParserSource,
     SubcommandRecord,
@@ -281,7 +281,7 @@ def get(self, command_method: BoundCommandFunc) -> Cmd2ArgumentParser | None:
                 return None
             command = command_method.__name__[len(COMMAND_FUNC_PREFIX) :]
 
-            spec: ApCommandSpec | None = getattr(command_method, constants.AP_COMMAND_ATTR_SPEC, None)
+            spec: ArgparseCommandSpec | None = getattr(command_method, constants.ARGPARSE_COMMAND_ATTR_SPEC, None)
             if spec is None:
                 return None
 
@@ -2530,7 +2530,7 @@ def _perform_completion(
 
                     if command_func is not None and argparser is not None:
                         # Get arguments for complete()
-                        spec: ApCommandSpec = getattr(command_func, constants.AP_COMMAND_ATTR_SPEC)
+                        spec: ArgparseCommandSpec = getattr(command_func, constants.ARGPARSE_COMMAND_ATTR_SPEC)
                         cmd_set = self.find_commandset_for_command(command)
 
                         # Create the argparse completer

cmd2/constants.py

@@ -72,8 +72,8 @@ def cmd2_public_attr_name(name: str) -> str:
 # Attached to a command function; defines its help section category
 COMMAND_ATTR_HELP_CATEGORY = cmd2_private_attr_name("help_category")
 
-# Attached to an argparse-based command function; defines its ApCommandSpec instance
-AP_COMMAND_ATTR_SPEC = cmd2_private_attr_name("ap_command_spec")
+# Attached to an argparse-based command function; defines its ArgparseCommandSpec instance
+ARGPARSE_COMMAND_ATTR_SPEC = cmd2_private_attr_name("argparse_command_spec")
 
 # Attached to a subcommand function; defines its SubcommandSpec instance
 SUBCOMMAND_ATTR_SPEC = cmd2_private_attr_name("subcommand_spec")

cmd2/decorators.py

@@ -16,7 +16,7 @@
 
 from . import constants
 from .argparse_utils import (
-    ApCommandSpec,
+    ArgparseCommandSpec,
     ClassParamParserFactory,
     Cmd2ArgumentParser,
     NoParamParserFactory,
@@ -366,11 +366,11 @@ def cmd_wrapper(*args: Any, **kwargs: Any) -> bool | None:
 
         command_name = func.__name__[len(constants.COMMAND_FUNC_PREFIX) :]
 
-        spec = ApCommandSpec(
+        spec = ArgparseCommandSpec(
             parser_source=parser_source,
             preserve_quotes=preserve_quotes,
         )
-        setattr(cmd_wrapper, constants.AP_COMMAND_ATTR_SPEC, spec)
+        setattr(cmd_wrapper, constants.ARGPARSE_COMMAND_ATTR_SPEC, spec)
 
         return cmd_wrapper
 

tests/test_annotated.py

@@ -1121,7 +1121,7 @@ class MyCompleter(ArgparseCompleter):
         @with_annotated(ap_completer_type=MyCompleter)
         def do_run(self, name: str) -> None: ...
 
-        builder = getattr(do_run, constants.AP_COMMAND_ATTR_SPEC).parser_source
+        builder = getattr(do_run, constants.ARGPARSE_COMMAND_ATTR_SPEC).parser_source
         assert builder().ap_completer_type is MyCompleter
 
     def test_ap_completer_type_threads_to_subcommand(self) -> None:
@@ -3005,7 +3005,7 @@ def _base_parser(**subcommand_kwargs):
         @with_annotated(base_command=True, **subcommand_kwargs)
         def do_root(self, cmd2_subcommand_func) -> None: ...
 
-        builder = getattr(do_root, constants.AP_COMMAND_ATTR_SPEC).parser_source
+        builder = getattr(do_root, constants.ARGPARSE_COMMAND_ATTR_SPEC).parser_source
         return builder()
 
     @staticmethod
@@ -3116,7 +3116,7 @@ def do_run(self, name: str) -> None:
             Extra detail.
             """
 
-        builder = getattr(do_run, constants.AP_COMMAND_ATTR_SPEC).parser_source
+        builder = getattr(do_run, constants.ARGPARSE_COMMAND_ATTR_SPEC).parser_source
         assert builder().description == "Run the thing."
 
     def test_subcommand_uses_docstring(self) -> None:
@@ -3213,7 +3213,7 @@ def test_decorator_passes_parser_kwargs(self) -> None:
         @with_annotated(prog="myprog", usage="usage line")
         def do_run(self, name: str) -> None: ...
 
-        builder = getattr(do_run, constants.AP_COMMAND_ATTR_SPEC).parser_source
+        builder = getattr(do_run, constants.ARGPARSE_COMMAND_ATTR_SPEC).parser_source
         parser = builder()
         assert parser.prog == "myprog"
         assert parser.usage == "usage line"
@@ -3323,7 +3323,7 @@ def test_decorator_threads_all_low_level_kwargs(self) -> None:
         )
         def do_run(self, name: str) -> None: ...
 
-        builder = getattr(do_run, constants.AP_COMMAND_ATTR_SPEC).parser_source
+        builder = getattr(do_run, constants.ARGPARSE_COMMAND_ATTR_SPEC).parser_source
         parser = builder()
         assert parser.prefix_chars == "+-"
         assert parser.fromfile_prefix_chars == "@"