cmd2 3.2.0__tar.gz → 3.2.2__tar.gz

{cmd2-3.2.0 → cmd2-3.2.2}/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 3.2.2 (February 21, 2026)
+
+- Bug Fixes
+    - Updated `rich_utils.ANSI_STYLE_SEQUENCE_RE` to only match ANSI SGR (Select Graphic Rendition)
+      sequences for text styling. It previously also matched DEC Private Mode sequences.
+
+## 3.2.1 (February 21, 2026)
+
+- Bug Fixes
+    - The `async_alert` and `async_prompt_update` methods of `cmd2.Cmd` now respect the current
+      value of the `allow_style` settable
+        - If `allow_style` is `NEVER`, all style-related ANSI escape codes will be stripped to
+          ensure plain text output
+
 ## 3.2.0 (February 5, 2026)
 
 - Bug Fixes

{cmd2-3.2.0 → cmd2-3.2.2}/PKG-INFO

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

{cmd2-3.2.0 → cmd2-3.2.2}/cmd2/cmd2.py

@@ -5744,6 +5744,8 @@ class Cmd:
             update_terminal = False
 
             if alert_msg:
+                if self.allow_style == ru.AllowStyle.NEVER:
+                    alert_msg = su.strip_style(alert_msg)
                 alert_msg += '\n'
                 update_terminal = True
 

{cmd2-3.2.0 → cmd2-3.2.2}/cmd2/rich_utils.py

@@ -30,8 +30,11 @@ from rich_argparse import RichHelpFormatter
 
 from .styles import DEFAULT_CMD2_STYLES
 
-# A compiled regular expression to detect ANSI style sequences.
-ANSI_STYLE_SEQUENCE_RE = re.compile(r"\x1b\[[0-9;?]*m")
+# Matches ANSI SGR (Select Graphic Rendition) sequences for text styling.
+# \x1b[   - the CSI (Control Sequence Introducer)
+# [0-9;]* - zero or more digits or semicolons (parameters for the style)
+# m       - the SGR final character
+ANSI_STYLE_SEQUENCE_RE = re.compile(r"\x1b\[[0-9;]*m")
 
 
 class AllowStyle(Enum):

{cmd2-3.2.0 → cmd2-3.2.2}/cmd2/string_utils.py

@@ -95,7 +95,10 @@ def stylize(val: str, style: StyleType) -> str:
 
 
 def strip_style(val: str) -> str:
-    """Strip all ANSI style sequences from a string.
+    """Strip all ANSI style sequences (colors, bold, etc.) from a string.
+
+    This targets SGR sequences specifically and leaves other terminal
+    control codes intact.
 
     :param val: string to be stripped
     :return: the stripped string

{cmd2-3.2.0 → cmd2-3.2.2}/cmd2.egg-info/PKG-INFO

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

{cmd2-3.2.0 → cmd2-3.2.2}/cmd2.egg-info/SOURCES.txt

@@ -175,6 +175,7 @@ tests/test_argparse.py
 tests/test_argparse_completer.py
 tests/test_argparse_custom.py
 tests/test_argparse_subcommands.py
+tests/test_async_alert.py
 tests/test_categories.py
 tests/test_cmd2.py
 tests/test_commandset.py

cmd2-3.2.2/tests/test_async_alert.py

@@ -0,0 +1,50 @@
+import unittest
+from unittest.mock import MagicMock, patch
+
+import cmd2
+import cmd2.cmd2  # to patch vt100_support
+from cmd2 import rich_utils as ru
+
+
+class TestAsyncAlert(unittest.TestCase):
+    def test_async_alert_strips_ansi_when_allow_style_is_never(self):
+        app = cmd2.Cmd()
+
+        # Patch vt100_support to True
+        with patch('cmd2.cmd2.vt100_support', True):
+            # Patch threading functions
+            mock_current_thread = MagicMock()
+            mock_current_thread.name = "NotMainThread"
+
+            with (
+                patch('threading.current_thread', return_value=mock_current_thread),
+                patch('threading.main_thread', return_value=MagicMock()),
+                patch('cmd2.cmd2.rl_get_display_prompt', return_value='(Cmd) '),
+                patch('cmd2.cmd2.readline.get_line_buffer', return_value=''),
+                patch('cmd2.cmd2.rl_get_point', return_value=0),
+                patch('cmd2.cmd2.rl_force_redisplay'),
+                patch('sys.stdout', new_callable=MagicMock) as mock_stdout,
+            ):
+                # Set allow_style to NEVER
+                app.allow_style = ru.AllowStyle.NEVER
+
+                # Styled message
+                msg = "\033[31mError\033[0m"
+
+                # Call async_alert
+                app.async_alert(msg)
+
+                # Capture calls to write
+                # mock_stdout.write.call_args_list -> [call(str), call(str)...]
+                # We look at all written strings
+                written_content = "".join([call.args[0] for call in mock_stdout.write.call_args_list])
+
+                # Check that ANSI codes for color are NOT present
+                if "\033[31m" in written_content:
+                    raise AssertionError(f"Found ANSI color code in output: {written_content!r}")
+                if "Error" not in written_content:
+                    raise AssertionError(f"Message 'Error' not found in output: {written_content!r}")
+
+
+if __name__ == '__main__':
+    unittest.main()

{cmd2-3.2.0 → cmd2-3.2.2}/tests/test_string_utils.py

@@ -126,11 +126,44 @@ def test_stylize() -> None:
     assert restyled_string == "\x1b[1;4;9;32;44mHello, world!\x1b[0m"
 
 
-def test_strip_style() -> None:
-    base_str = HELLO_WORLD
-    styled_str = su.stylize(base_str, style=Color.GREEN)
-    assert base_str != styled_str
-    assert base_str == su.strip_style(styled_str)
+def test_strip_basic_styles() -> None:
+    # Test bold, colors, and resets
+    assert su.strip_style("\x1b[1mBold\x1b[0m") == "Bold"
+    assert su.strip_style("\x1b[31mRed\x1b[0m") == "Red"
+    assert su.strip_style("\x1b[4;32mUnderline Green\x1b[0m") == "Underline Green"
+
+
+def test_strip_complex_colors() -> None:
+    # Test 256-color and RGB (TrueColor) sequences
+    # These use semicolons as separators and end in 'm'
+    assert su.strip_style("\x1b[38;5;208mOrange\x1b[0m") == "Orange"
+    assert su.strip_style("\x1b[38;2;255;87;51mCustom RGB\x1b[0m") == "Custom RGB"
+
+
+def test_preserve_non_style_csi() -> None:
+    # Test that cursor movements and other CSI codes are not stripped
+    # Cursor Up (\x1b[A) and Cursor Position (\x1b[10;5H)
+    cursor_up = "\x1b[A"
+    cursor_pos = "\x1b[10;5H"
+    assert su.strip_style(cursor_up) == cursor_up
+    assert su.strip_style(cursor_pos) == cursor_pos
+
+
+def test_preserve_private_modes() -> None:
+    # Test that DEC Private Modes (containing '?') are not stripped
+    # Hide cursor (\x1b[?25l) and Show cursor (\x1b[?25h)
+    hide_cursor = "\x1b[?25l"
+    show_cursor = "\x1b[?25h"
+    assert su.strip_style(hide_cursor) == hide_cursor
+    assert su.strip_style(show_cursor) == show_cursor
+
+
+def test_mixed_content() -> None:
+    # Test a string that has both style and control sequences
+    # Red text + Hide Cursor
+    mixed = "\x1b[31mRed Text\x1b[0m\x1b[?25l"
+    # Only the red style should be removed
+    assert su.strip_style(mixed) == "Red Text\x1b[?25l"
 
 
 def test_str_width() -> None: