No longer indenting help headers and topic lists.

Author: kmvanbrunt

cmd2/argparse_completer.py

@@ -578,6 +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.TABLE_BORDER,
             )
             for item in completion_items:

cmd2/cmd2.py

@@ -2076,7 +2076,7 @@ def _display_matches_gnu_readline(
             if self.formatted_completions:
                 if not hint_printed:
                     sys.stdout.write('\n')
-                sys.stdout.write(self.formatted_completions)
+                sys.stdout.write('\n' + self.formatted_completions + '\n')
 
             # Otherwise use readline's formatter
             else:
@@ -2133,7 +2133,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(self.formatted_completions)
+                sys.stdout.write('\n' + self.formatted_completions + '\n')
 
                 # Redraw the prompt and input lines
                 rl_force_redisplay()
@@ -4072,12 +4072,8 @@ 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(
-                    ru.indent(self.doc_leader, 1),
-                    style=Cmd2Style.HELP_LEADER,
-                )
+                self.poutput(self.doc_leader, style=Cmd2Style.HELP_LEADER)
             self.poutput()
 
             if not cmds_cats:
@@ -4122,9 +4118,6 @@ 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
@@ -4137,16 +4130,11 @@ def print_topics(self, header: str, cmds: list[str] | None, cmdlen: int, maxcol:
         if header:
             header_grid = Table.grid()
             header_grid.add_row(header, style=Cmd2Style.HELP_HEADER)
-            header_grid.add_row(Rule(characters=self.ruler, style=Cmd2Style.TABLE_BORDER))
-            self.poutput(ru.indent(header_grid, 1))
-
-        # Subtract 2 from the max column width to account for the
-        # one-space indentation and a one-space right margin.
-        maxcol = min(maxcol, ru.console_width()) - 2
+            header_grid.add_row(Rule(characters=self.ruler))
+            self.poutput(header_grid)
 
-        # Print the topics in columns.
-        columnized_cmds = self.render_columns(cmds, maxcol)
-        self.poutput(ru.indent(columnized_cmds, 1))
+        # Subtract 1 from maxcol to account for a one-space right margin.
+        self.columnize(cmds, maxcol - 1)
         self.poutput()
 
     def _print_documented_command_topics(self, header: str, cmds: list[str], verbose: bool) -> None:
@@ -4160,13 +4148,17 @@ def _print_documented_command_topics(self, header: str, cmds: list[str], verbose
             self.print_topics(header, cmds, 15, 80)
             return
 
-        # Indent header to align with the help tables.
-        self.poutput(ru.indent(header, 1), style=Cmd2Style.HELP_HEADER)
+        # Create a grid to hold the header and the topics table
+        category_grid = Table.grid()
+        category_grid.add_row(header, style=Cmd2Style.HELP_HEADER)
+        category_grid.add_row(Rule(characters=self.ruler))
+
         topics_table = Table(
             Column("Name", no_wrap=True),
             Column("Description", overflow="fold"),
-            box=ru.TOP_AND_HEAD,
+            box=rich.box.SIMPLE_HEAD,
             border_style=Cmd2Style.TABLE_BORDER,
+            show_edge=False,
         )
 
         # Try to get the documentation string for each command
@@ -4205,7 +4197,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)
 
-        self.poutput(topics_table)
+        category_grid.add_row(topics_table)
+        self.poutput(category_grid)
         self.poutput()
 
     def render_columns(self, str_list: list[str] | None, display_width: int = 80) -> str:
@@ -4486,6 +4479,7 @@ def do_set(self, args: argparse.Namespace) -> None:
             Column("Description", overflow="fold"),
             box=rich.box.SIMPLE_HEAD,
             border_style=Cmd2Style.TABLE_BORDER,
+            show_edge=False,
         )
 
         # Build the table and populate self.last_result
@@ -4496,7 +4490,9 @@ 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/rich_utils.py

@@ -8,7 +8,6 @@
     TypedDict,
 )
 
-from rich.box import Box
 from rich.console import (
     Console,
     ConsoleRenderable,
@@ -111,19 +110,6 @@ class RichPrintKwargs(TypedDict, total=False):
     new_line_start: bool
 
 
-# Custom Rich Box for tables which has a top border and a head row separator.
-TOP_AND_HEAD: Box = Box(
-    " ── \n"  # top
-    "    \n"
-    " ── \n"  # head_row
-    "    \n"
-    "    \n"
-    "    \n"
-    "    \n"
-    "    \n"
-)
-
-
 class Cmd2BaseConsole(Console):
     """Base class for all cmd2 Rich consoles.
 

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 2 spaces for padding).
-        if line.startswith('  choice_1') and 'A description' in line:
+        # Therefore choice_1 will begin the line (with 1 space 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)[1]
+    assert "DESC_HEADER" in normalize(ac_app.formatted_completions)[0]
 
     # 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)[1]
+    assert ac_app.STR_METAVAR in normalize(ac_app.formatted_completions)[0]
 
     # 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)[1]
+    assert ac_app.TUPLE_METAVAR[0].upper() in normalize(ac_app.formatted_completions)[0]
 
     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)[1]
+    assert ac_app.TUPLE_METAVAR[1].upper() in normalize(ac_app.formatted_completions)[0]
 
     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)[1]
+    assert ac_app.TUPLE_METAVAR[1].upper() in normalize(ac_app.formatted_completions)[0]
 
 
 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)[1]
+    assert ac_app.CUSTOM_DESC_HEADERS[0] in normalize(ac_app.formatted_completions)[0]
 
     # 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)[1]
+    assert DEFAULT_DESCRIPTIVE_HEADERS[0] in normalize(ac_app.formatted_completions)[0]
 
 
 @pytest.mark.parametrize(