Reformatted cmd2 tables and help output.

Added Cmd2Style.TABLE_BORDER style.

Author: kmvanbrunt

cmd2/argparse_completer.py

@@ -16,31 +16,26 @@
     cast,
 )
 
-from .constants import (
-    INFINITY,
-)
+from .constants import INFINITY
 from .rich_utils import Cmd2GeneralConsole
 
 if TYPE_CHECKING:  # pragma: no cover
-    from .cmd2 import (
-        Cmd,
-    )
+    from .cmd2 import Cmd
 
 from rich.box import SIMPLE_HEAD
-from rich.table import Column, Table
+from rich.table import (
+    Column,
+    Table,
+)
 
 from .argparse_custom import (
     ChoicesCallable,
     ChoicesProviderFuncWithTokens,
     CompletionItem,
     generate_range_error,
 )
-from .command_definition import (
-    CommandSet,
-)
-from .exceptions import (
-    CompletionError,
-)
+from .command_definition import CommandSet
+from .exceptions import CompletionError
 from .styles import Cmd2Style
 
 # If no descriptive headers are supplied, then this will be used instead
@@ -583,8 +578,7 @@ def _format_completions(self, arg_state: _ArgumentState, completions: list[str]
             hint_table = Table(
                 *headers,
                 box=SIMPLE_HEAD,
-                show_edge=False,
-                border_style=Cmd2Style.RULE_LINE,
+                border_style=Cmd2Style.TABLE_BORDER,
             )
             for item in completion_items:
                 hint_table.add_row(item, *item.descriptive_data)

cmd2/cmd2.py

@@ -63,8 +63,9 @@
     cast,
 )
 
-from rich.box import SIMPLE_HEAD
+import rich.box
 from rich.console import Group
+from rich.padding import Padding
 from rich.rule import Rule
 from rich.style import Style, StyleType
 from rich.table import (
@@ -2125,7 +2126,7 @@ def _display_matches_gnu_readline(
             if self.formatted_completions:
                 if not hint_printed:
                     sys.stdout.write('\n')
-                sys.stdout.write('\n' + self.formatted_completions + '\n')
+                sys.stdout.write(self.formatted_completions)
 
             # Otherwise use readline's formatter
             else:
@@ -2182,7 +2183,7 @@ def _display_matches_pyreadline(self, matches: list[str]) -> None:  # pragma: no
             if self.formatted_completions:
                 if not hint_printed:
                     sys.stdout.write('\n')
-                sys.stdout.write('\n' + self.formatted_completions + '\n')
+                sys.stdout.write(self.formatted_completions)
 
                 # Redraw the prompt and input lines
                 rl_force_redisplay()
@@ -4121,8 +4122,13 @@ def do_help(self, args: argparse.Namespace) -> None:
             cmds_cats, cmds_doc, cmds_undoc, help_topics = self._build_command_info()
 
             if self.doc_leader:
+                # Indent doc_leader to align with the help tables.
                 self.poutput()
-                self.poutput(self.doc_leader, style=Cmd2Style.HELP_LEADER, soft_wrap=False)
+                self.poutput(
+                    Padding.indent(self.doc_leader, 1),
+                    style=Cmd2Style.HELP_LEADER,
+                    soft_wrap=False,
+                )
             self.poutput()
 
             if not cmds_cats:
@@ -4167,6 +4173,9 @@ def print_topics(self, header: str, cmds: list[str] | None, cmdlen: int, maxcol:
 
         Override of cmd's print_topics() to use Rich.
 
+        The output for both the header and the commands is indented by one space to align
+        with the tables printed by the `help -v` command.
+
         :param header: string to print above commands being printed
         :param cmds: list of topics to print
         :param cmdlen: unused, even by cmd's version
@@ -4177,9 +4186,13 @@ def print_topics(self, header: str, cmds: list[str] | None, cmdlen: int, maxcol:
 
         header_grid = Table.grid()
         header_grid.add_row(header, style=Cmd2Style.HELP_HEADER)
-        header_grid.add_row(Rule(characters=self.ruler))
-        self.poutput(header_grid)
-        self.columnize(cmds, maxcol - 1)
+        header_grid.add_row(Rule(characters=self.ruler, style=Cmd2Style.TABLE_BORDER))
+        self.poutput(Padding.indent(header_grid, 1))
+
+        # Subtract 1 from maxcol to account for indentation.
+        maxcol = min(maxcol, ru.console_width()) - 1
+        columnized_cmds = self.render_columns(cmds, maxcol)
+        self.poutput(Padding.indent(columnized_cmds, 1), soft_wrap=False)
         self.poutput()
 
     def _print_documented_command_topics(self, header: str, cmds: list[str], verbose: bool) -> None:
@@ -4193,15 +4206,17 @@ def _print_documented_command_topics(self, header: str, cmds: list[str], verbose
             self.print_topics(header, cmds, 15, 80)
             return
 
-        category_grid = Table.grid()
-        category_grid.add_row(header, style=Cmd2Style.HELP_HEADER)
-        category_grid.add_row(Rule(characters=self.ruler))
+        # Indent header to align with the help tables.
+        self.poutput(
+            Padding.indent(header, 1),
+            style=Cmd2Style.HELP_HEADER,
+            soft_wrap=False,
+        )
         topics_table = Table(
             Column("Name", no_wrap=True),
             Column("Description", overflow="fold"),
-            box=SIMPLE_HEAD,
-            border_style=Cmd2Style.RULE_LINE,
-            show_edge=False,
+            box=rich.box.HORIZONTALS,
+            border_style=Cmd2Style.TABLE_BORDER,
         )
 
         # Try to get the documentation string for each command
@@ -4240,8 +4255,8 @@ def _print_documented_command_topics(self, header: str, cmds: list[str], verbose
             # Add this command to the table
             topics_table.add_row(command, cmd_desc)
 
-        category_grid.add_row(topics_table)
-        self.poutput(category_grid, "")
+        self.poutput(topics_table)
+        self.poutput()
 
     def render_columns(self, str_list: list[str] | None, display_width: int = 80) -> str:
         """Render a list of single-line strings as a compact set of columns.
@@ -4519,9 +4534,8 @@ def do_set(self, args: argparse.Namespace) -> None:
             Column("Name", no_wrap=True),
             Column("Value", overflow="fold"),
             Column("Description", overflow="fold"),
-            box=SIMPLE_HEAD,
-            border_style=Cmd2Style.RULE_LINE,
-            show_edge=False,
+            box=rich.box.SIMPLE_HEAD,
+            border_style=Cmd2Style.TABLE_BORDER,
         )
 
         # Build the table and populate self.last_result
@@ -4532,9 +4546,7 @@ def do_set(self, args: argparse.Namespace) -> None:
             settable_table.add_row(param, str(settable.get_value()), settable.description)
             self.last_result[param] = settable.get_value()
 
-        self.poutput()
         self.poutput(settable_table)
-        self.poutput()
 
     @classmethod
     def _build_shell_parser(cls) -> Cmd2ArgumentParser:

cmd2/styles.py

@@ -36,6 +36,7 @@ class Cmd2Style(StrEnum):
     HELP_LEADER = "cmd2.help.leader"  # Text right before the help tables are listed
     RULE_LINE = "rule.line"  # Rich style for horizontal rules
     SUCCESS = "cmd2.success"  # Success text (used by psuccess())
+    TABLE_BORDER = "cmd2.table_border"  # Applied to cmd2's table borders
     WARNING = "cmd2.warning"  # Warning text (used by pwarning())
 
 
@@ -47,5 +48,6 @@ class Cmd2Style(StrEnum):
     Cmd2Style.HELP_LEADER: Style(color=Color.CYAN, bold=True),
     Cmd2Style.RULE_LINE: Style(color=Color.BRIGHT_GREEN),
     Cmd2Style.SUCCESS: Style(color=Color.GREEN),
+    Cmd2Style.TABLE_BORDER: Style(color=Color.BRIGHT_GREEN),
     Cmd2Style.WARNING: Style(color=Color.BRIGHT_YELLOW),
 }

tests/test_argparse_completer.py

@@ -720,8 +720,8 @@ def test_completion_items(ac_app) -> None:
     line_found = False
     for line in ac_app.formatted_completions.splitlines():
         # Since the CompletionItems were created from strings, the left-most column is left-aligned.
-        # Therefore choice_1 will begin the line (with 1 space for padding).
-        if line.startswith(' choice_1') and 'A description' in line:
+        # Therefore choice_1 will begin the line (with 2 spaces for padding).
+        if line.startswith('  choice_1') and 'A description' in line:
             line_found = True
             break
 
@@ -743,7 +743,7 @@ def test_completion_items(ac_app) -> None:
     for line in ac_app.formatted_completions.splitlines():
         # Since the CompletionItems were created from numbers, the left-most column is right-aligned.
         # Therefore 1.5 will be right-aligned.
-        if line.startswith("                  1.5") and "One.Five" in line:
+        if line.startswith("                   1.5") and "One.Five" in line:
             line_found = True
             break
 
@@ -908,7 +908,7 @@ def test_completion_items_arg_header(ac_app) -> None:
     begidx = endidx - len(text)
 
     complete_tester(text, line, begidx, endidx, ac_app)
-    assert "DESC_HEADER" in normalize(ac_app.formatted_completions)[0]
+    assert "DESC_HEADER" in normalize(ac_app.formatted_completions)[1]
 
     # Test when metavar is a string
     text = ''
@@ -917,7 +917,7 @@ def test_completion_items_arg_header(ac_app) -> None:
     begidx = endidx - len(text)
 
     complete_tester(text, line, begidx, endidx, ac_app)
-    assert ac_app.STR_METAVAR in normalize(ac_app.formatted_completions)[0]
+    assert ac_app.STR_METAVAR in normalize(ac_app.formatted_completions)[1]
 
     # Test when metavar is a tuple
     text = ''
@@ -927,7 +927,7 @@ def test_completion_items_arg_header(ac_app) -> None:
 
     # We are completing the first argument of this flag. The first element in the tuple should be the column header.
     complete_tester(text, line, begidx, endidx, ac_app)
-    assert ac_app.TUPLE_METAVAR[0].upper() in normalize(ac_app.formatted_completions)[0]
+    assert ac_app.TUPLE_METAVAR[0].upper() in normalize(ac_app.formatted_completions)[1]
 
     text = ''
     line = f'choices --tuple_metavar token_1 {text}'
@@ -936,7 +936,7 @@ def test_completion_items_arg_header(ac_app) -> None:
 
     # We are completing the second argument of this flag. The second element in the tuple should be the column header.
     complete_tester(text, line, begidx, endidx, ac_app)
-    assert ac_app.TUPLE_METAVAR[1].upper() in normalize(ac_app.formatted_completions)[0]
+    assert ac_app.TUPLE_METAVAR[1].upper() in normalize(ac_app.formatted_completions)[1]
 
     text = ''
     line = f'choices --tuple_metavar token_1 token_2 {text}'
@@ -946,7 +946,7 @@ def test_completion_items_arg_header(ac_app) -> None:
     # We are completing the third argument of this flag. It should still be the second tuple element
     # in the column header since the tuple only has two strings in it.
     complete_tester(text, line, begidx, endidx, ac_app)
-    assert ac_app.TUPLE_METAVAR[1].upper() in normalize(ac_app.formatted_completions)[0]
+    assert ac_app.TUPLE_METAVAR[1].upper() in normalize(ac_app.formatted_completions)[1]
 
 
 def test_completion_items_descriptive_headers(ac_app) -> None:
@@ -961,7 +961,7 @@ def test_completion_items_descriptive_headers(ac_app) -> None:
     begidx = endidx - len(text)
 
     complete_tester(text, line, begidx, endidx, ac_app)
-    assert ac_app.CUSTOM_DESC_HEADERS[0] in normalize(ac_app.formatted_completions)[0]
+    assert ac_app.CUSTOM_DESC_HEADERS[0] in normalize(ac_app.formatted_completions)[1]
 
     # This argument did not provide a descriptive header, so it should be DEFAULT_DESCRIPTIVE_HEADERS
     text = ''
@@ -970,7 +970,7 @@ def test_completion_items_descriptive_headers(ac_app) -> None:
     begidx = endidx - len(text)
 
     complete_tester(text, line, begidx, endidx, ac_app)
-    assert DEFAULT_DESCRIPTIVE_HEADERS[0] in normalize(ac_app.formatted_completions)[0]
+    assert DEFAULT_DESCRIPTIVE_HEADERS[0] in normalize(ac_app.formatted_completions)[1]
 
 
 @pytest.mark.parametrize(

tests/test_cmd2.py

@@ -184,15 +184,14 @@ def test_set(base_app) -> None:
     assert out == expected
     assert base_app.last_result is True
 
+    line_found = False
     out, err = run_cmd(base_app, 'set quiet')
-    expected = normalize(
-        """
- Name    Value   Description
-───────────────────────────────────────────────────
- quiet   True    Don't print nonessential feedback
-"""
-    )
-    assert out == expected
+    for line in out:
+        if "quiet" in line and "True" in line and "False" not in line:
+            line_found = True
+            break
+
+    assert line_found
     assert len(base_app.last_result) == 1
     assert base_app.last_result['quiet'] is True