cmd2 2.6.2__tar.gz → 2.7.0__tar.gz

{cmd2-2.6.2 → cmd2-2.7.0}/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.7.0 (June 30, 2025)
+
+- Enhancements
+    - Integrated rich-argparse with cmd2's default argparse help formatter (`Cmd2HelpFormatter`).
+
 ## 2.6.2 (June 26, 2025)
 
 - Enhancements

{cmd2-2.6.2 → cmd2-2.7.0}/PKG-INFO

@@ -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 → cmd2-2.7.0}/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-2.6.2 → cmd2-2.7.0}/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 → cmd2-2.7.0}/cmd2.egg-info/PKG-INFO

@@ -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 → cmd2-2.7.0}/cmd2.egg-info/requires.txt

@@ -1,4 +1,5 @@
 pyperclip>=1.8
+rich-argparse>=1.7.1
 wcwidth>=0.2.10
 
 [:platform_system == "Darwin"]

{cmd2-2.6.2 → cmd2-2.7.0}/pyproject.toml

@@ -32,6 +32,7 @@ dependencies = [
     "gnureadline>=8; platform_system == 'Darwin'",
     "pyperclip>=1.8",
     "pyreadline3>=3.4; platform_system == 'Windows'",
+    "rich-argparse>=1.7.1",
     "wcwidth>=0.2.10",
 ]