Fixed issue where ANSI strings were being placed in tables without being converted to a Text object.

Fixed issue where ALLOW_STYLE policy was not being recognized when displaying completion results.
Added plain text versions of display and display_meta fields for sorting.

Author: kmvanbrunt

cmd2/argparse_completer.py

@@ -18,6 +18,8 @@
     cast,
 )
 
+from rich.text import Text
+
 from .constants import INFINITY
 from .rich_utils import Cmd2GeneralConsole
 
@@ -587,7 +589,7 @@ def _complete_flags(self, text: str, line: str, begidx: int, endidx: int, used_f
         return Completions(items)
 
     def _format_completions(self, arg_state: _ArgumentState, completions: Completions) -> Completions:
-        """Format CompletionItems into hint table."""
+        """Format CompletionItems into completion table."""
         # Skip table generation for single results or if the list exceeds the
         # user-defined threshold for table display.
         if len(completions) < 2 or len(completions) > self._cmd2_app.max_completion_table_items:
@@ -611,7 +613,7 @@ def _format_completions(self, arg_state: _ArgumentState, completions: Completion
         # Determine if all display values are numeric so we can right-align them
         all_nums = all_display_numeric(completions.items)
 
-        # Build header row for the hint table
+        # Build header row
         rich_columns: list[Column] = []
         rich_columns.append(Column(destination.upper(), justify="right" if all_nums else "left", no_wrap=True))
         table_header = cast(Sequence[str | Column] | None, arg_state.action.get_table_header())  # type: ignore[attr-defined]
@@ -621,12 +623,12 @@ def _format_completions(self, arg_state: _ArgumentState, completions: Completion
             column if isinstance(column, Column) else Column(column, overflow="fold") for column in table_header
         )
 
-        # Build the hint table
+        # Add the data rows
         hint_table = Table(*rich_columns, box=SIMPLE_HEAD, show_edge=False, border_style=Cmd2Style.TABLE_BORDER)
         for item in completions:
-            hint_table.add_row(item.display, *item.table_row)
+            hint_table.add_row(Text.from_ansi(item.display), *item.table_row)
 
-        # Generate the hint table string
+        # Generate the table string
         console = Cmd2GeneralConsole()
         with console.capture() as capture:
             console.print(hint_table, end="", soft_wrap=False)

cmd2/cmd2.py

@@ -4424,7 +4424,7 @@ def do_set(self, args: argparse.Namespace) -> None:
             settable_table.add_row(
                 param,
                 str(settable.value),
-                settable.description,
+                Text.from_ansi(settable.description),
             )
             self.last_result[param] = settable.value
 

cmd2/completion.py

@@ -21,6 +21,8 @@
     overload,
 )
 
+from . import string_utils as su
+
 if TYPE_CHECKING:  # pragma: no cover
     from .cmd2 import Cmd
     from .command_definition import CommandSet
@@ -64,15 +66,22 @@ class CompletionItem:
     text: str = ""
 
     # Optional string for displaying the completion differently in the completion menu.
+    # This can contain ANSI style sequences. A plain version is stored in display_plain.
     display: str = ""
 
     # Optional meta information about completion which displays in the completion menu.
+    # This can contain ANSI style sequences. A plain version is stored in display_meta_plain.
     display_meta: str = ""
 
     # Optional row data for completion tables. Length must match the associated argparse
     # argument's table_header. This is stored internally as a tuple.
     table_row: Sequence[Any] = field(default_factory=tuple)
 
+    # Plain text versions of display fields (stripped of ANSI) for sorting/filtering.
+    # These are set in __post_init__().
+    display_plain: str = field(init=False)
+    display_meta_plain: str = field(init=False)
+
     def __post_init__(self) -> None:
         """Finalize the object after initialization."""
         # Derive text from value if it wasn't explicitly provided
@@ -83,6 +92,11 @@ def __post_init__(self) -> None:
         if not self.display:
             object.__setattr__(self, "display", self.text)
 
+        # Pre-calculate plain text versions by stripping ANSI sequences.
+        # These are stored as attributes for fast access during sorting/filtering.
+        object.__setattr__(self, "display_plain", su.strip_style(self.display))
+        object.__setattr__(self, "display_meta_plain", su.strip_style(self.display_meta))
+
         # Make sure all table row objects are renderable by a Rich table.
         renderable_data = [obj if is_renderable(obj) else str(obj) for obj in self.table_row]
 
@@ -140,10 +154,10 @@ def __post_init__(self) -> None:
         if not self.is_sorted:
             if all_display_numeric(unique_items):
                 # Sort numerically
-                unique_items.sort(key=lambda item: float(item.display))
+                unique_items.sort(key=lambda item: float(item.display_plain))
             else:
                 # Standard string sort
-                unique_items.sort(key=lambda item: utils.DEFAULT_STR_SORT_KEY(item.display))
+                unique_items.sort(key=lambda item: utils.DEFAULT_STR_SORT_KEY(item.display_plain))
 
             object.__setattr__(self, "is_sorted", True)
 
@@ -247,8 +261,8 @@ class Completions(CompletionResultsBase):
 
 
 def all_display_numeric(items: Collection[CompletionItem]) -> bool:
-    """Return True if items is non-empty and every item.display is a numeric string."""
-    return bool(items) and all(NUMERIC_RE.match(item.display) for item in items)
+    """Return True if items is non-empty and every item.display_plain value is a numeric string."""
+    return bool(items) and all(NUMERIC_RE.match(item.display_plain) for item in items)
 
 
 #############################################

cmd2/pt_utils.py

@@ -24,6 +24,7 @@
     constants,
     utils,
 )
+from . import rich_utils as ru
 
 if TYPE_CHECKING:  # pragma: no cover
     from .cmd2 import Cmd
@@ -101,6 +102,9 @@ def get_completions(self, document: Document, _complete_event: object) -> Iterab
             buffer.cursor_right(search_text_length)
             return
 
+        # Determine if we should remove style from completion text
+        remove_style = ru.ALLOW_STYLE == ru.AllowStyle.NEVER
+
         # Return the completions
         for item in completions:
             # Set offset to the start of the current word to overwrite it with the completion
@@ -129,8 +133,8 @@ def get_completions(self, document: Document, _complete_event: object) -> Iterab
             yield Completion(
                 match_text,
                 start_position=start_position,
-                display=ANSI(item.display),
-                display_meta=ANSI(item.display_meta),
+                display=item.display_plain if remove_style else ANSI(item.display),
+                display_meta=item.display_meta_plain if remove_style else ANSI(item.display_meta),
             )
 
 

tests/scripts/postcmds.txt

@@ -1 +1 @@
-set allow_style Never
+set always_show_hint False

tests/scripts/precmds.txt

@@ -1 +1 @@
-set allow_style Always
+set always_show_hint True

tests/test_cmd2.py

@@ -465,11 +465,11 @@ def test_run_script_nested_run_scripts(base_app, request) -> None:
     expected = f"""
 {initial_run}
 _relative_run_script precmds.txt
-set allow_style Always
+set always_show_hint True
 help
 shortcuts
 _relative_run_script postcmds.txt
-set allow_style Never"""
+set always_show_hint False"""
     out, _err = run_cmd(base_app, 'history -s')
     assert out == normalize(expected)
 
@@ -482,11 +482,11 @@ def test_runcmds_plus_hooks(base_app, request) -> None:
     base_app.runcmds_plus_hooks(['run_script ' + prefilepath, 'help', 'shortcuts', 'run_script ' + postfilepath])
     expected = f"""
 run_script {prefilepath}
-set allow_style Always
+set always_show_hint True
 help
 shortcuts
 run_script {postfilepath}
-set allow_style Never"""
+set always_show_hint False"""
 
     out, _err = run_cmd(base_app, 'history -s')
     assert out == normalize(expected)