Added unit tests for printing.

Author: kmvanbrunt

cmd2/__init__.py

@@ -44,6 +44,7 @@
 )
 from .parsing import Statement
 from .py_bridge import CommandResult
+from .rich_utils import RichPrintKwargs
 from .string_utils import stylize
 from .styles import Cmd2Style
 from .utils import (
@@ -86,6 +87,8 @@
     'plugin',
     'rich_utils',
     'string_utils',
+    # Rich Utils
+    'RichPrintKwargs',
     # String Utils
     'stylize',
     # Styles,

cmd2/argparse_custom.py

@@ -399,7 +399,7 @@ def __init__(self, value: object, descriptive_data: Sequence[Any], *args: Any) -
         renderable_data = [obj if is_renderable(obj) else str(obj) for obj in descriptive_data]
 
         # Convert objects with ANSI styles to Rich Text for correct display width.
-        self.descriptive_data = ru.prepare_objects_for_rich_rendering(*renderable_data)
+        self.descriptive_data = ru.prepare_objects_for_rendering(*renderable_data)
 
         # Save the original value to support CompletionItems as argparse choices.
         # cmd2 has patched argparse so input is compared to this value instead of the CompletionItem instance.

cmd2/cmd2.py

@@ -1225,7 +1225,7 @@ def print_to(
                        method and still call `super()` without encountering unexpected keyword argument errors.
                        These arguments are not passed to Rich's Console.print().
         """
-        prepared_objects = ru.prepare_objects_for_rich_rendering(*objects)
+        prepared_objects = ru.prepare_objects_for_rendering(*objects)
 
         try:
             Cmd2GeneralConsole(file).print(
@@ -1469,7 +1469,7 @@ def ppaged(
 
         # Check if we are outputting to a pager.
         if functional_terminal and can_block:
-            prepared_objects = ru.prepare_objects_for_rich_rendering(*objects)
+            prepared_objects = ru.prepare_objects_for_rendering(*objects)
 
             # Chopping overrides soft_wrap
             if chop:

cmd2/rich_utils.py

@@ -299,7 +299,7 @@ def indent(renderable: RenderableType, level: int) -> Padding:
     return Padding.indent(renderable, level)
 
 
-def prepare_objects_for_rich_rendering(*objects: Any) -> tuple[Any, ...]:
+def prepare_objects_for_rendering(*objects: Any) -> tuple[Any, ...]:
     """Prepare a tuple of objects for printing by Rich's Console.print().
 
     This function converts any non-Rich object whose string representation contains

tests/test_cmd2.py

@@ -20,6 +20,7 @@
     COMMAND_NAME,
     Cmd2Style,
     Color,
+    RichPrintKwargs,
     clipboard,
     constants,
     exceptions,
@@ -2133,6 +2134,106 @@ def test_poutput_ansi_terminal(outsim_app) -> None:
     assert out == expected
 
 
+@with_ansi_style(ru.AllowStyle.ALWAYS)
+def test_poutput_highlight(outsim_app):
+    rich_print_kwargs = RichPrintKwargs(highlight=True)
+    outsim_app.poutput(
+        "My IP Address is 192.168.1.100.",
+        rich_print_kwargs=rich_print_kwargs,
+    )
+    out = outsim_app.stdout.getvalue()
+    assert out == "My IP Address is \x1b[1;92m192.168.1.100\x1b[0m.\n"
+
+
+@with_ansi_style(ru.AllowStyle.ALWAYS)
+def test_poutput_markup(outsim_app):
+    rich_print_kwargs = RichPrintKwargs(markup=True)
+    outsim_app.poutput(
+        "The leaves are [green]green[/green].",
+        rich_print_kwargs=rich_print_kwargs,
+    )
+    out = outsim_app.stdout.getvalue()
+    assert out == "The leaves are \x1b[32mgreen\x1b[0m.\n"
+
+
+@with_ansi_style(ru.AllowStyle.ALWAYS)
+def test_poutput_emoji(outsim_app):
+    rich_print_kwargs = RichPrintKwargs(emoji=True)
+    outsim_app.poutput(
+        "Look at the emoji :1234:.",
+        rich_print_kwargs=rich_print_kwargs,
+    )
+    out = outsim_app.stdout.getvalue()
+    assert out == "Look at the emoji 🔢.\n"
+
+
+@with_ansi_style(ru.AllowStyle.ALWAYS)
+def test_poutput_justify_and_width(outsim_app):
+    rich_print_kwargs = RichPrintKwargs(justify="right", width=10)
+
+    # Use a styled-string when justifying to check if its display width is correct.
+    outsim_app.poutput(
+        su.stylize("Hello", style="blue"),
+        rich_print_kwargs=rich_print_kwargs,
+    )
+    out = outsim_app.stdout.getvalue()
+    assert out == "     \x1b[34mHello\x1b[0m\n"
+
+
+@with_ansi_style(ru.AllowStyle.ALWAYS)
+def test_poutput_no_wrap_and_overflow(outsim_app):
+    rich_print_kwargs = RichPrintKwargs(no_wrap=True, overflow="ellipsis", width=10)
+
+    outsim_app.poutput(
+        "This is longer than width.",
+        soft_wrap=False,
+        rich_print_kwargs=rich_print_kwargs,
+    )
+    out = outsim_app.stdout.getvalue()
+    assert out.startswith("This is l…\n")
+
+
+@with_ansi_style(ru.AllowStyle.ALWAYS)
+def test_poutput_pretty_print(outsim_app):
+    """Test that cmd2 passes objects through so they can be pretty-printed when highlighting is enabled."""
+    rich_print_kwargs = RichPrintKwargs(highlight=True)
+    dictionary = {1: 'hello', 2: 'person', 3: 'who', 4: 'codes'}
+
+    outsim_app.poutput(
+        dictionary,
+        rich_print_kwargs=rich_print_kwargs,
+    )
+    out = outsim_app.stdout.getvalue()
+    assert out.startswith("\x1b[1m{\x1b[0m\x1b[1;36m1\x1b[0m: \x1b[32m'hello'\x1b[0m")
+
+
+@with_ansi_style(ru.AllowStyle.ALWAYS)
+def test_poutput_all_keyword_args(outsim_app):
+    """Test that all fields in RichPrintKwargs are recognized by Rich's Console.print()."""
+    rich_print_kwargs = RichPrintKwargs(
+        justify="center",
+        overflow="ellipsis",
+        no_wrap=True,
+        markup=True,
+        emoji=True,
+        highlight=True,
+        width=40,
+        height=50,
+        crop=False,
+        new_line_start=True,
+    )
+
+    outsim_app.poutput(
+        "My string",
+        rich_print_kwargs=rich_print_kwargs,
+    )
+
+    # Verify that something printed which means Console.print() didn't
+    # raise a TypeError for an unexpected keyword argument.
+    out = outsim_app.stdout.getvalue()
+    assert "My string" in out
+
+
 def test_broken_pipe_error(outsim_app, monkeypatch, capsys):
     write_mock = mock.MagicMock()
     write_mock.side_effect = BrokenPipeError