cmd2 4.0.0b6__tar.gz → 4.0.0rc2__tar.gz

{cmd2-4.0.0b6 → cmd2-4.0.0rc2}/.pre-commit-config.yaml

@@ -14,7 +14,7 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.15.8"
+    rev: "v0.15.15"
     hooks:
       - id: ruff-format
         args: [--config=ruff.toml]
@@ -26,11 +26,11 @@ repos:
     hooks:
       - id: prettier
         additional_dependencies:
-          - prettier@3.8.1
+          - prettier@3.8.3
           - prettier-plugin-toml@2.0.6
 
   - repo: https://github.com/crate-ci/typos
-    rev: v1.44.0
+    rev: v1.47.0
     hooks:
       - id: typos
         exclude: |

{cmd2-4.0.0b6 → cmd2-4.0.0rc2}/CHANGELOG.md

@@ -1,4 +1,4 @@
-## 4.0.0 (TBD 2026)
+## 4.0.0 (June TBD, 2026)
 
 ### Summary
 
@@ -22,6 +22,7 @@ prompt is displayed.
       each platform and provided utility functions related to `readline`
     - Added a dependency on `prompt-toolkit` and a new `cmd2.pt_utils` module with supporting
       utilities
+    - Dropped support for Python 3.10. `cmd2` now requires Python 3.11 or later
     - Removed **Transcript Testing** feature set along with the `history -t` option for generating
       transcript files and the `cmd2.transcript` module
         - This was an extremely brittle regression testing framework which should never have been
@@ -66,12 +67,14 @@ prompt is displayed.
     - Removed `Cmd.ruler` since `cmd2` no longer uses it.
     - All parsers used with `cmd2` commands must 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`.
+    - Renamed `set_default_argument_parser_type()` to `set_default_argument_parser()`.
+    - Renamed `set_default_ap_completer_type()` to `set_default_argparse_completer()`.
+    - Removed `set_ap_completer_type()` and `get_ap_completer_type()` since `completer_class` is now
+      a public member of `Cmd2ArgumentParser`.
     - Moved `set_parser_prog()` to `Cmd2ArgumentParser.update_prog()`.
-    - Renamed `cmd2_handler` to `cmd2_subcmd_handler` in the `argparse.Namespace` for clarity.
+    - Renamed `cmd2_handler` to `cmd2_subcommand_func` in the `argparse.Namespace` for clarity.
     - Removed `Cmd2AttributeWrapper` class. `argparse.Namespace` objects passed to command functions
-      now contain direct attributes for `cmd2_statement` and `cmd2_subcmd_handler`.
+      now contain direct attributes for `cmd2_statement` and `cmd2_subcommand_func`.
     - Renamed `cmd2/command_definition.py` to `cmd2/command_set.py`.
     - Removed `Cmd.doc_header` and the `with_default_category` decorator. Help categorization is now
       driven by the `DEFAULT_CATEGORY` class variable (see **Simplified command categorization** in
@@ -81,9 +84,8 @@ prompt is displayed.
     - `cmd2` no longer sets a default title for a subparsers group. If you desire a title, you will
       need to pass one in like this `parser.add_subparsers(title="subcommands")`. This is standard
       `argparse` behavior.
-    - Added `HelpFormatterRenderable` protocol and `HelpContent` type alias to support context-aware
-      help content in `argparse`.
-    - `TextGroup` now implements `HelpFormatterRenderable`.
+    - `TextGroup` now implements `HelpFormatterRenderable` (see Enhancements section below for more
+      details).
         - Removed `formatter_creator` parameter from `TextGroup.__init__()`.
         - Removed `Cmd2ArgumentParser.create_text_group()` method.
     - `argparse` and `Rich` integration refactoring:
@@ -95,9 +97,9 @@ prompt is displayed.
             - `RawDescriptionCmd2HelpFormatter`
             - `RawTextCmd2HelpFormatter`
             - `TextGroup`
-        - Replaced the global `APP_THEME` constant in `rich_utils.py` with `get_theme()` and
-          `set_theme()` functions to support lazy initialization and safer in-place updates of the
-          theme.
+        - Replaced the global `APP_THEME` constant in `rich_utils.py` with `get_theme()`,
+          `reset_theme()`, and `update_theme()` functions in `theme.py` to support lazy
+          initialization and safer in-place updates of the theme.
     - Renamed `Cmd._command_parsers` to `Cmd.command_parsers`.
     - Removed `RichPrintKwargs` `TypedDict` in favor of using `Mapping[str, Any]`, allowing for
       greater flexibility in passing keyword arguments to `console.print()` calls.
@@ -109,6 +111,10 @@ prompt is displayed.
       treated as command output and sent to `self.stdout`, allowing them to be captured.
     - Verbose help table descriptions are no longer generated from help function output. The system
       now relies exclusively on command function docstrings.
+    - Removed `feedback_to_output` settable and changed `cmd2.Cmd.pfeedback` to always print to
+      `self.stdout`
+    - Removed `Cmd.parseline()` since it was unused and merely wrapped
+      `StatementParser.parse_command_only()`.
 - Enhancements
     - New `cmd2.Cmd` parameters
         - **auto_suggest**: (boolean) if `True`, provide fish shell style auto-suggestions. These
@@ -145,11 +151,38 @@ prompt is displayed.
       full type hints and IDE autocompletion for `self._cmd` without needing to override and cast
       the property.
     - Added `traceback_kwargs` attribute to allow customization of Rich-based tracebacks.
+    - Added `HelpFormatterRenderable` protocol and `HelpContent` type alias to support context-aware
+      help content in `argparse`.
     - The `print()` function available in a `pyscript` writes to `self.stdout` and respects the
       `allow_style` setting. It also supports printing `Rich` objects.
     - Added `Cmd2ArgumentParser.output_to()` context manager to temporarily set the output stream
       during `argparse` operations. This is helpful for directing output for functions like
       `parse_args()`, which default to `sys.stdout` and lack a `file` argument.
+    - Added ability to customize `prompt-toolkit` completion menu colors by overriding the following
+      fields in the `cmd2` theme:
+        - `Cmd2Style.COMPLETION_MENU` - Base style for the entire completion menu container (sets
+          the background)
+        - `Cmd2Style.COMPLETION_MENU_COMPLETION` -Style for an individual, non-selected completion
+          item
+        - `Cmd2Style.COMPLETION_MENU_CURRENT` - Style for the currently selected completion item
+        - `Cmd2Style.COMPLETION_MENU_META` - Style for "meta" information shown alongside a
+          completion
+        - `Cmd2Style.COMPLETION_MENU_META_CURRENT`- Style for meta info of current item
+    - Updated `set` command to consolidate its confirmation output into a single, colorized line.
+      The confirmation now uses `pfeedback()`, allowing it to be silenced when the `quiet` settable
+      is enabled.
+    - `alias` and `macro` subcommands for `create` and `delete` now output their non-essential
+      success case output using `pfeedback`
+- Experimental features
+    - New `@with_annotated` decorator, a type-hint-driven alternative to `@with_argparse` that
+      builds the parser automatically from a command's signature (positional/option inference,
+      enum/literal/path/collection handling, subcommands, groups, mutex). See the
+      [annotated_example.py](https://github.com/python-cmd2/cmd2/blob/main/examples/annotated_example.py)
+      example for demonstration of usage.
+        - This feature allows declaring `cmd2` command parameters using type hints using syntax
+          essentially identical to that used by [Typer](https://typer.tiangolo.com/)
+        - You use declarative syntax to define the arguments a command takes and the
+          `@with_annotated` decorator builds an `argparse` parser for you
 
 ## 3.5.1 (April 24, 2026)
 

{cmd2-4.0.0b6 → cmd2-4.0.0rc2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cmd2
-Version: 4.0.0b6
+Version: 4.0.0rc2
 Summary: cmd2 - quickly build feature-rich and user-friendly interactive command line applications in Python
 Author: cmd2 Contributors
 License-Expression: MIT
@@ -11,7 +11,6 @@ Classifier: Operating System :: OS Independent
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
@@ -19,15 +18,13 @@ Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: 3.15
 Classifier: Programming Language :: Python :: Free Threading :: 3 - Stable
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: backports.strenum; python_version == "3.10"
 Requires-Dist: prompt-toolkit>=3.0.52
 Requires-Dist: pyperclip>=1.8.2
 Requires-Dist: rich>=15.0.0
 Requires-Dist: rich-argparse>=1.7.2
-Requires-Dist: typing-extensions; python_version == "3.10"
 Dynamic: license-file
 
 <h1 align="center">cmd2 : immersive interactive command line applications</h1>
@@ -57,10 +54,11 @@ applications. It provides a simple API which is an extension of Python's built-i
 of cmd to make your life easier and eliminates much of the boilerplate code which would be necessary
 when using cmd.
 
-> :warning: **`cmd2` `3.x` has been released and there are some significant backwards
-> incompatibilities from version `2.x`. Please see the
-> [Migration Guide](https://cmd2.readthedocs.io/en/latest/upgrades/) for tips on upgrading from
-> `cmd2` 2.x to 3.x.**
+> :warning: **If you are upgrading from an older version of `cmd2`, both `3.x` and `4.x` have some
+> significant backwards incompatibilities from version `2.x`. Please see the
+> [CHANGELOG](./CHANGELOG.md) for info on what has changed and the
+> [Migration Guide](https://cmd2.readthedocs.io/en/latest/upgrades/) for tips on upgrading from an
+> older version of `cmd2` to `4.x`**
 
 ## The developers toolbox
 
@@ -118,7 +116,7 @@ On all operating systems, the latest stable version of `cmd2` can be installed u
 pip install -U cmd2
 ```
 
-cmd2 works with Python 3.10+ on Windows, macOS, and Linux. It is pure Python code with few 3rd-party
+cmd2 works with Python 3.11+ on Windows, macOS, and Linux. It is pure Python code with few 3rd-party
 dependencies. It works with both conventional CPython and free-threaded variants.
 
 For information on other installation options, see

{cmd2-4.0.0b6 → cmd2-4.0.0rc2}/README.md

@@ -25,10 +25,11 @@ applications. It provides a simple API which is an extension of Python's built-i
 of cmd to make your life easier and eliminates much of the boilerplate code which would be necessary
 when using cmd.
 
-> :warning: **`cmd2` `3.x` has been released and there are some significant backwards
-> incompatibilities from version `2.x`. Please see the
-> [Migration Guide](https://cmd2.readthedocs.io/en/latest/upgrades/) for tips on upgrading from
-> `cmd2` 2.x to 3.x.**
+> :warning: **If you are upgrading from an older version of `cmd2`, both `3.x` and `4.x` have some
+> significant backwards incompatibilities from version `2.x`. Please see the
+> [CHANGELOG](./CHANGELOG.md) for info on what has changed and the
+> [Migration Guide](https://cmd2.readthedocs.io/en/latest/upgrades/) for tips on upgrading from an
+> older version of `cmd2` to `4.x`**
 
 ## The developers toolbox
 
@@ -86,7 +87,7 @@ On all operating systems, the latest stable version of `cmd2` can be installed u
 pip install -U cmd2
 ```
 
-cmd2 works with Python 3.10+ on Windows, macOS, and Linux. It is pure Python code with few 3rd-party
+cmd2 works with Python 3.11+ on Windows, macOS, and Linux. It is pure Python code with few 3rd-party
 dependencies. It works with both conventional CPython and free-threaded variants.
 
 For information on other installation options, see

{cmd2-4.0.0b6 → cmd2-4.0.0rc2}/cmd2/__init__.py

@@ -11,11 +11,13 @@ from . import (
     rich_utils,
     string_utils,
 )
-from .argparse_completer import set_default_ap_completer_type
+from .annotated import with_annotated
+from .argparse_completer import set_default_argparse_completer
 from .argparse_utils import (
     Cmd2ArgumentParser,
+    SubcommandRecord,
     register_argparse_argument_parameter,
-    set_default_argument_parser_type,
+    set_default_argument_parser,
 )
 from .cmd2 import Cmd
 from .colors import Color
@@ -51,11 +53,14 @@ from .rich_utils import (
     RawDescriptionCmd2HelpFormatter,
     RawTextCmd2HelpFormatter,
     TextGroup,
-    get_theme,
-    set_theme,
 )
 from .string_utils import stylize
 from .styles import Cmd2Style
+from .theme import (
+    get_theme,
+    reset_theme,
+    update_theme,
+)
 from .utils import (
     CustomCompletionSettings,
     Settable,
@@ -68,9 +73,10 @@ __all__: list[str] = [  # noqa: RUF022
     "DEFAULT_SHORTCUTS",
     # Argparse Exports
     "Cmd2ArgumentParser",
+    "SubcommandRecord",
     "register_argparse_argument_parameter",
-    "set_default_ap_completer_type",
-    "set_default_argument_parser_type",
+    "set_default_argparse_completer",
+    "set_default_argument_parser",
     # Cmd2
     "Cmd",
     "CommandResult",
@@ -83,6 +89,7 @@ __all__: list[str] = [  # noqa: RUF022
     "CompletionItem",
     "Completions",
     # Decorators
+    "with_annotated",
     "with_argument_list",
     "with_argparser",
     "with_category",
@@ -100,16 +107,18 @@ __all__: list[str] = [  # noqa: RUF022
     # Rich Utils
     "ArgumentDefaultsCmd2HelpFormatter",
     "Cmd2HelpFormatter",
-    "get_theme",
     "MetavarTypeCmd2HelpFormatter",
     "RawDescriptionCmd2HelpFormatter",
     "RawTextCmd2HelpFormatter",
-    "set_theme",
     "TextGroup",
     # String Utils
     "stylize",
-    # Styles,
+    # Styles
     "Cmd2Style",
+    # Theme
+    "get_theme",
+    "reset_theme",
+    "update_theme",
     # Utilities
     "categorize",
     "CustomCompletionSettings",