Added unit tests.

Author: kmvanbrunt

cmd2/rich_utils.py

@@ -30,9 +30,19 @@
 from .styles import DEFAULT_CMD2_STYLES
 
 # A compiled regular expression to detect ANSI escape sequences.
-# The `[a-zA-Z]` at the end of the regex allows it to match all types of
-# escape sequences, including those for styling, cursor movement, etc.
-_ANSI_ESCAPE_SEQUENCE_RE = re.compile(r"\x1b\[[0-9;?]*[a-zA-Z]")
+_ANSI_ESCAPE_SEQUENCE_RE = re.compile(
+    r"""
+    \x1b              # Match the Escape character (ESC)
+    (?:               # Start of non-capturing group for the different sequence types
+        \[[0-9;?]*[a-zA-Z]  # Match a CSI sequence (e.g., \x1b[31m)
+    |                 # OR
+        \].*?(?:\x07|\x1b\x5c)  # Match an OSC sequence (e.g., \x1b]2;Hello\x07)
+    |                 # OR
+        \x37|\x38     # Match DEC cursor save/restore sequences
+    )                 # End of non-capturing group
+""",
+    re.VERBOSE,
+)
 
 
 class AllowStyle(Enum):

tests/test_rich_utils.py

@@ -139,3 +139,23 @@ def test_set_theme() -> None:
 
     assert ru.APP_THEME.styles[rich_style_key] != orig_rich_style
     assert ru.APP_THEME.styles[rich_style_key] == theme[rich_style_key]
+
+
+def test_ansi_escape_sequence_re() -> None:
+    import cmd2.terminal_utils as tu
+
+    # Test a CSI sequence
+    cursor_contol = tu.Cursor.UP(1)
+    assert ru._ANSI_ESCAPE_SEQUENCE_RE.search(cursor_contol)
+
+    # Test an OSC sequence
+    set_title = tu.set_title_str("Hello")
+    assert ru._ANSI_ESCAPE_SEQUENCE_RE.search(set_title)
+
+    # Test DEC cursor save
+    cursor_save = "\x1b\x37"
+    assert ru._ANSI_ESCAPE_SEQUENCE_RE.search(cursor_save)
+
+    # Test DEC cursor restore
+    cursor_restore = "\x1b\x38"
+    assert ru._ANSI_ESCAPE_SEQUENCE_RE.search(cursor_restore)