#1768 added support for click.Choices in the help text

Author: allmightyspiff

SoftLayer/CLI/command.py

@@ -19,11 +19,15 @@
 
 
 class OptionHighlighter(RegexHighlighter):
-    """Provides highlighter regex for the Command help"""
+    """Provides highlighter regex for the Command help.
+
+    Defined in SoftLayer\\utils.py console_color_themes()
+    """
     highlights = [
         r"(?P<switch>^\-\w)",  # single options like -v
         r"(?P<option>\-\-[\w\-]+)",  # long options like --verbose
         r"(?P<default_option>\[[^\]]+\])",  # anything between [], usually default options
+        r"(?P<option_choices>Choices: )",
     ]
 
 
@@ -223,6 +227,11 @@ def format_options(self, ctx, formatter):
             if help_record:
                 help_message = param.get_help_record(ctx)[-1]
 
+            # Add Click choices to help message
+            if isinstance(param.type, click.Choice):
+                choices = ", ".join(param.type.choices)
+                help_message += f" Choices: {choices}"
+
             if param.metavar:
                 options += f" {param.metavar}"
             options_table.add_row(opt1, opt2, self.highlighter(help_message))

SoftLayer/utils.py

@@ -481,6 +481,7 @@ def console_color_themes(theme):
                 "default_option": "light_coral",
                 "option_keyword": "bold dark_cyan",
                 "args_keyword": "bold green4",
+                "option_choices": "gold3",
             })
         )
     return Console(theme=Theme(
@@ -497,6 +498,7 @@ def console_color_themes(theme):
             "default_option": "light_pink1",
             "option_keyword": "bold cyan",
             "args_keyword": "bold green",
+            "option_choices": "gold3",
         })
     )