cmd2 2.6.2__py3-none-any.whl → 2.7.0__py3-none-any.whl

cmd2/argparse_custom.py

@@ -229,14 +229,17 @@ from argparse import (
     ZERO_OR_MORE,
     ArgumentError,
 )
-from collections.abc import Callable, Iterable, Sequence
-from gettext import (
-    gettext,
+from collections.abc import (
+    Callable,
+    Iterable,
+    Sequence,
 )
+from gettext import gettext
 from typing import (
     IO,
     TYPE_CHECKING,
     Any,
+    ClassVar,
     NoReturn,
     Optional,
     Protocol,
@@ -245,6 +248,8 @@ from typing import (
     runtime_checkable,
 )
 
+from rich_argparse import RawTextRichHelpFormatter
+
 from . import (
     ansi,
     constants,
@@ -991,9 +996,25 @@ setattr(argparse._SubParsersAction, 'remove_parser', _SubParsersAction_remove_pa
 ############################################################################################################
 
 
-class Cmd2HelpFormatter(argparse.RawTextHelpFormatter):
+class Cmd2HelpFormatter(RawTextRichHelpFormatter):
     """Custom help formatter to configure ordering of help text."""
 
+    # rich-argparse formats all group names with str.title().
+    # Override their formatter to do nothing.
+    group_name_formatter: ClassVar[Callable[[str], str]] = str
+
+    # Disable automatic highlighting in the help text.
+    highlights: ClassVar[list[str]] = []
+
+    # Disable markup rendering in usage, help, description, and epilog text.
+    # cmd2's built-in commands do not escape opening brackets in their help text
+    # and therefore rely on these settings being False. If you desire to use
+    # markup in your help text, inherit from Cmd2HelpFormatter and override
+    # these settings in that child class.
+    usage_markup: ClassVar[bool] = False
+    help_markup: ClassVar[bool] = False
+    text_markup: ClassVar[bool] = False
+
     def _format_usage(
         self,
         usage: Optional[str],
@@ -1215,42 +1236,30 @@ class Cmd2ArgumentParser(argparse.ArgumentParser):
                                   behavior on this parser. If this is None or not present, then cmd2 will use
                                   argparse_completer.DEFAULT_AP_COMPLETER when tab completing this parser's arguments
         """
+        kwargs: dict[str, bool] = {}
         if sys.version_info >= (3, 14):
             # Python >= 3.14 so pass new arguments to parent argparse.ArgumentParser class
-            super().__init__(
-                prog=prog,
-                usage=usage,
-                description=description,
-                epilog=epilog,
-                parents=parents if parents else [],
-                formatter_class=formatter_class,  # type: ignore[arg-type]
-                prefix_chars=prefix_chars,
-                fromfile_prefix_chars=fromfile_prefix_chars,
-                argument_default=argument_default,
-                conflict_handler=conflict_handler,
-                add_help=add_help,
-                allow_abbrev=allow_abbrev,
-                exit_on_error=exit_on_error,  # added in Python 3.9
-                suggest_on_error=suggest_on_error,  # added in Python 3.14
-                color=color,  # added in Python 3.14
-            )
-        else:
-            # Python < 3.14, so don't pass new arguments to parent argparse.ArgumentParser class
-            super().__init__(
-                prog=prog,
-                usage=usage,
-                description=description,
-                epilog=epilog,
-                parents=parents if parents else [],
-                formatter_class=formatter_class,  # type: ignore[arg-type]
-                prefix_chars=prefix_chars,
-                fromfile_prefix_chars=fromfile_prefix_chars,
-                argument_default=argument_default,
-                conflict_handler=conflict_handler,
-                add_help=add_help,
-                allow_abbrev=allow_abbrev,
-                exit_on_error=exit_on_error,  # added in Python 3.9
-            )
+            kwargs = {
+                "suggest_on_error": suggest_on_error,
+                "color": color,
+            }
+
+        super().__init__(
+            prog=prog,
+            usage=usage,
+            description=description,
+            epilog=epilog,
+            parents=parents if parents else [],
+            formatter_class=formatter_class,  # type: ignore[arg-type]
+            prefix_chars=prefix_chars,
+            fromfile_prefix_chars=fromfile_prefix_chars,
+            argument_default=argument_default,
+            conflict_handler=conflict_handler,
+            add_help=add_help,
+            allow_abbrev=allow_abbrev,
+            exit_on_error=exit_on_error,  # added in Python 3.9
+            **kwargs,  # added in Python 3.14
+        )
 
         self.set_ap_completer_type(ap_completer_type)  # type: ignore[attr-defined]
 

cmd2/cmd2.py

@@ -42,14 +42,16 @@ import re
 import sys
 import tempfile
 import threading
-from code import (
-    InteractiveConsole,
-)
+from code import InteractiveConsole
 from collections import (
     OrderedDict,
     namedtuple,
 )
-from collections.abc import Callable, Iterable, Mapping
+from collections.abc import (
+    Callable,
+    Iterable,
+    Mapping,
+)
 from types import (
     FrameType,
     ModuleType,
@@ -763,8 +765,8 @@ class Cmd(cmd.Cmd):
         """Build argument parser for a command/subcommand.
 
         :param parent: CommandParent object which owns the command using the parser.
-                       This function assumes that parent is where parser_builder
-                       is defined when parser_builder is a classmethod.
+                       When parser_builder is a classmethod, this function passes
+                       parent's class to it.
         :param parser_builder: means used to build the parser
         :param prog: prog value to set in new parser
         :return: new parser
@@ -781,9 +783,7 @@ class Cmd(cmd.Cmd):
         else:
             raise TypeError(f"Invalid type for parser_builder: {type(parser_builder)}")
 
-        from .decorators import (
-            _set_parser_prog,
-        )
+        from .decorators import _set_parser_prog
 
         _set_parser_prog(parser, prog)
 

{cmd2-2.6.2.dist-info → cmd2-2.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cmd2
-Version: 2.6.2
+Version: 2.7.0
 Summary: cmd2 - quickly build feature-rich and user-friendly interactive command line applications in Python
 Author: cmd2 Contributors
 License: The MIT License (MIT)
@@ -47,6 +47,7 @@ License-File: LICENSE
 Requires-Dist: gnureadline>=8; platform_system == "Darwin"
 Requires-Dist: pyperclip>=1.8
 Requires-Dist: pyreadline3>=3.4; platform_system == "Windows"
+Requires-Dist: rich-argparse>=1.7.1
 Requires-Dist: wcwidth>=0.2.10
 Dynamic: license-file
 

{cmd2-2.6.2.dist-info → cmd2-2.7.0.dist-info}/RECORD

@@ -1,9 +1,9 @@
 cmd2/__init__.py,sha256=xRXcr4HzJrZbouMEP8AkWwxjW1lqXYLFG0SlWiw5_9g,2502
 cmd2/ansi.py,sha256=XwBvFnB51LYYjIpfEge6mcr5X63dUxiV0aJlOOJ_2tQ,31965
 cmd2/argparse_completer.py,sha256=F_5hiX9fYpEhV42mz7v7qeS7KuInAS6xU6KekLxYzsQ,35863
-cmd2/argparse_custom.py,sha256=Q7N-2TSctfjn3TEZezQNaT5y0w8sdGpmUA5_DCPa_Pk,59131
+cmd2/argparse_custom.py,sha256=uGCQ3MG_iTBvwZ6MKmZOoCjlgF8OvWJg2DMs2myHZf4,59201
 cmd2/clipboard.py,sha256=HLZWY-W3mkpF_OqQet-F8pS3rlXpiE5vxUyPV_yHvIU,507
-cmd2/cmd2.py,sha256=-LkAwuakQGF_oZTUsmtQfPTILtCT-F7LNE7Ej2l9PVc,261740
+cmd2/cmd2.py,sha256=8HKnMWhtY0qJUtQZr0ByrMnfYKnavQu7tT6G7wrsZVk,261697
 cmd2/command_definition.py,sha256=_wF39nig5MP0grSOZ1hFehP5fCGusUNHMn9PIs6pmcU,7648
 cmd2/constants.py,sha256=duEqGhhvdUV7AYxE8VGZ4wyFBcN2y2bLPd5iefW4tSU,1943
 cmd2/decorators.py,sha256=t0gBy3aRz5ke0jHyP5YOszdQ61t5aV8j0eNyLPX6hmg,20644
@@ -17,8 +17,8 @@ cmd2/rl_utils.py,sha256=sWapqwDR_GvOgy5NJ7c-i6nUU4dqpKpGQ8-Olwi3tuU,11335
 cmd2/table_creator.py,sha256=nF3VEgGHvfhHBh_yoMAiV1WaDdR8hIareIAogzIPq5M,47177
 cmd2/transcript.py,sha256=Ws0lW_oBFxCQCKSwvnDUS1x3ya163YXnV-O5aTU0z7k,9207
 cmd2/utils.py,sha256=NqDIkY4LiAlnv_Un7MFHxszoH2KgEWQ7NJOwQurIn_E,50698
-cmd2-2.6.2.dist-info/licenses/LICENSE,sha256=9qPeHY4u2fkSz0JQGT-P4T3QqTWTqnQJ_8LkZUhSdFY,1099
-cmd2-2.6.2.dist-info/METADATA,sha256=PXmEeU5Cspekoxefr9LjKqHJ44zXV4hUdwGUrBTeygs,17292
-cmd2-2.6.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-cmd2-2.6.2.dist-info/top_level.txt,sha256=gJbOJmyrARwLhm5diXAtzlNQdxbDZ8iRJ8HJi65_5hg,5
-cmd2-2.6.2.dist-info/RECORD,,
+cmd2-2.7.0.dist-info/licenses/LICENSE,sha256=9qPeHY4u2fkSz0JQGT-P4T3QqTWTqnQJ_8LkZUhSdFY,1099
+cmd2-2.7.0.dist-info/METADATA,sha256=HOqT-x9vnZ21-fCTSbT7HC-BQo6fPY1hyCXtS_b6GHw,17328
+cmd2-2.7.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+cmd2-2.7.0.dist-info/top_level.txt,sha256=gJbOJmyrARwLhm5diXAtzlNQdxbDZ8iRJ8HJi65_5hg,5
+cmd2-2.7.0.dist-info/RECORD,,