cmd2 4.1.0__tar.gz → 4.1.2__tar.gz

{cmd2-4.1.0 → cmd2-4.1.2}/.pre-commit-config.yaml

@@ -14,7 +14,7 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.15.17"
+    rev: "v0.15.21"
     hooks:
       - id: ruff-format
         args: [--config=ruff.toml]
@@ -30,7 +30,7 @@ repos:
           - prettier-plugin-toml@2.0.6
 
   - repo: https://github.com/crate-ci/typos
-    rev: v1.47.2
+    rev: v1.48.0
     hooks:
       - id: typos
         exclude: |

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

@@ -1,3 +1,16 @@
+## 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
+    - Fixed a couple type issues that emerged with the upgrade to `mypy` 2.2.0
+- Enhancements
+    - Async alert messages can now be Rich renderables.
+
 ## 4.1.0 (July 7, 2026)
 
 - Breaking Changes

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cmd2
-Version: 4.1.0
+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.0 → cmd2-4.1.2}/cmd2/argparse_utils.py

@@ -1035,13 +1035,13 @@ class Cmd2ArgumentParser(argparse.ArgumentParser):
 
         self.exit(2, f"{formatted_message}\n")
 
-    def _get_formatter(self, **_kwargs: Any) -> Cmd2HelpFormatter:
+    def _get_formatter(self, *_args: Any, **_kwargs: Any) -> Cmd2HelpFormatter:
         """Override with customizations for Cmd2HelpFormatter."""
         return self.formatter_class(prog=self.prog, file=self._thread_locals.current_output_file)
 
-    def format_help(self) -> str:
+    def format_help(self, *args: Any, **kwargs: Any) -> str:
         """Override to add a newline."""
-        return super().format_help() + "\n"
+        return super().format_help(*args, **kwargs) + "\n"
 
     def _get_nargs_pattern(self, action: argparse.Action) -> str:
         """Override to support nargs ranges."""

{cmd2-4.1.0 → 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]
@@ -312,7 +309,11 @@ class CommandParsers:
 class AsyncAlert:
     """Contents of an asynchronous alert which display while user is at prompt.
 
-    :param msg: an optional message to be printed above the prompt.
+    :param msg: an optional printable object (including Rich renderables) to be
+                printed above the prompt.
+    :param soft_wrap: Enable soft wrap mode. This only applies with msg is not None.
+                      Defaults to True. See print_to() docstring for more details on
+                      this parameter.
     :param prompt: an optional string to dynamically replace the current prompt.
 
     :ivar timestamp: monotonic creation time of the alert. If an alert was created
@@ -320,7 +321,8 @@ class AsyncAlert:
                      to avoid a stale display, but its msg data will still be displayed.
     """
 
-    msg: str | None = None
+    msg: Any | None = None
+    soft_wrap: bool = True
     prompt: str | None = None
     timestamp: float = field(default_factory=time.monotonic, init=False)
 
@@ -1377,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,
             )
@@ -1394,7 +1396,7 @@ class Cmd:
             Settable(
                 "editor",
                 str,
-                ru.rich_text_to_string(editor_description),
+                editor_description,
                 self,
             )
         )
@@ -1429,7 +1431,7 @@ class Cmd:
             Settable(
                 "traceback_width",
                 utils.optional_int,
-                ru.rich_text_to_string(traceback_width_description),
+                traceback_width_description,
                 self,
             )
         )
@@ -1572,7 +1574,7 @@ class Cmd:
                           If False, Rich wraps text to fit the terminal width.
                           Set this to False when printing structured Renderables like
                           Tables, Panels, or Columns to ensure they render as expected.
-                          For example, when soft_wrap is True Panels truncate text
+                          For example, when soft_wrap is True, Panels truncate text
                           which is wider than the terminal.
         :param justify: justify method ("left", "center", "right", "full"). Defaults to None.
         :param emoji: If True, Rich will replace emoji codes (e.g., :smiley:) with their
@@ -3657,7 +3659,19 @@ class Cmd:
                 # prevents async alerts from printing once a command starts.
 
                 # Print all alerts at once to reduce flicker.
-                alert_text = "\n".join(alert.msg for alert in self._alert_queue if alert.msg)
+                console = self._get_core_print_console(
+                    file=self.stdout,
+                    emoji=False,
+                    markup=False,
+                    highlight=False,
+                )
+
+                with console.capture() as capture:
+                    for alert in self._alert_queue:
+                        if alert.msg is not None:
+                            console.print(alert.msg, soft_wrap=alert.soft_wrap)
+
+                alert_text = capture.get()
 
                 # Find the latest prompt update among all pending alerts.
                 latest_prompt = None
@@ -3681,7 +3695,7 @@ class Cmd:
                 if alert_text:
                     # Print the alert messages above the prompt.
                     with patch_stdout():
-                        print_formatted_text(pt_filter_style(alert_text))
+                        print_formatted_text(ANSI(alert_text), end="")
 
                 elif latest_prompt is not None:
                     # Refresh UI immediately to show the new prompt
@@ -5134,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:
@@ -5616,7 +5624,13 @@ class Cmd:
         # self.last_result will be set by do_run_script()
         return self.do_run_script(su.quote(relative_path))
 
-    def add_alert(self, *, msg: str | None = None, prompt: str | None = None) -> None:
+    def add_alert(
+        self,
+        *,
+        msg: Any | None = None,
+        soft_wrap: bool = True,
+        prompt: str | None = None,
+    ) -> None:
         """Queue an asynchronous alert to be displayed when the prompt is active.
 
         Examples:
@@ -5624,7 +5638,11 @@ class Cmd:
             add_alert(prompt="user@host> ")       # Update prompt only
             add_alert(msg="Done", prompt="> ")    # Update both
 
-        :param msg: an optional message to be printed above the prompt.
+        :param msg: an optional printable object (including Rich renderables) to be
+                    printed above the prompt.
+        :param soft_wrap: Enable soft wrap mode. This only applies with msg is not None.
+                          Defaults to True. See print_to() docstring for more details on
+                          this parameter.
         :param prompt: an optional string to dynamically replace the current prompt.
 
         """
@@ -5632,7 +5650,7 @@ class Cmd:
             return
 
         with self._alert_condition:
-            alert = AsyncAlert(msg=msg, prompt=prompt)
+            alert = AsyncAlert(msg=msg, soft_wrap=soft_wrap, prompt=prompt)
             self._alert_queue.append(alert)
             self._alert_condition.notify_all()
 

{cmd2-4.1.0 → 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.0 → cmd2-4.1.2}/cmd2.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cmd2
-Version: 4.1.0
+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.0 → 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