Merge pull request #1646 from allmightyspiff/richTables

Rich tables

Author: allmightyspiff

.github/workflows/tests.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6,3.7,3.8,3.9]
+        python-version: [3.7,3.8,3.9,'3.10']
 
     steps:
     - uses: actions/checkout@v2

SoftLayer/CLI/call_api.py

@@ -172,7 +172,7 @@ def cli(env, service, method, parameters, _id, _filters, mask, limit, offset, or
     }
 
     if output_python:
-        env.out(_build_python_example(args, kwargs))
+        env.python_output(_build_python_example(args, kwargs))
     else:
         result = env.client.call(*args, **kwargs)
         env.fout(formatting.iter_to_table(result))

SoftLayer/CLI/core.py

@@ -13,6 +13,7 @@
 
 import click
 import requests
+from rich.markup import escape
 
 import SoftLayer
 from SoftLayer.CLI.command import CommandLoader
@@ -143,9 +144,9 @@ def output_diagnostics(env, result, verbose=0, **kwargs):
         diagnostic_table = formatting.Table(['name', 'value'])
         diagnostic_table.add_row(['execution_time', '%fs' % (time.time() - START_TIME)])
 
-        api_call_value = []
+        api_call_value = formatting.Table(['API Calls'], title=None, align="left")
         for call in env.client.transport.get_last_calls():
-            api_call_value.append("%s::%s (%fs)" % (call.service, call.method, call.end_time - call.start_time))
+            api_call_value.add_row(["%s::%s (%fs)" % (call.service, call.method, call.end_time - call.start_time)])
 
         diagnostic_table.add_row(['api_calls', api_call_value])
         diagnostic_table.add_row(['version', consts.USER_AGENT])
@@ -156,13 +157,13 @@ def output_diagnostics(env, result, verbose=0, **kwargs):
 
     if verbose > 1:
         for call in env.client.transport.get_last_calls():
-            call_table = formatting.Table(['', '{}::{}'.format(call.service, call.method)])
+            call_table = formatting.Table(['', '{}::{}'.format(call.service, call.method)], align="left")
             nice_mask = ''
             if call.mask is not None:
                 nice_mask = call.mask
-
             call_table.add_row(['id', call.identifier])
-            call_table.add_row(['mask', nice_mask])
+            #  Need to escape this so Rich doesn't think the mask is a tag and hide it.
+            call_table.add_row(['mask', escape(nice_mask)])
             call_table.add_row(['filter', call.filter])
             call_table.add_row(['limit', call.limit])
             call_table.add_row(['offset', call.offset])

SoftLayer/CLI/dns/zone_import.py

@@ -5,6 +5,7 @@
 import click
 
 import SoftLayer
+from SoftLayer.CLI.command import SLCommand as SLCommand
 from SoftLayer.CLI import environment
 from SoftLayer.CLI import exceptions
 from SoftLayer.CLI import helpers
@@ -17,9 +18,8 @@
 RECORD_FMT = "type={type}, record={record}, data={data}, ttl={ttl}"
 
 
-@click.command(cls=SoftLayer.CLI.command.SLCommand, )
-@click.argument('zonefile',
-                type=click.Path(exists=True, readable=True, resolve_path=True))
+@click.command(cls=SLCommand)
+@click.argument('zonefile', type=click.Path(exists=True, readable=True, resolve_path=True))
 @click.option('--dry-run', is_flag=True, help="Don't actually create records")
 @environment.pass_env
 def cli(env, zonefile, dry_run):
@@ -31,12 +31,12 @@ def cli(env, zonefile, dry_run):
 
     zone, records, bad_lines = parse_zone_details(zone_contents)
 
-    env.out("Parsed: zone=%s" % zone)
+    click.secho("Parsed: zone=%s" % zone)
     for record in records:
-        env.out("Parsed: %s" % RECORD_FMT.format(**record))
+        click.secho("Parsed: %s" % RECORD_FMT.format(**record), fg="green")
 
     for line in bad_lines:
-        env.out("Unparsed: %s" % line)
+        click.secho("Unparsed: %s" % line, fg="yellow")
 
     if dry_run:
         return
@@ -47,25 +47,19 @@ def cli(env, zonefile, dry_run):
                                      name='zone')
     except exceptions.CLIAbort:
         zone_id = manager.create_zone(zone)['id']
-        env.out(click.style("Created: %s" % zone, fg='green'))
+        click.secho(click.style("Created: %s" % zone, fg='green'))
 
     # Attempt to create each record
     for record in records:
         try:
-            manager.create_record(zone_id,
-                                  record['record'],
-                                  record['type'],
-                                  record['data'],
-                                  record['ttl'])
-
-            env.out(click.style("Created: %s" % RECORD_FMT.format(**record),
-                                fg='green'))
+            manager.create_record(zone_id, record['record'], record['type'], record['data'], record['ttl'])
+
+            click.secho(click.style("Created: %s" % RECORD_FMT.format(**record), fg='green'))
         except SoftLayer.SoftLayerAPIError as ex:
-            env.out(click.style("Failed: %s" % RECORD_FMT.format(**record),
-                                fg='red'))
-            env.out(click.style(str(ex), fg='red'))
+            click.secho(click.style("Failed: %s" % RECORD_FMT.format(**record), fg='red'))
+            click.secho(click.style(str(ex), fg='red'))
 
-    env.out(click.style("Finished", fg='green'))
+    click.secho(click.style("Finished", fg='green'))
 
 
 def parse_zone_details(zone_contents):
@@ -75,7 +69,10 @@ def parse_zone_details(zone_contents):
     zone_lines = [line.strip() for line in zone_contents.split('\n')]
 
     zone_search = re.search(r'^\$ORIGIN (?P<zone>.*)\.', zone_lines[0])
-    zone = zone_search.group('zone')
+    if zone_search:
+        zone = zone_search.group('zone')
+    else:
+        raise exceptions.ArgumentError("Invalid Zone File")
 
     for line in zone_lines[1:]:
         record_search = re.search(RECORD_REGEX, line)

SoftLayer/CLI/environment.py

@@ -6,9 +6,12 @@
     :license: MIT, see LICENSE for more details.
 """
 import importlib
+from json.decoder import JSONDecodeError
 
 import click
 import pkg_resources
+from rich.console import Console
+from rich.syntax import Syntax
 
 import SoftLayer
 from SoftLayer.CLI import formatting
@@ -32,19 +35,38 @@ def __init__(self):
         self.vars = {}
 
         self.client = None
+        self.console = Console()
+        self.err_console = Console(stderr=True)
         self.format = 'table'
         self.skip_confirmations = False
         self.config_file = None
 
         self._modules_loaded = False
 
-    def out(self, output, newline=True):
+    def out(self, output):
         """Outputs a string to the console (stdout)."""
-        click.echo(output, nl=newline)
+        if self.format == 'json':
+            try:
+                self.console.print_json(output)
+            # Tried to print not-json, so just print it out normally...
+            except JSONDecodeError:
+                click.echo(output)
+        elif self.format == 'jsonraw':
+            #  Using Rich here is problematic because in the unit tests it thinks the terminal is 80 characters wide
+            #  and only prints out that many characters.
+            click.echo(output)
+        else:
+            # If we want to print a list of tables, Rich doens't handle that well.
+            if isinstance(output, list):
+                for line in output:
+                    self.console.print(line, overflow='ignore')
+            else:
+                self.console.print(output,  overflow='ignore')
 
     def err(self, output, newline=True):
         """Outputs an error string to the console (stderr)."""
-        click.echo(output, nl=newline, err=True)
+
+        self.err_console.print(output, new_line_start=newline)
 
     def fmt(self, output, fmt=None):
         """Format output based on current the environment format."""
@@ -56,14 +78,18 @@ def format_output_is_json(self):
         """Return True if format output is json or jsonraw"""
         return 'json' in self.format
 
-    def fout(self, output, newline=True):
+    def fout(self, output):
         """Format the input and output to the console (stdout)."""
         if output is not None:
             try:
-                self.out(self.fmt(output), newline=newline)
+                self.out(self.fmt(output))
             except UnicodeEncodeError:
                 # If we hit an undecodeable entry, just try outputting as json.
-                self.out(self.fmt(output, 'json'), newline=newline)
+                self.out(self.fmt(output, 'json'))
+
+    def python_output(self, output):
+        """Prints out python code"""
+        self.console.print(Syntax(output, "python"))
 
     def input(self, prompt, default=None, show_default=True):
         """Provide a command prompt."""

SoftLayer/CLI/firewall/add.py

@@ -1,4 +1,4 @@
-"""Create new firewall."""
+"""Add a server to the firewall"""
 # :license: MIT, see LICENSE for more details.
 
 import click
@@ -36,16 +36,14 @@ def cli(env, target, firewall_type, high_availability):
             pkg = mgr.get_standard_package(target, is_virt=False)
 
         if not pkg:
-            exceptions.CLIAbort(
-                "Unable to add firewall - Is network public enabled?")
+            exceptions.CLIAbort("Unable to add firewall - Is network public enabled?")
 
-        env.out("******************")
-        env.out("Product: %s" % pkg[0]['description'])
-        env.out("Price: $%s monthly" % pkg[0]['prices'][0]['recurringFee'])
-        env.out("******************")
+        click.echo("******************")
+        click.echo("Product: %s" % pkg[0]['description'])
+        click.echo("Price: $%s monthly" % pkg[0]['prices'][0]['recurringFee'])
+        click.echo("******************")
 
-        if not formatting.confirm("This action will incur charges on your "
-                                  "account. Continue?"):
+        if not formatting.confirm("This action will incur charges on your account. Continue?"):
             raise exceptions.CLIAbort('Aborted.')
 
     if firewall_type == 'vlan':
@@ -55,4 +53,4 @@ def cli(env, target, firewall_type, high_availability):
     elif firewall_type == 'server':
         mgr.add_standard_firewall(target, is_virt=False)
 
-    env.fout("Firewall is being created!")
+    click.echo("Firewall is being created!")