cmd2 4.0.0b1__tar.gz → 4.0.0b3__tar.gz

{cmd2-4.0.0b1 → cmd2-4.0.0b3}/.pre-commit-config.yaml

@@ -3,13 +3,18 @@ repos:
     rev: "v6.0.0"
     hooks:
       - id: check-case-conflict
+      - id: check-executables-have-shebangs
       - id: check-merge-conflict
       - id: check-toml
+      - id: check-yaml
+      - id: detect-private-key
       - id: end-of-file-fixer
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
       - id: trailing-whitespace
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.15.4"
+    rev: "v0.15.8"
     hooks:
       - id: ruff-format
         args: [--config=ruff.toml]
@@ -23,3 +28,13 @@ repos:
         additional_dependencies:
           - prettier@3.8.1
           - prettier-plugin-toml@2.0.6
+
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.44.0
+    hooks:
+      - id: typos
+        exclude: |
+          (?x)^(
+            ruff.toml|
+            tests/.*
+          )$

cmd2-4.0.0b3/.typos.toml

@@ -0,0 +1,5 @@
+[default.extend-words]
+EXPLIoT = "EXPLIoT"
+Counterfit = "Counterfit"
+expliot = "expliot"
+counterfit = "counterfit"

{cmd2-4.0.0b1 → cmd2-4.0.0b3}/CHANGELOG.md

@@ -37,13 +37,15 @@ prompt is displayed.
           longer needed
     - `completer` functions must now return a `cmd2.Completions` object instead of `list[str]`.
     - `choices_provider` functions must now return a `cmd2.Choices` object instead of `list[str]`.
-    - An argparse argument's `descriptive_headers` field is now called `table_header`.
-    - `CompletionItem.descriptive_data` is now called `CompletionItem.table_row`.
+    - An argparse argument's `descriptive_headers` field is now called `table_columns`.
+    - `CompletionItem.descriptive_data` is now called `CompletionItem.table_data`.
+    - Removed `DEFAULT_DESCRIPTIVE_HEADERS`. This means you must define `table_columns` when using
+      `CompletionItem.table_data` data.
     - `Cmd.default_sort_key` moved to `utils.DEFAULT_STR_SORT_KEY`.
     - Moved completion state data, which previously resided in `Cmd`, into other classes.
         - `Cmd.matches_sorted` -> `Completions.is_sorted` and `Choices.is_sorted`
-        - `Cmd.completion_hint` -> `Completions.completion_hint`
-        - `Cmd.formatted_completions` -> `Completions.completion_table`
+        - `Cmd.completion_hint` -> `Completions.hint`
+        - `Cmd.formatted_completions` -> `Completions.table` (Now a Rich Table)
         - `Cmd.allow_appended_space/allow_closing_quote` -> `Completions.allow_finalization`
     - Removed `Cmd.matches_delimited` since it's no longer used.
     - Removed `flag_based_complete` and `index_based_complete` functions since their functionality
@@ -61,6 +63,39 @@ prompt is displayed.
       `add_alert()`. This new function is thread-safe and does not require you to acquire a mutex
       before calling it like the previous functions did.
     - Removed `Cmd.default_to_shell`.
+    - 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`.
+    - Moved `set_parser_prog()` to `Cmd2ArgumentParser.update_prog()`.
+    - Renamed `cmd2_handler` to `cmd2_subcmd_handler` 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`.
+    - 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
+      the Enhancements section below for details).
+    - Removed `Cmd.undoc_header` since all commands are now considered categorized.
+    - Renamed `Cmd.cmd_func()` to `Cmd.get_command_func()`.
+    - `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.
+    - `TextGroup` is now a standalone Rich renderable.
+        - Removed `formatter_creator` parameter from `TextGroup.__init__()`.
+        - Removed `Cmd2ArgumentParser.create_text_group()` method.
+    - `argparse` and `Rich` integration refactoring:
+        - Renamed `argparse_custom` module to `argparse_utils`.
+        - Moved the following classes from `argparse_utils` to `rich_utils`:
+            - `Cmd2HelpFormatter`
+            - `ArgumentDefaultsCmd2HelpFormatter`
+            - `MetavarTypeCmd2HelpFormatter`
+            - `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.
 - Enhancements
     - New `cmd2.Cmd` parameters
         - **auto_suggest**: (boolean) if `True`, provide fish shell style auto-suggestions. These
@@ -75,9 +110,31 @@ prompt is displayed.
         - **get_rprompt**: override to populate right prompt
         - **pre_prompt**: hook method that is called before the prompt is displayed, but after
           `prompt-toolkit` event loop has started
+        - **read_secret**: read secrets like passwords without displaying them to the terminal
+        - **ppretty**: a cmd2-compatible replacement for `rich.pretty.pprint()`
     - New settables:
         - **max_column_completion_results**: (int) the maximum number of completion results to
           display in a single column
+    - `cmd2.Cmd.select` has been revamped to use the
+      [choice](https://python-prompt-toolkit.readthedocs.io/en/3.0.52/pages/asking_for_a_choice.html)
+      function from `prompt-toolkit` when both **stdin** and **stdout** are TTYs
+    - Add support for Python 3.15 by fixing various bugs related to internal `argparse` changes
+    - Added `common_prefix` method to `cmd2.string_utils` module as a replacement for
+      `os.path.commonprefix` since that is now deprecated in Python 3.15
+    - Simplified command categorization:
+        - By default, all commands in a class are grouped under its `DEFAULT_CATEGORY`.
+        - Individual commands can still be manually moved using the `with_category()` decorator.
+        - For more details and examples, see the [Help](docs/features/help.md) documentation and the
+          `examples/default_categories.py` file.
+    - `CommandSet` is now a generic class, which allows developers to parameterize it with their
+      specific `cmd2.Cmd` subclass (e.g.,`class MyCommandSet(CommandSet[MyApp]):`). This provides
+      full type hints and IDE autocompletion for `self._cmd` without needing to override and cast
+      the property.
+
+## 3.5.0 (April 13, 2026)
+
+- Bug Fixes
+    - Fixed issue where Rich stripped colors from text in test environments where TERM=dumb.
 
 ## 3.4.0 (March 3, 2026)
 

{cmd2-4.0.0b1 → cmd2-4.0.0b3}/Makefile

@@ -7,8 +7,8 @@ install: ## Install the virtual environment with dependencies
 	@echo "🚀 Creating uv Python virtual environment"
 	@uv python install 3.14
 	@uv sync --python=3.14
-	@echo "🚀 Installing Git pre-commit hooks locally"
-	@uv run pre-commit install
+	@echo "🚀 Installing Git prek hooks locally"
+	@uv run prek install -f
 	@echo "🚀 Installing Prettier using npm"
 	@npm install -q --no-fund --include=dev
 
@@ -16,8 +16,8 @@ install: ## Install the virtual environment with dependencies
 check: ## Run code quality tools.
 	@echo "🚀 Checking lock file consistency with 'pyproject.toml'"
 	@uv lock --locked
-	@echo "🚀 Linting code and documentation: Running pre-commit"
-	@uv run pre-commit run -a
+	@echo "🚀 Auto-formatting/Linting code and documentation: Running prek"
+	@uv run prek run -a
 	@echo "🚀 Static type checking: Running mypy"
 	@uv run mypy
 

{cmd2-4.0.0b1 → cmd2-4.0.0b3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cmd2
-Version: 4.0.0b1
+Version: 4.0.0b3
 Summary: cmd2 - quickly build feature-rich and user-friendly interactive command line applications in Python
 Author: cmd2 Contributors
 License-Expression: MIT
@@ -25,8 +25,8 @@ 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>=14.3.0
-Requires-Dist: rich-argparse>=1.7.1
+Requires-Dist: rich>=15.0.0
+Requires-Dist: rich-argparse>=1.7.2
 Requires-Dist: typing-extensions; python_version == "3.10"
 Dynamic: license-file
 
@@ -139,7 +139,7 @@ examples.
 - [cmd2 example applications](https://github.com/python-cmd2/cmd2/tree/main/examples)
     - Basic cmd2 examples to demonstrate how to use various features
 - [Advanced Examples](https://github.com/jayrod/cmd2-example-apps)
-    - More complex examples that demonstrate more featuers about how to put together a complete
+    - More complex examples that demonstrate more features about how to put together a complete
       application
 - [Cookiecutter](https://github.com/cookiecutter/cookiecutter) Templates from community
     - Basic cookiecutter template for cmd2 application :

{cmd2-4.0.0b1 → cmd2-4.0.0b3}/README.md

@@ -107,7 +107,7 @@ examples.
 - [cmd2 example applications](https://github.com/python-cmd2/cmd2/tree/main/examples)
     - Basic cmd2 examples to demonstrate how to use various features
 - [Advanced Examples](https://github.com/jayrod/cmd2-example-apps)
-    - More complex examples that demonstrate more featuers about how to put together a complete
+    - More complex examples that demonstrate more features about how to put together a complete
       application
 - [Cookiecutter](https://github.com/cookiecutter/cookiecutter) Templates from community
     - Basic cookiecutter template for cmd2 application :

{cmd2-4.0.0b1 → cmd2-4.0.0b3}/cmd2/__init__.py

@@ -12,18 +12,14 @@ from . import (
     string_utils,
 )
 from .argparse_completer import set_default_ap_completer_type
-from .argparse_custom import (
+from .argparse_utils import (
     Cmd2ArgumentParser,
-    Cmd2AttributeWrapper,
     register_argparse_argument_parameter,
     set_default_argument_parser_type,
 )
 from .cmd2 import Cmd
 from .colors import Color
-from .command_definition import (
-    CommandSet,
-    with_default_category,
-)
+from .command_set import CommandSet
 from .completion import (
     Choices,
     CompletionItem,
@@ -48,7 +44,17 @@ from .exceptions import (
 )
 from .parsing import Statement
 from .py_bridge import CommandResult
-from .rich_utils import RichPrintKwargs
+from .rich_utils import (
+    ArgumentDefaultsCmd2HelpFormatter,
+    Cmd2HelpFormatter,
+    MetavarTypeCmd2HelpFormatter,
+    RawDescriptionCmd2HelpFormatter,
+    RawTextCmd2HelpFormatter,
+    RichPrintKwargs,
+    TextGroup,
+    get_theme,
+    set_theme,
+)
 from .string_utils import stylize
 from .styles import Cmd2Style
 from .utils import (
@@ -59,50 +65,56 @@ from .utils import (
 )
 
 __all__: list[str] = [  # noqa: RUF022
-    'COMMAND_NAME',
-    'DEFAULT_SHORTCUTS',
+    "COMMAND_NAME",
+    "DEFAULT_SHORTCUTS",
     # Argparse Exports
-    'Cmd2ArgumentParser',
-    'Cmd2AttributeWrapper',
-    'register_argparse_argument_parameter',
-    'set_default_ap_completer_type',
-    'set_default_argument_parser_type',
+    "Cmd2ArgumentParser",
+    "register_argparse_argument_parameter",
+    "set_default_ap_completer_type",
+    "set_default_argument_parser_type",
     # Cmd2
-    'Cmd',
-    'CommandResult',
-    'CommandSet',
-    'Statement',
+    "Cmd",
+    "CommandResult",
+    "CommandSet",
+    "Statement",
     # Colors
     "Color",
     # Completion
-    'Choices',
-    'CompletionItem',
-    'Completions',
+    "Choices",
+    "CompletionItem",
+    "Completions",
     # Decorators
-    'with_argument_list',
-    'with_argparser',
-    'with_category',
-    'with_default_category',
-    'as_subcommand_to',
+    "with_argument_list",
+    "with_argparser",
+    "with_category",
+    "as_subcommand_to",
     # Exceptions
-    'Cmd2ArgparseError',
-    'CommandSetRegistrationError',
-    'CompletionError',
-    'PassThroughException',
-    'SkipPostcommandHooks',
+    "Cmd2ArgparseError",
+    "CommandSetRegistrationError",
+    "CompletionError",
+    "PassThroughException",
+    "SkipPostcommandHooks",
     # modules
-    'plugin',
-    'rich_utils',
-    'string_utils',
+    "plugin",
+    "rich_utils",
+    "string_utils",
     # Rich Utils
-    'RichPrintKwargs',
+    "ArgumentDefaultsCmd2HelpFormatter",
+    "Cmd2HelpFormatter",
+    "get_theme",
+    "MetavarTypeCmd2HelpFormatter",
+    "RawDescriptionCmd2HelpFormatter",
+    "RawTextCmd2HelpFormatter",
+    "RichPrintKwargs",
+    "set_theme",
+    "TextGroup",
     # String Utils
-    'stylize',
+    "stylize",
     # Styles,
     "Cmd2Style",
     # Utilities
-    'categorize',
-    'CustomCompletionSettings',
-    'Settable',
-    'set_default_str_sort_key',
+    "categorize",
+    "CustomCompletionSettings",
+    "Settable",
+    "set_default_str_sort_key",
 ]