Added posibility to change theme in slcli like dark, light o maintain in default

Author: edsonarios

SoftLayer/CLI/command.py

@@ -11,13 +11,12 @@
 import click
 
 from rich import box
-from rich.console import Console
 from rich.highlighter import RegexHighlighter
 from rich.table import Table
 from rich.text import Text
-from rich.theme import Theme
 
 from SoftLayer.CLI import environment
+from SoftLayer import utils
 
 
 class OptionHighlighter(RegexHighlighter):
@@ -30,29 +29,19 @@ class OptionHighlighter(RegexHighlighter):
     ]
 
 
-#  Colors defined in https://rich.readthedocs.io/en/latest/_modules/rich/color.html#ColorType
-SLCLI_THEME = Theme(
-    {
-        "option": "bold cyan",
-        "switch": "bold green",
-        "default_option": "light_pink1",
-        "option_keyword": "bold cyan",
-        "args_keyword": "bold green"
-    }
-)
-
-
 class CommandLoader(click.MultiCommand):
     """Loads module for click."""
 
     def __init__(self, *path, **attrs):
         click.MultiCommand.__init__(self, **attrs)
         self.path = path
-
         self.highlighter = OptionHighlighter()
-        self.console = Console(
-            theme=SLCLI_THEME
-        )
+        self.console = utils.console_color_themes(theme=None)
+
+    def updated_console_whit_theme(self, theme):
+        """Update the console depending on the theme"""
+        # print(theme)
+        self.console = utils.console_color_themes(theme)
 
     def list_commands(self, ctx):
         """List all sub-commands."""
@@ -65,7 +54,7 @@ def get_command(self, ctx, cmd_name):
         """Get command for click."""
         env = ctx.ensure_object(environment.Environment)
         env.load()
-
+        self.updated_console_whit_theme(env.theme)
         # Do alias lookup (only available for root commands)
         if len(self.path) == 0:
             cmd_name = env.resolve_alias(cmd_name)
@@ -80,14 +69,17 @@ def get_command(self, ctx, cmd_name):
 
     def format_usage(self, ctx: click.Context, formatter: click.formatting.HelpFormatter) -> None:
         """Formats and colorizes the usage information."""
+        env = ctx.ensure_object(environment.Environment)
+        env.load()
+        self.updated_console_whit_theme(env.theme)
         pieces = self.collect_usage_pieces(ctx)
         for index, piece in enumerate(pieces):
             if piece == "[OPTIONS]":
-                pieces[index] = "[bold cyan][OPTIONS][/bold cyan]"
+                pieces[index] = "[options][OPTIONS][/]"
             elif piece == "COMMAND [ARGS]...":
-                pieces[index] = "[orange1]COMMAND[/orange1] [bold cyan][ARGS][/bold cyan] ..."
+                pieces[index] = "[command]COMMAND[/] [args][ARGS][/] ..."
 
-        self.console.print(f"Usage: [bold red]{ctx.command_path}[/bold red] {' '.join(pieces)}")
+        self.console.print(f"Usage: [path]{ctx.command_path}[/] {' '.join(pieces)}")
 
     def format_help_text(self, ctx: click.Context, formatter: click.formatting.HelpFormatter) -> None:
         """Writes the help text"""
@@ -153,9 +145,9 @@ def format_commands(self, ctx, formatter):
         if len(commands):
             for subcommand, cmd in commands:
                 help_text = cmd.get_short_help_str(120)
-                command_style = Text(f" {subcommand}", style="orange1")
+                command_style = Text(f" {subcommand}", style="sub_command")
                 command_table.add_row(command_style, help_text)
-        self.console.print("\n[bold orange1]Commands:[/]")
+        self.console.print("\n[name_sub_command]Commands:[/]")
         self.console.print(command_table)
 
 
@@ -165,20 +157,25 @@ class SLCommand(click.Command):
     def __init__(self, **attrs):
         click.Command.__init__(self, **attrs)
         self.highlighter = OptionHighlighter()
-        self.console = Console(
-            theme=SLCLI_THEME
-        )
+        self.console = utils.console_color_themes(theme=None)
+
+    def updated_console_whit_theme(self, theme):
+        """Update the console depending on the theme"""
+        self.console = utils.console_color_themes(theme)
 
     def format_usage(self, ctx: click.Context, formatter: click.formatting.HelpFormatter) -> None:
         """Formats and colorizes the usage information."""
+        env = ctx.ensure_object(environment.Environment)
+        env.load()
+        self.updated_console_whit_theme(env.theme)
         pieces = self.collect_usage_pieces(ctx)
         for index, piece in enumerate(pieces):
             if piece == "[OPTIONS]":
-                pieces[index] = "[bold cyan][OPTIONS][/bold cyan]"
+                pieces[index] = "[options][OPTIONS][/]"
             elif piece == "COMMAND [ARGS]...":
-                pieces[index] = "[orange1]COMMAND[/orange1] [bold cyan][ARGS][/bold cyan] ..."
+                pieces[index] = "[command]COMMAND[/] [args][ARGS][/] ..."
 
-        self.console.print(f"Usage: [bold red]{ctx.command_path}[/bold red] {' '.join(pieces)}")
+        self.console.print(f"Usage: [path]{ctx.command_path}[/] {' '.join(pieces)}")
 
     def format_help_text(self, ctx: click.Context, formatter: click.formatting.HelpFormatter) -> None:
         """Writes the help text"""

SoftLayer/CLI/config/__init__.py

@@ -13,7 +13,7 @@ def _resolve_transport(transport):
     return _resolve_transport(nested_transport)
 
 
-def get_settings_from_client(client):
+def get_settings_from_client(client, theme):
     """Pull out settings from a SoftLayer.BaseClient instance.
 
     :param client: SoftLayer.BaseClient instance
@@ -23,6 +23,7 @@ def get_settings_from_client(client):
         'api_key': '',
         'timeout': '',
         'endpoint_url': '',
+        'theme': theme
     }
     try:
         settings['username'] = client.auth.username
@@ -49,4 +50,5 @@ def config_table(settings):
     table.add_row(['API Key', settings['api_key'] or 'not set'])
     table.add_row(['Endpoint URL', settings['endpoint_url'] or 'not set'])
     table.add_row(['Timeout', settings['timeout'] or 'not set'])
+    table.add_row(['Theme', settings['theme'] or 'not set'])
     return table

SoftLayer/CLI/config/setup.py

@@ -68,7 +68,7 @@ def cli(env, auth):
     api_key = None
 
     timeout = 0
-    defaults = config.get_settings_from_client(env.client)
+    defaults = config.get_settings_from_client(env.client, env.theme)
     endpoint_url = get_endpoint_url(env, defaults.get('endpoint_url', 'public'))
     # Get ths username and API key
     if auth == 'ibmid':
@@ -92,6 +92,9 @@ def cli(env, auth):
     # Ask for timeout, convert to float, then to int
     timeout = int(float(env.input('Timeout', default=defaults['timeout'] or 0)))
 
+    # Ask theme for console
+    theme = env.input('Theme [dark/light]', default=defaults['theme'])
+
     path = '~/.softlayer'
     if env.config_file:
         path = env.config_file
@@ -100,7 +103,8 @@ def cli(env, auth):
     env.out(env.fmt(config.config_table({'username': username,
                                          'api_key': api_key,
                                          'endpoint_url': endpoint_url,
-                                         'timeout': timeout})))
+                                         'timeout': timeout,
+                                         'theme': theme})))
 
     if not formatting.confirm('Are you sure you want to write settings to "%s"?' % config_path, default=True):
         raise exceptions.CLIAbort('Aborted.')
@@ -118,6 +122,7 @@ def cli(env, auth):
     parsed_config.set('softlayer', 'api_key', api_key)
     parsed_config.set('softlayer', 'endpoint_url', endpoint_url)
     parsed_config.set('softlayer', 'timeout', timeout)
+    parsed_config.set('softlayer', 'theme', theme)
 
     config_fd = os.fdopen(os.open(config_path, (os.O_WRONLY | os.O_CREAT | os.O_TRUNC), 0o600), 'w')
     try:

SoftLayer/CLI/config/show.py

@@ -13,5 +13,5 @@
 def cli(env):
     """Show current configuration."""
 
-    settings = config.get_settings_from_client(env.client)
+    settings = config.get_settings_from_client(client=env.client, theme=env.theme)
     env.fout(config.config_table(settings))

SoftLayer/CLI/core.py

@@ -118,6 +118,7 @@ def cli(env,
     env.skip_confirmations = really
     env.config_file = config
     env.format = format
+    env.set_env_theme(config_file=config)
     env.ensure_client(config_file=config, is_demo=demo, proxy=proxy)
     env.vars['_start'] = time.time()
     logger = logging.getLogger()

SoftLayer/CLI/environment.py

@@ -5,6 +5,9 @@
 
     :license: MIT, see LICENSE for more details.
 """
+import configparser
+import os
+
 import importlib
 from json.decoder import JSONDecodeError
 
@@ -40,6 +43,7 @@ def __init__(self):
         self.format = 'table'
         self.skip_confirmations = False
         self.config_file = None
+        self.theme = None
 
         self._modules_loaded = False
 
@@ -76,7 +80,7 @@ def fmt(self, output, fmt=None):
         """Format output based on current the environment format."""
         if fmt is None:
             fmt = self.format
-        return formatting.format_output(output, fmt)
+        return formatting.format_output(output, fmt, self.theme)
 
     def format_output_is_json(self):
         """Return True if format output is json or jsonraw"""
@@ -208,6 +212,19 @@ def ensure_client(self, config_file=None, is_demo=False, proxy=None):
             )
         self.client = client
 
+    def set_env_theme(self, config_file=None):
+        """Get theme to color console and set in env"""
+        theme = os.environ.get('SL_THEME')
+        if theme:
+            self.theme = theme
+        else:
+            config = configparser.RawConfigParser({
+                'theme': '',
+            })
+            config.read(config_file)
+            if config.has_section('softlayer'):
+                self.theme = config.get('softlayer', 'theme')
+
 
 class ModuleLoader(object):
     """Module loader that acts a little like an EntryPoint object."""

SoftLayer/CLI/formatting.py

@@ -22,7 +22,7 @@
 FALSE_VALUES = ['0', 'false', 'FALSE', 'no', 'False']
 
 
-def format_output(data, fmt='table'):  # pylint: disable=R0911,R0912
+def format_output(data, fmt='table', theme=None):  # pylint: disable=R0911,R0912
     """Given some data, will format it for console output.
 
     :param data: One of: String, Table, FormattedItem, List, Tuple, SequentialOutput
@@ -40,7 +40,7 @@ def format_output(data, fmt='table'):  # pylint: disable=R0911,R0912
 
     # responds to .prettytable()
     if hasattr(data, 'prettytable') and fmt in ('table', 'raw'):
-        return format_prettytable(data, fmt)
+        return format_prettytable(data, fmt, theme)
 
     # responds to .to_python()
     if hasattr(data, 'to_python'):
@@ -73,7 +73,7 @@ def format_output(data, fmt='table'):  # pylint: disable=R0911,R0912
     return str(data)
 
 
-def format_prettytable(table, fmt='table'):
+def format_prettytable(table, fmt='table', theme=None):
     """Converts SoftLayer.CLI.formatting.Table instance to a prettytable."""
     for i, row in enumerate(table.rows):
         for j, item in enumerate(row):
@@ -83,7 +83,7 @@ def format_prettytable(table, fmt='table'):
                 table.rows[i][j] = format_output(item)
             else:
                 table.rows[i][j] = str(item)
-    ptable = table.prettytable(fmt)
+    ptable = table.prettytable(fmt, theme)
     return ptable
 
 
@@ -267,12 +267,13 @@ def to_python(self):
             items.append(dict(zip(self.columns, formatted_row)))
         return items
 
-    def prettytable(self, fmt='table'):
+    def prettytable(self, fmt='table', theme=None):
         """Returns a RICH table instance."""
         box_style = box.SQUARE
         if fmt == 'raw':
             box_style = None
-        table = rTable(title=self.title, box=box_style, header_style="bright_cyan")
+        color_table = utils.table_color_theme(theme)
+        table = rTable(title=self.title, box=box_style, header_style=color_table['header'])
         if self.sortby:
             try:
                 # https://docs.python.org/3/howto/sorting.html#key-functions
@@ -300,7 +301,7 @@ def prettytable(self, fmt='table'):
                 justify = 'left'
             # Special coloring for some columns
             if col in ('id', 'Id', 'ID'):
-                style = "pale_violet_red1"
+                style = color_table['id_columns']
             table.add_column(col, justify=justify, style=style)
 
         for row in self.rows:

SoftLayer/utils.py

@@ -11,6 +11,8 @@
 import re
 import time
 
+from rich.console import Console
+from rich.theme import Theme
 
 # pylint: disable=no-member, invalid-name
 
@@ -459,3 +461,74 @@ def decode_stacked(document, pos=0, decoder=JSONDecoder()):
         obj, pos = decoder.raw_decode(document, pos)
 
         yield obj
+
+
+def console_color_themes(theme):
+    """Colors in https://rich.readthedocs.io/en/stable/appendix/colors.html?highlight=light_pink1#standard-colors"""
+    # Default theme
+    if not theme:
+        return Console(theme=Theme(
+            {
+                "options": "bold cyan",  # OPTIONS
+                "command": "orange3",  # COMMAND
+                "args": "bold cyan",  # ARGS
+                "path": "bold red",  # command path
+                "name_sub_command": "orange3",  # sub command name
+                "sub_command": "orange3",  # sub command list
+                # Help table colors options
+                "option": "bold cyan",
+                "switch": "bold green",
+                "default_option": "light_coral",
+                "option_keyword": "bold cyan",
+                "args_keyword": "bold green",
+            })
+        )
+    if theme == 'dark':
+        return Console(theme=Theme(
+            {
+                "options": "bold cyan",  # OPTIONS
+                "command": "orange3",  # COMMAND
+                "args": "bold cyan",  # ARGS
+                "path": "bold red",  # command path
+                "name_sub_command": "orange3",  # sub command name
+                "sub_command": "orange3",  # sub command list
+                # Help table colors options
+                "option": "bold cyan",
+                "switch": "bold green",
+                "default_option": "light_pink1",
+                "option_keyword": "bold cyan",
+                "args_keyword": "bold green",
+            })
+        )
+    if theme == 'light':
+        return Console(theme=Theme(
+            {
+                "options": "bold dark_cyan",  # OPTIONS
+                "command": "orange3",  # COMMAND
+                "args": "bold dark_cyan",  # ARGS
+                "path": "bold red",  # command path
+                "name_sub_command": "orange3",  # sub command name
+                "sub_command": "orange3",  # sub command list
+                # Help table colors options
+                "option": "bold dark_cyan",
+                "switch": "bold green4",
+                "default_option": "light_coral",
+                "option_keyword": "bold dark_cyan",
+                "args_keyword": "bold green4",
+            })
+        )
+    return None
+
+
+def table_color_theme(theme):
+    """Define result table colors"""
+    if not theme:
+        return {'header': 'bright_cyan',
+                'id_columns': 'pale_violet_red1'}
+    if theme == 'dark':
+        return {'header': 'bright_cyan',
+                'id_columns': 'pale_violet_red1'}
+    if theme == 'light':
+        return {'header': 'dark_cyan',
+                'id_columns': 'light_coral'}
+    return None