cmd2 4.1.1__tar.gz → 4.1.2__tar.gz

{cmd2-4.1.1 → cmd2-4.1.2}/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 4.1.2 (July 16, 2026)
+
+- Enhancements
+    - Added possibility to use rich Text objects to set the description argument of a `Settable`
+    - Removed redundant `ipython` import which slowed application startup time
+
 ## 4.1.1 (July 9, 2026)
 
 - Bug Fixes

{cmd2-4.1.1 → cmd2-4.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cmd2
-Version: 4.1.1
+Version: 4.1.2
 Summary: cmd2 - quickly build feature-rich and user-friendly interactive command line applications in Python
 Author: cmd2 Contributors
 License-Expression: MIT

{cmd2-4.1.1 → cmd2-4.1.2}/cmd2/cmd2.py

@@ -177,9 +177,6 @@ from .types import (
     UnboundCompleter,
 )
 
-with contextlib.suppress(ImportError):
-    from IPython import start_ipython
-
 try:
     if sys.platform == "win32":
         from prompt_toolkit.output.win32 import NoConsoleScreenBufferError  # type: ignore[attr-defined]
@@ -1382,7 +1379,7 @@ class Cmd:
             Settable(
                 "allow_style",
                 allow_style_type,
-                ru.rich_text_to_string(settable_description),
+                settable_description,
                 self,
                 choices_provider=get_allow_style_choices,
             )
@@ -1399,7 +1396,7 @@ class Cmd:
             Settable(
                 "editor",
                 str,
-                ru.rich_text_to_string(editor_description),
+                editor_description,
                 self,
             )
         )
@@ -1434,7 +1431,7 @@ class Cmd:
             Settable(
                 "traceback_width",
                 utils.optional_int,
-                ru.rich_text_to_string(traceback_width_description),
+                traceback_width_description,
                 self,
             )
         )
@@ -5151,13 +5148,7 @@ class Cmd:
         # Detect whether IPython is installed
         try:
             import traitlets.config.loader as traitlets_loader
-
-            # Allow users to install ipython from a cmd2 prompt when needed and still have ipy command work
-            try:
-                _dummy = start_ipython  # noqa: F823
-            except NameError:
-                from IPython import start_ipython
-
+            from IPython import start_ipython
             from IPython.terminal.interactiveshell import TerminalInteractiveShell
             from IPython.terminal.ipapp import TerminalIPythonApp
         except ImportError:

{cmd2-4.1.1 → cmd2-4.1.2}/cmd2/utils.py

@@ -25,7 +25,10 @@ from typing import (
     cast,
 )
 
+from rich.text import Text
+
 from . import constants
+from . import rich_utils as ru
 from . import string_utils as su
 from .types import (
     CmdOrSet,
@@ -88,7 +91,7 @@ class Settable:
         self,
         name: str,
         val_type: type[Any] | Callable[[Any], Any],
-        description: str,
+        description: str | Text,
         settable_object: object,
         *,
         settable_attrib_name: str | None = None,
@@ -108,7 +111,7 @@ class Settable:
                          input is a valid integer. Specifying bool automatically provides
                          completion for 'true' and 'false' and uses a built-in function
                          for conversion and validation.
-        :param description: A concise string that describes the purpose of this setting.
+        :param description: A concise string or rich Text object that describes the purpose of this setting.
         :param settable_object: The object that owns the attribute being made settable (e.g. self).
         :param settable_attrib_name: The name of the attribute on the settable_object that
                                      will be modified. This defaults to the value of the name
@@ -142,7 +145,7 @@ class Settable:
 
         self.name = name
         self.val_type = val_type
-        self.description = description
+        self.description = ru.rich_text_to_string(description) if isinstance(description, Text) else description
         self.settable_obj = settable_object
         self.settable_attrib_name = settable_attrib_name if settable_attrib_name is not None else name
         self.onchange_cb = onchange_cb

{cmd2-4.1.1 → cmd2-4.1.2}/cmd2.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cmd2
-Version: 4.1.1
+Version: 4.1.2
 Summary: cmd2 - quickly build feature-rich and user-friendly interactive command line applications in Python
 Author: cmd2 Contributors
 License-Expression: MIT

{cmd2-4.1.1 → cmd2-4.1.2}/cmd2.egg-info/SOURCES.txt

@@ -128,7 +128,6 @@ examples/async_call.py
 examples/async_commands.py
 examples/async_printing.py
 examples/basic_completion.py
-examples/cmd2_history.dat
 examples/cmd_as_argument.py
 examples/color.py
 examples/command_sets.py

{cmd2-4.1.1 → cmd2-4.1.2}/cmd2.egg-info/scm_file_list.json

@@ -1,228 +1,228 @@
 {
   "files": [
+    ".coveragerc",
+    ".prettierignore",
+    ".prettierrc",
+    ".readthedocs.yaml",
+    "LICENSE",
+    "MANIFEST.in",
     "cmd2.png",
     "codecov.yml",
-    "mkdocs.yml",
-    "LICENSE",
-    "CHANGELOG.md",
-    ".pre-commit-config.yaml",
+    "package.json",
+    ".typos.toml",
     "Makefile",
+    "ruff.toml",
     "pyproject.toml",
-    "MANIFEST.in",
-    ".coveragerc",
-    ".prettierignore",
-    "README.md",
+    "mkdocs.yml",
     ".gitignore",
-    "package.json",
-    "ruff.toml",
-    ".prettierrc",
     "GEMINI.md",
-    ".typos.toml",
-    ".readthedocs.yaml",
-    "tests/test_parsing.py",
-    "tests/test_commandset.py",
-    "tests/test_utils.py",
-    "tests/conftest.py",
-    "tests/test_future_annotations.py",
-    "tests/test_plugin.py",
-    "tests/test_pt_utils.py",
-    "tests/test_rich_utils.py",
-    "tests/test_string_utils.py",
-    "tests/test_annotated.py",
-    "tests/__init__.py",
-    "tests/test_argparse_completer.py",
-    "tests/test_dynamic_complete_style.py",
-    "tests/test_cmd2.py",
-    "tests/test_categories.py",
-    "tests/test_py_completion.py",
-    "tests/test_theme.py",
-    "tests/test_argparse_utils.py",
-    "tests/test_run_pyscript.py",
-    "tests/relative_multiple.txt",
-    "tests/script.txt",
-    "tests/test_argparse_subcommands.py",
-    "tests/script.py",
-    "tests/test_history.py",
-    "tests/.cmd2rc",
-    "tests/test_completion.py",
-    "tests/test_utils_defining_class.py",
-    "tests/test_argparse.py",
-    "tests/scripts/empty.txt",
-    "tests/scripts/nested.txt",
-    "tests/scripts/postcmds.txt",
-    "tests/scripts/utf8.txt",
-    "tests/scripts/help.txt",
-    "tests/scripts/one_down.txt",
-    "tests/scripts/precmds.txt",
-    "tests/scripts/binary.bin",
-    "tests/pyscript/pyscript_dir.py",
-    "tests/pyscript/test_print.py",
-    "tests/pyscript/recursive.py",
-    "tests/pyscript/stop.py",
-    "tests/pyscript/self_in_py.py",
-    "tests/pyscript/raises_exception.py",
-    "tests/pyscript/environment.py",
-    "tests/pyscript/py_locals.py",
-    "tests/pyscript/help.py",
-    "tests/pyscript/echo.py",
-    "docs/upgrades.md",
-    "docs/testing.md",
+    ".pre-commit-config.yaml",
+    "README.md",
+    "CHANGELOG.md",
+    ".github/CODE_OF_CONDUCT.md",
+    ".github/dependabot.yml",
+    ".github/CODEOWNERS",
+    ".github/CONTRIBUTING.md",
+    ".github/images/graph.drawio.png",
+    ".github/workflows/codeql-analysis.yml",
+    ".github/workflows/docs.yml",
+    ".github/workflows/tests.yml",
+    ".github/workflows/typecheck.yml",
+    ".github/workflows/quality.yml",
+    "cmd2/clipboard.py",
+    "cmd2/py.typed",
+    "cmd2/command_set.py",
+    "cmd2/exceptions.py",
+    "cmd2/history.py",
+    "cmd2/plugin.py",
+    "cmd2/types.py",
+    "cmd2/string_utils.py",
+    "cmd2/colors.py",
+    "cmd2/completion.py",
+    "cmd2/py_bridge.py",
+    "cmd2/rich_utils.py",
+    "cmd2/parsing.py",
+    "cmd2/argparse_completer.py",
+    "cmd2/constants.py",
+    "cmd2/decorators.py",
+    "cmd2/__init__.py",
+    "cmd2/annotated.py",
+    "cmd2/argparse_utils.py",
+    "cmd2/pt_utils.py",
+    "cmd2/styles.py",
+    "cmd2/theme.py",
+    "cmd2/utils.py",
+    "cmd2/cmd2.py",
     "docs/index.md",
+    "docs/testing.md",
     "docs/doc_conventions.md",
-    "docs/overrides/main.html",
-    "docs/migrating/next_steps.md",
-    "docs/migrating/minimum.md",
-    "docs/migrating/incompatibilities.md",
-    "docs/migrating/index.md",
-    "docs/migrating/why.md",
-    "docs/mixins/mixin_template.md",
-    "docs/mixins/index.md",
-    "docs/features/generating_output.md",
-    "docs/features/async_commands.md",
-    "docs/features/settings.md",
-    "docs/features/multiline_commands.md",
-    "docs/features/embedded_python_shells.md",
-    "docs/features/initialization.md",
-    "docs/features/packaging.md",
-    "docs/features/commands.md",
-    "docs/features/annotated.md",
-    "docs/features/history.md",
-    "docs/features/prompt.md",
-    "docs/features/modular_commands.md",
-    "docs/features/help.md",
-    "docs/features/builtin_commands.md",
-    "docs/features/startup_commands.md",
-    "docs/features/clipboard.md",
-    "docs/features/argument_processing.md",
-    "docs/features/shortcuts_aliases_macros.md",
-    "docs/features/completion.md",
-    "docs/features/index.md",
-    "docs/features/theme.md",
-    "docs/features/disable_commands.md",
-    "docs/features/plugins.md",
-    "docs/features/hooks.md",
-    "docs/features/misc.md",
-    "docs/features/os.md",
-    "docs/features/table_creation.md",
-    "docs/features/scripting.md",
-    "docs/features/redirection.md",
-    "docs/examples/examples.md",
-    "docs/examples/getting_started.md",
-    "docs/examples/index.md",
-    "docs/examples/alternate_event_loops.md",
-    "docs/javascripts/readthedocs.js",
+    "docs/upgrades.md",
     "docs/api/argparse_completer.md",
+    "docs/api/clipboard.md",
+    "docs/api/cmd.md",
+    "docs/api/colors.md",
+    "docs/api/constants.md",
+    "docs/api/decorators.md",
     "docs/api/exceptions.md",
+    "docs/api/history.md",
+    "docs/api/parsing.md",
     "docs/api/plugin.md",
-    "docs/api/styles.md",
+    "docs/api/py_bridge.md",
     "docs/api/rich_utils.md",
     "docs/api/string_utils.md",
+    "docs/api/styles.md",
     "docs/api/utils.md",
-    "docs/api/annotated.md",
-    "docs/api/colors.md",
-    "docs/api/decorators.md",
-    "docs/api/history.md",
-    "docs/api/clipboard.md",
-    "docs/api/parsing.md",
-    "docs/api/cmd.md",
+    "docs/api/argparse_utils.md",
+    "docs/api/command_set.md",
     "docs/api/completion.md",
+    "docs/api/pt_utils.md",
+    "docs/api/annotated.md",
     "docs/api/index.md",
     "docs/api/theme.md",
-    "docs/api/command_set.md",
-    "docs/api/pt_utils.md",
-    "docs/api/argparse_utils.md",
-    "docs/api/py_bridge.md",
-    "docs/api/constants.md",
+    "docs/examples/examples.md",
+    "docs/examples/index.md",
+    "docs/examples/alternate_event_loops.md",
+    "docs/examples/getting_started.md",
+    "docs/features/clipboard.md",
+    "docs/features/commands.md",
+    "docs/features/disable_commands.md",
+    "docs/features/embedded_python_shells.md",
+    "docs/features/multiline_commands.md",
+    "docs/features/packaging.md",
+    "docs/features/plugins.md",
+    "docs/features/redirection.md",
+    "docs/features/scripting.md",
+    "docs/features/shortcuts_aliases_macros.md",
+    "docs/features/table_creation.md",
+    "docs/features/async_commands.md",
+    "docs/features/help.md",
+    "docs/features/history.md",
+    "docs/features/hooks.md",
+    "docs/features/misc.md",
+    "docs/features/os.md",
+    "docs/features/startup_commands.md",
+    "docs/features/builtin_commands.md",
+    "docs/features/completion.md",
+    "docs/features/settings.md",
+    "docs/features/generating_output.md",
+    "docs/features/theme.md",
+    "docs/features/index.md",
+    "docs/features/argument_processing.md",
+    "docs/features/modular_commands.md",
+    "docs/features/annotated.md",
+    "docs/features/initialization.md",
+    "docs/features/prompt.md",
+    "docs/javascripts/readthedocs.js",
+    "docs/migrating/minimum.md",
+    "docs/migrating/incompatibilities.md",
+    "docs/migrating/next_steps.md",
+    "docs/migrating/why.md",
+    "docs/migrating/index.md",
+    "docs/mixins/index.md",
+    "docs/mixins/mixin_template.md",
+    "docs/overrides/main.html",
+    "docs/overview/index.md",
     "docs/overview/resources.md",
     "docs/overview/alternatives.md",
     "docs/overview/integrating.md",
-    "docs/overview/index.md",
     "docs/overview/installation.md",
     "docs/stylesheets/cmd2.css",
+    "examples/.cmd2rc",
+    "examples/tmux_launch.sh",
+    "examples/tmux_split.sh",
+    "examples/README.md",
+    "examples/argparse_completion.py",
+    "examples/basic_completion.py",
+    "examples/color.py",
+    "examples/custom_types.py",
+    "examples/default_categories.py",
+    "examples/dynamic_commands.py",
     "examples/event_loops.py",
     "examples/exit_code.py",
+    "examples/help_categories.py",
     "examples/hooks.py",
-    "examples/python_scripting.py",
-    "examples/color.py",
-    "examples/rich_theme.py",
-    "examples/getting_started.py",
-    "examples/dynamic_commands.py",
-    "examples/default_categories.py",
     "examples/mixin.py",
-    "examples/pretty_print.py",
-    "examples/paged_output.py",
     "examples/modular_commandsets.py",
-    "examples/argparse_example.py",
-    "examples/custom_parser.py",
-    "examples/migrating.py",
-    "examples/rich_tables.py",
-    "examples/README.md",
-    "examples/cmd_as_argument.py",
-    "examples/async_call.py",
-    "examples/hello_cmd2.py",
     "examples/persistent_history.py",
-    "examples/basic_completion.py",
+    "examples/pretty_print.py",
+    "examples/python_scripting.py",
+    "examples/remove_builtin_commands.py",
     "examples/remove_settable.py",
-    "examples/async_printing.py",
-    "examples/tmux_launch.sh",
-    "examples/annotated_example.py",
+    "examples/rich_tables.py",
+    "examples/unicode_commands.py",
     "examples/environment.py",
+    "examples/async_call.py",
     "examples/async_commands.py",
-    "examples/custom_types.py",
-    "examples/remove_builtin_commands.py",
-    "examples/unicode_commands.py",
-    "examples/argparse_completion.py",
-    "examples/.cmd2rc",
-    "examples/command_sets.py",
-    "examples/help_categories.py",
+    "examples/cmd_as_argument.py",
     "examples/completion_item_choices.py",
+    "examples/migrating.py",
+    "examples/paged_output.py",
     "examples/read_input.py",
-    "examples/tmux_split.sh",
-    "examples/modular_commands/commandset_complex.py",
+    "examples/rich_theme.py",
+    "examples/argparse_example.py",
+    "examples/command_sets.py",
+    "examples/custom_parser.py",
+    "examples/annotated_example.py",
+    "examples/async_printing.py",
+    "examples/getting_started.py",
+    "examples/hello_cmd2.py",
+    "examples/modular_commands/__init__.py",
     "examples/modular_commands/commandset_basic.py",
+    "examples/modular_commands/commandset_complex.py",
     "examples/modular_commands/commandset_custominit.py",
-    "examples/modular_commands/__init__.py",
-    "examples/scripts/quit.txt",
     "examples/scripts/nested.txt",
-    "examples/scripts/save_help_text.py",
-    "examples/scripts/conditional.py",
+    "examples/scripts/quit.txt",
     "examples/scripts/script.txt",
-    "examples/scripts/script.py",
     "examples/scripts/arg_printer.py",
+    "examples/scripts/script.py",
+    "examples/scripts/conditional.py",
+    "examples/scripts/save_help_text.py",
     "scripts/validate_tag.py",
-    ".github/CODE_OF_CONDUCT.md",
-    ".github/CODEOWNERS",
-    ".github/CONTRIBUTING.md",
-    ".github/dependabot.yml",
-    ".github/images/graph.drawio.png",
-    ".github/workflows/codeql-analysis.yml",
-    ".github/workflows/typecheck.yml",
-    ".github/workflows/docs.yml",
-    ".github/workflows/quality.yml",
-    ".github/workflows/tests.yml",
-    "cmd2/pt_utils.py",
-    "cmd2/parsing.py",
-    "cmd2/command_set.py",
-    "cmd2/theme.py",
-    "cmd2/completion.py",
-    "cmd2/py_bridge.py",
-    "cmd2/constants.py",
-    "cmd2/__init__.py",
-    "cmd2/argparse_utils.py",
-    "cmd2/types.py",
-    "cmd2/rich_utils.py",
-    "cmd2/string_utils.py",
-    "cmd2/utils.py",
-    "cmd2/argparse_completer.py",
-    "cmd2/cmd2.py",
-    "cmd2/styles.py",
-    "cmd2/plugin.py",
-    "cmd2/py.typed",
-    "cmd2/exceptions.py",
-    "cmd2/clipboard.py",
-    "cmd2/annotated.py",
-    "cmd2/history.py",
-    "cmd2/colors.py",
-    "cmd2/decorators.py"
+    "tests/.cmd2rc",
+    "tests/__init__.py",
+    "tests/relative_multiple.txt",
+    "tests/script.txt",
+    "tests/test_utils_defining_class.py",
+    "tests/script.py",
+    "tests/test_argparse_subcommands.py",
+    "tests/test_categories.py",
+    "tests/test_dynamic_complete_style.py",
+    "tests/test_future_annotations.py",
+    "tests/test_history.py",
+    "tests/test_parsing.py",
+    "tests/test_plugin.py",
+    "tests/test_py_completion.py",
+    "tests/test_string_utils.py",
+    "tests/conftest.py",
+    "tests/test_completion.py",
+    "tests/test_theme.py",
+    "tests/test_rich_utils.py",
+    "tests/test_run_pyscript.py",
+    "tests/test_argparse.py",
+    "tests/test_argparse_completer.py",
+    "tests/test_argparse_utils.py",
+    "tests/test_commandset.py",
+    "tests/test_utils.py",
+    "tests/test_annotated.py",
+    "tests/test_pt_utils.py",
+    "tests/test_cmd2.py",
+    "tests/pyscript/pyscript_dir.py",
+    "tests/pyscript/py_locals.py",
+    "tests/pyscript/echo.py",
+    "tests/pyscript/help.py",
+    "tests/pyscript/raises_exception.py",
+    "tests/pyscript/recursive.py",
+    "tests/pyscript/self_in_py.py",
+    "tests/pyscript/stop.py",
+    "tests/pyscript/environment.py",
+    "tests/pyscript/test_print.py",
+    "tests/scripts/binary.bin",
+    "tests/scripts/empty.txt",
+    "tests/scripts/help.txt",
+    "tests/scripts/nested.txt",
+    "tests/scripts/one_down.txt",
+    "tests/scripts/utf8.txt",
+    "tests/scripts/postcmds.txt",
+    "tests/scripts/precmds.txt"
   ]
 }

cmd2-4.1.2/cmd2.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "4.1.2",
+  "distance": 0,
+  "node": "gcb4e6c59871e7a203754d3e3ddda61016eacb243",
+  "dirty": false,
+  "branch": "main",
+  "node_date": "2026-07-16"
+}

{cmd2-4.1.1 → cmd2-4.1.2}/examples/default_categories.py

@@ -13,7 +13,6 @@ import argparse
 
 import cmd2
 from cmd2 import (
-    Cmd2ArgumentParser,
     CommandSet,
     with_argparser,
     with_category,
@@ -48,16 +47,16 @@ class CategoryApp(cmd2.Cmd):
         """A standard command defined in the child class."""
         self.poutput("Application command executed")
 
-    @with_argparser(Cmd2ArgumentParser(description="Overridden quit command"))
-    def do_quit(self, _: argparse.Namespace) -> bool | None:
+    @with_argparser(cmd2.Cmd._build_quit_parser)
+    def do_quit(self, args: argparse.Namespace) -> bool | None:
         """Overriding a built-in command without a decorator moves it to our category."""
-        return super().do_quit("")
+        return super().do_quit(args.cmd2_statement)
 
     @with_category(cmd2.Cmd.DEFAULT_CATEGORY)
-    @with_argparser(Cmd2ArgumentParser(description="Overridden shortcuts command"))
-    def do_shortcuts(self, _: argparse.Namespace) -> None:
+    @with_argparser(cmd2.Cmd._build_shortcuts_parser)
+    def do_shortcuts(self, args: argparse.Namespace) -> None:
         """Overriding with @with_category(cmd2.Cmd.DEFAULT_CATEGORY) keeps it cmd2's category."""
-        super().do_shortcuts("")
+        super().do_shortcuts(args.cmd2_statement)
 
 
 if __name__ == "__main__":