Merge branch 'main' into documentation_fixes

Author: theagilehacker

.github/workflows/tests.yml

@@ -28,7 +28,7 @@ jobs:
         uses: astral-sh/setup-uv@v6
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
           allow-prereleases: true

CHANGELOG.md

@@ -44,6 +44,8 @@ time reading the [rich documentation](https://rich.readthedocs.io/).
         - [argparse_example.py](https://github.com/python-cmd2/cmd2/blob/main/examples/argparse_example.py)
         - [command_sets.py](https://github.com/python-cmd2/cmd2/blob/main/examples/command_sets.py)
         - [getting_started.py](https://github.com/python-cmd2/cmd2/blob/main/examples/getting_started.py)
+    - Optimized performance of terminal fixup during command finalization by replacing `stty sane`
+      with `termios.tcsetattr`
 
 - Bug Fixes
     - Fixed a redirection bug where `cmd2` could unintentionally overwrite an application's

cmd2/cmd2.py

@@ -508,6 +508,19 @@ def __init__(
         # Commands that will run at the beginning of the command loop
         self._startup_commands: list[str] = []
 
+        # Store initial termios settings to restore after each command.
+        # This is a faster way of accomplishing what "stty sane" does.
+        self._initial_termios_settings = None
+        if not sys.platform.startswith('win') and self.stdin.isatty():
+            try:
+                import io
+                import termios
+
+                self._initial_termios_settings = termios.tcgetattr(self.stdin.fileno())
+            except (ImportError, io.UnsupportedOperation, termios.error):
+                # This can happen if termios isn't available or stdin is a pseudo-TTY
+                self._initial_termios_settings = None
+
         # If a startup script is provided and exists, then execute it in the startup commands
         if startup_script:
             startup_script = os.path.abspath(os.path.expanduser(startup_script))
@@ -1198,22 +1211,39 @@ def print_to(
         end: str = "\n",
         style: StyleType | None = None,
         soft_wrap: bool = True,
+        emoji: bool = False,
+        markup: bool = False,
+        highlight: bool = False,
         rich_print_kwargs: RichPrintKwargs | None = None,
         **kwargs: Any,  # noqa: ARG002
     ) -> None:
         """Print objects to a given file stream.
 
+        This method is configured for general-purpose printing. By default, it enables
+        soft wrap and disables Rich's automatic detection for markup, emoji, and highlighting.
+        These defaults can be overridden by passing explicit keyword arguments.
+
         :param file: file stream being written to
         :param objects: objects to print
         :param sep: string to write between printed text. Defaults to " ".
         :param end: string to write at end of printed text. Defaults to a newline.
         :param style: optional style to apply to output
-        :param soft_wrap: Enable soft wrap mode. If True, lines of text will not be word-wrapped or cropped to
-                          fit the terminal width. Defaults to True.
+        :param soft_wrap: Enable soft wrap mode. If True, lines of text will not be
+                          word-wrapped or cropped to fit the terminal width. Defaults to True.
+        :param emoji: If True, Rich will replace emoji codes (e.g., :smiley:) with their
+                      corresponding Unicode characters. Defaults to False.
+        :param markup: If True, Rich will interpret strings with tags (e.g., [bold]hello[/bold])
+                       as styled output. Defaults to False.
+        :param highlight: If True, Rich will automatically apply highlighting to elements within
+                          strings, such as common Python data types like numbers, booleans, or None.
+                          This is particularly useful when pretty printing objects like lists and
+                          dictionaries to display them in color. Defaults to False.
         :param rich_print_kwargs: optional additional keyword arguments to pass to Rich's Console.print().
         :param kwargs: Arbitrary keyword arguments. This allows subclasses to extend the signature of this
                        method and still call `super()` without encountering unexpected keyword argument errors.
                        These arguments are not passed to Rich's Console.print().
+
+        See the Rich documentation for more details on emoji codes, markup tags, and highlighting.
         """
         prepared_objects = ru.prepare_objects_for_rendering(*objects)
 
@@ -1224,6 +1254,9 @@ def print_to(
                 end=end,
                 style=style,
                 soft_wrap=soft_wrap,
+                emoji=emoji,
+                markup=markup,
+                highlight=highlight,
                 **(rich_print_kwargs if rich_print_kwargs is not None else {}),
             )
         except BrokenPipeError:
@@ -1242,6 +1275,9 @@ def poutput(
         end: str = "\n",
         style: StyleType | None = None,
         soft_wrap: bool = True,
+        emoji: bool = False,
+        markup: bool = False,
+        highlight: bool = False,
         rich_print_kwargs: RichPrintKwargs | None = None,
         **kwargs: Any,  # noqa: ARG002
     ) -> None:
@@ -1256,6 +1292,9 @@ def poutput(
             end=end,
             style=style,
             soft_wrap=soft_wrap,
+            emoji=emoji,
+            markup=markup,
+            highlight=highlight,
             rich_print_kwargs=rich_print_kwargs,
         )
 
@@ -1266,6 +1305,9 @@ def perror(
         end: str = "\n",
         style: StyleType | None = Cmd2Style.ERROR,
         soft_wrap: bool = True,
+        emoji: bool = False,
+        markup: bool = False,
+        highlight: bool = False,
         rich_print_kwargs: RichPrintKwargs | None = None,
         **kwargs: Any,  # noqa: ARG002
     ) -> None:
@@ -1282,6 +1324,9 @@ def perror(
             end=end,
             style=style,
             soft_wrap=soft_wrap,
+            emoji=emoji,
+            markup=markup,
+            highlight=highlight,
             rich_print_kwargs=rich_print_kwargs,
         )
 
@@ -1291,6 +1336,9 @@ def psuccess(
         sep: str = " ",
         end: str = "\n",
         soft_wrap: bool = True,
+        emoji: bool = False,
+        markup: bool = False,
+        highlight: bool = False,
         rich_print_kwargs: RichPrintKwargs | None = None,
         **kwargs: Any,  # noqa: ARG002
     ) -> None:
@@ -1304,6 +1352,9 @@ def psuccess(
             end=end,
             style=Cmd2Style.SUCCESS,
             soft_wrap=soft_wrap,
+            emoji=emoji,
+            markup=markup,
+            highlight=highlight,
             rich_print_kwargs=rich_print_kwargs,
         )
 
@@ -1313,6 +1364,9 @@ def pwarning(
         sep: str = " ",
         end: str = "\n",
         soft_wrap: bool = True,
+        emoji: bool = False,
+        markup: bool = False,
+        highlight: bool = False,
         rich_print_kwargs: RichPrintKwargs | None = None,
         **kwargs: Any,  # noqa: ARG002
     ) -> None:
@@ -1326,6 +1380,9 @@ def pwarning(
             end=end,
             style=Cmd2Style.WARNING,
             soft_wrap=soft_wrap,
+            emoji=emoji,
+            markup=markup,
+            highlight=highlight,
             rich_print_kwargs=rich_print_kwargs,
         )
 
@@ -1390,6 +1447,9 @@ def pfeedback(
         end: str = "\n",
         style: StyleType | None = None,
         soft_wrap: bool = True,
+        emoji: bool = False,
+        markup: bool = False,
+        highlight: bool = False,
         rich_print_kwargs: RichPrintKwargs | None = None,
         **kwargs: Any,  # noqa: ARG002
     ) -> None:
@@ -1408,6 +1468,9 @@ def pfeedback(
                     end=end,
                     style=style,
                     soft_wrap=soft_wrap,
+                    emoji=emoji,
+                    markup=markup,
+                    highlight=highlight,
                     rich_print_kwargs=rich_print_kwargs,
                 )
             else:
@@ -1417,6 +1480,9 @@ def pfeedback(
                     end=end,
                     style=style,
                     soft_wrap=soft_wrap,
+                    emoji=emoji,
+                    markup=markup,
+                    highlight=highlight,
                     rich_print_kwargs=rich_print_kwargs,
                 )
 
@@ -1428,6 +1494,9 @@ def ppaged(
         style: StyleType | None = None,
         chop: bool = False,
         soft_wrap: bool = True,
+        emoji: bool = False,
+        markup: bool = False,
+        highlight: bool = False,
         rich_print_kwargs: RichPrintKwargs | None = None,
         **kwargs: Any,  # noqa: ARG002
     ) -> None:
@@ -1479,6 +1548,9 @@ def ppaged(
                     end=end,
                     style=style,
                     soft_wrap=soft_wrap,
+                    emoji=emoji,
+                    markup=markup,
+                    highlight=highlight,
                     **(rich_print_kwargs if rich_print_kwargs is not None else {}),
                 )
             output_bytes = capture.get().encode('utf-8', 'replace')
@@ -1503,6 +1575,9 @@ def ppaged(
                 end=end,
                 style=style,
                 soft_wrap=soft_wrap,
+                emoji=emoji,
+                markup=markup,
+                highlight=highlight,
                 rich_print_kwargs=rich_print_kwargs,
             )
 
@@ -2760,14 +2835,15 @@ def onecmd_plus_hooks(
 
     def _run_cmdfinalization_hooks(self, stop: bool, statement: Statement | None) -> bool:
         """Run the command finalization hooks."""
-        with self.sigint_protection:
-            if not sys.platform.startswith('win') and self.stdin.isatty():
-                # Before the next command runs, fix any terminal problems like those
-                # caused by certain binary characters having been printed to it.
-                import subprocess
-
-                proc = subprocess.Popen(['stty', 'sane'])  # noqa: S607
-                proc.communicate()
+        if self._initial_termios_settings is not None and self.stdin.isatty():
+            import io
+            import termios
+
+            # Before the next command runs, fix any terminal problems like those
+            # caused by certain binary characters having been printed to it.
+            with self.sigint_protection, contextlib.suppress(io.UnsupportedOperation, termios.error):
+                # This can fail if stdin is a pseudo-TTY, in which case we just ignore it
+                termios.tcsetattr(self.stdin.fileno(), termios.TCSANOW, self._initial_termios_settings)
 
         data = plugin.CommandFinalizationData(stop, statement)
         for func in self._cmdfinalization_hooks:

cmd2/rich_utils.py

@@ -110,9 +110,6 @@ class RichPrintKwargs(TypedDict, total=False):
     justify: JustifyMethod | None
     overflow: OverflowMethod | None
     no_wrap: bool | None
-    markup: bool | None
-    emoji: bool | None
-    highlight: bool | None
     width: int | None
     height: int | None
     crop: bool
@@ -216,9 +213,11 @@ def __init__(self, file: IO[str] | None = None) -> None:
         :param file: optional file object where the console should write to.
                      Defaults to sys.stdout.
         """
-        # Disable Rich's automatic detection for markup, emoji, and highlighting.
-        # rich-argparse does markup and highlighting without involving the console
-        # so these won't affect its internal functionality.
+        # Since this console is used to print error messages which may not have
+        # been pre-formatted by rich-argparse, disable Rich's automatic detection
+        # for markup, emoji, and highlighting. rich-argparse does markup and
+        # highlighting without involving the console so these won't affect its
+        # internal functionality.
         super().__init__(
             file=file,
             markup=False,
@@ -236,7 +235,7 @@ class Cmd2ExceptionConsole(Cmd2BaseConsole):
 
 def console_width() -> int:
     """Return the width of the console."""
-    return Cmd2BaseConsole().width
+    return Console().width
 
 
 def rich_text_to_string(text: Text) -> str: