cli: Print pretty tables

Author: defnull

bbblb/cli/__init__.py

@@ -2,10 +2,13 @@
 import functools
 import importlib
 import pkgutil
+import typing
 from bbblb.services import bootstrap
 from bbblb.settings import ConfigError, BBBLBConfig
 import click
 import os
+import tabulate
+import json
 
 
 def async_command():
@@ -49,6 +52,55 @@ def to_info_dict(self):
         return info_dict
 
 
+class Table:
+    formats = ["simple", "plain", "raw", "json"]
+    option = click.option(
+        "--table-format",
+        type=click.Choice(formats),
+        default=formats[0],
+        help="Change the result table format.",
+    )
+
+    def __init__(self):
+        self._rows: list[list[typing.Any]] = []
+        self._headers = {}
+
+    def headers(self, **headers):
+        """Map column names to human readable labels"""
+        self._headers.update(headers)
+
+    def row(self, **values):
+        """Add a row to the table, pamming column names ot values.
+
+        Missing columns are stored as `None`. Previously unknown columns
+        are added to the table.
+        """
+        for key in values:
+            if key not in self._headers:
+                self._headers[key] = key.title()
+                for row in self._rows:
+                    row.append(None)
+        self._rows.append([values.get(column, None) for column in self._headers])
+
+    def print(self, format="simple"):
+        if format == "json":
+            keys = list(self._headers)
+            for row in self._rows:
+                click.echo(json.dumps(dict(zip(keys, row))))
+        elif format == "raw":
+            for row in self._rows:
+                click.echo("\t".join(map(str, row)))
+        else:
+            click.echo(
+                tabulate.tabulate(
+                    self._rows,
+                    list(self._headers.values()),
+                    tablefmt=format,
+                    floatfmt=".2f",
+                )
+            )
+
+
 @click.group(
     name="bbblb",
     context_settings=dict(show_default=True, help_option_names=["--help", "-h"]),

bbblb/cli/server.py

@@ -9,7 +9,7 @@
 from bbblb.services.bbb import BBBHelper
 from bbblb.services.db import DBContext
 
-from . import main, async_command
+from . import Table, main, async_command
 
 
 @main.group()
@@ -177,26 +177,39 @@ async def _end_meeting(obj: ServiceRegistry, meeting: model.Meeting):
 
 
 @server.command()
+@Table.option
 @async_command()
-async def list(obj: ServiceRegistry):
+async def list(obj: ServiceRegistry, table_format: str):
     """List all servers with their secrets."""
     db = await obj.use(DBContext)
 
+    tbl = Table()
     async with db.session() as session:
         stmt = model.Server.select().order_by(model.Server.domain)
         for server in (await session.execute(stmt)).scalars():
-            out = f"{server.domain} {server.secret}"
-            click.echo(out)
+            tbl.row(server=server.domain, secret=server.secret)
+    tbl.print(format=table_format)
 
 
 @server.command()
+@Table.option
 @async_command()
-async def stats(obj: ServiceRegistry):
+async def stats(obj: ServiceRegistry, table_format):
     """Show server statistics (state, health, load)."""
     db = await obj.use(DBContext)
 
+    tbl = Table()
     async with db.session() as session:
         stmt = model.Server.select().order_by(model.Server.domain)
         for server in (await session.execute(stmt)).scalars():
-            out = f"{server.domain} enabled={server.enabled} health={server.health.name.lower()} load={server.load:.1f}"
-            click.echo(out)
+            tbl.row(
+                server=server.domain,
+                enabled=server.enabled,
+                state=server.health.name.lower(),
+                meetings=server.stats.get("meetings", 0),
+                users=server.stats.get("users", 0),
+                voice=server.stats.get("voice", 0),
+                video=server.stats.get("video", 0),
+                load=server.load,
+            )
+    tbl.print(format=table_format)

bbblb/cli/tenant.py

@@ -7,7 +7,7 @@
 
 from bbblb.settings import BBBLBConfig
 
-from . import main, async_command
+from . import Table, main, async_command
 
 
 @main.group()
@@ -101,12 +101,19 @@ async def disable(obj: ServiceRegistry, name: str, nuke: bool):
 
 
 @tenant.command("list")
+@Table.option
 @async_command()
-async def list_(obj: ServiceRegistry):
+async def list_(obj: ServiceRegistry, table_format: str):
     """List all tenants with their realms and secrets."""
     db = await obj.use(DBContext)
+    tbl = Table()
     async with db.session() as session:
         tenants = (await session.execute(model.Tenant.select())).scalars()
         for tenant in tenants:
-            out = f"{tenant.name} {tenant.realm} {tenant.secret}"
-            click.echo(out)
+            tbl.row(
+                tenant=tenant.name,
+                realm=tenant.realm,
+                enabled=tenant.enabled,
+                secret=tenant.secret,
+            )
+    tbl.print(format=table_format)

docs/_click.rst

@@ -383,13 +383,31 @@ server list
 
 List all servers with their secrets.
 
+.. table:: Options
+  :width: 100%
+
+  ======================================  ==================================================
+  Option                                  Help                                              
+  ======================================  ==================================================
+  --table-format [simple|plain|raw|json]  Change the result table format.  [default: simple]
+  ======================================  ==================================================
+
 server stats
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ``Usage: bbblb server stats [OPTIONS]``
 
 Show server statistics (state, health, load).
 
+.. table:: Options
+  :width: 100%
+
+  ======================================  ==================================================
+  Option                                  Help                                              
+  ======================================  ==================================================
+  --table-format [simple|plain|raw|json]  Change the result table format.  [default: simple]
+  ======================================  ==================================================
+
 state
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -529,3 +547,12 @@ tenant list
 
 List all tenants with their realms and secrets.
 
+.. table:: Options
+  :width: 100%
+
+  ======================================  ==================================================
+  Option                                  Help                                              
+  ======================================  ==================================================
+  --table-format [simple|plain|raw|json]  Change the result table format.  [default: simple]
+  ======================================  ==================================================
+

pyproject.toml

@@ -22,6 +22,7 @@ dependencies = [
     "pyjwt>=2.10.1",
     "sqlalchemy>=2.0.44",
     "starlette>=0.48.0",
+    "tabulate>=0.9.0",
 ]
 
 [project.optional-dependencies]