Introduces table output

Author: mvaltas

.devcli/example.py

@@ -38,6 +38,12 @@ def text():
     cmd.info("This is a cmd.info(msg)")
     cmd.warn("This is a cmd.warn(msg)")
     cmd.error("This is a cmd.error(msg)")
+    # Simple table
+    table = [
+        ["This is", "a simple table"],
+        ["With one value", "and another"],
+    ]
+    cmd.table(table)
 
 
 @cli.command()

devcli/framework/__init__.py

@@ -1,5 +1,18 @@
 from .base import new, stop, logger
 
-from .console import echo, info, warn, error, json
+from .console import echo, info, warn, error, json, table
 
-__all__ = ["new", "echo", "json", "warn", "error", "echo", "info", "stop", "logger"]
+__all__ = [
+    # from console
+    "echo",
+    "json",
+    "warn",
+    "error",
+    "echo",
+    "info",
+    "table",
+    # from base
+    "new",
+    "stop",
+    "logger",
+]

devcli/framework/console.py

@@ -1,3 +1,7 @@
+from typing import List
+
+from rich.table import Table
+from rich.box import SQUARE
 from rich import print
 from rich import json as rjson
 
@@ -37,3 +41,39 @@ def info(msg: str):
     Prints a message in cyan
     """
     print(f"[cyan]{msg}[/cyan]")
+
+
+def table(table: List[List[str]] = [[]], as_grid: bool = False):
+    """
+    Prints a simple table, for complex tables use rich.Table directly.
+
+    First element will be used as column and the the rest as rows.
+    For example:
+        [
+            ["Col  A", "Col  B"],
+            ["Row 1A", "Row 1B"],
+            ["Row 2A", "Row 2B"]
+        ]
+    """
+    rich_table = None
+    table_copy = table.copy()  # avoid altering param
+
+    # do nothing with an empty table
+    if len(table_copy) == 0:
+        return
+    elif as_grid:
+        rich_table = Table(show_lines=True, show_header=False, box=SQUARE)
+    else:
+        rich_table = Table(show_lines=True, box=SQUARE)
+
+    if not as_grid:
+        # use the cols given, also remove it
+        cols = table_copy.pop(0)
+        for c in cols:
+            rich_table.add_column(c)
+
+    # only rows should be remaining
+    for r in table_copy:
+        rich_table.add_row(*r)
+
+    echo(rich_table)

tests/test_console.py

@@ -37,3 +37,23 @@ def test_warn(mock_print):
 def test_error(mock_print):
     console.error(MESSAGE)
     assert_print(mock_print, color="red")
+
+
+def test_simple_grid(mock_print):
+    grid = [["Row A", "Row B"]]
+    console.table(grid)
+
+    argument = mock_print.call_args.args[0]
+    full_name = ".".join([argument.__module__, argument.__class__.__name__])
+
+    assert full_name == "rich.table.Table"
+
+
+def test_simple_table(mock_print):
+    grid = [["Col A", "Col B"], ["Row A", "Row B"]]
+    console.table(grid)
+
+    argument = mock_print.call_args.args[0]
+    full_name = ".".join([argument.__module__, argument.__class__.__name__])
+
+    assert full_name == "rich.table.Table"

tests/test_example.py

@@ -31,6 +31,11 @@ def test_hello_text_example():
         "This is a cmd.info(msg)\n"
         "This is a cmd.warn(msg)\n"
         "This is a cmd.error(msg)\n"
+        "┌────────────────┬────────────────┐\n"
+        "│ This is        │ a simple table │\n"
+        "├────────────────┼────────────────┤\n"
+        "│ With one value │ and another    │\n"
+        "└────────────────┴────────────────┘\n"
     )
     assert result.output in expected_output