tox fixes

Author: allmightyspiff

SoftLayer/CLI/block/replication/disaster_recovery_failover.py

@@ -8,7 +8,8 @@
 from SoftLayer.CLI import formatting
 
 
-@click.command(cls=SoftLayer.CLI.command.SLCommand, epilog="""Failover an inaccessible block volume to its available replicant volume.
+@click.command(cls=SoftLayer.CLI.command.SLCommand,
+               epilog="""Failover an inaccessible block volume to its available replicant volume.
 If a volume (with replication) becomes inaccessible due to a disaster event, this method can be used to immediately
 failover to an available replica in another location. This method does not allow for failback via API.
 After using this method, to failback to the original volume, please open a support ticket.

SoftLayer/CLI/command.py

@@ -1,28 +1,36 @@
-import click
-import types
+"""
+    SoftLayer.CLI.command
+    ~~~~~~~~~~~~~~~~~~~~~
+    Command interface for the SoftLayer CLI. Basically the Click commands, with fancy help text
+
+    :license: MIT, see LICENSE for more details.
+"""
 import inspect
+import types
+
+import click
 
 from rich import box
-from rich.console import Console, RenderableType
-from rich.markup import escape
-from rich.text import Text
+from rich.console import Console
 from rich.highlighter import RegexHighlighter
-from rich.panel import Panel
 from rich.table import Table
+from rich.text import Text
 from rich.theme import Theme
 
-
 from SoftLayer.CLI import environment
 
+
 class OptionHighlighter(RegexHighlighter):
+    """Provides highlighter regex for the Command help"""
     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<switch>\-\w)",  # single options like -v
+        r"(?P<option>\-\-[\w\-]+)",  # long options like --verbose
+        r"(?P<default_option>\[[^\]]+\])",  # anything between [], usually default options
 
     ]
 
-# Colors defined in https://rich.readthedocs.io/en/latest/_modules/rich/color.html#ColorType
+
+#  Colors defined in https://rich.readthedocs.io/en/latest/_modules/rich/color.html#ColorType
 SLCLI_THEME = Theme(
     {
         "option": "bold cyan",
@@ -86,7 +94,7 @@ def format_help_text(self, ctx: click.Context, formatter: click.formatting.HelpF
         text = self.help if self.help is not None else ""
 
         if self.deprecated:
-            text = _("(Deprecated) {text}").format(text=text)
+            text = f"(Deprecated) {text}"
 
         if text:
             text = inspect.cleandoc(text).partition("\f")[0]
@@ -100,7 +108,6 @@ def format_epilog(self, ctx: click.Context, formatter: click.formatting.HelpForm
             self.console.print(epilog)
         self.format_commands(ctx, formatter)
 
-
     def format_options(self, ctx, formatter):
         """Prints out the options in a table format"""
 
@@ -151,17 +158,17 @@ def format_commands(self, ctx, formatter):
         self.console.print("\n[bold orange1]Commands:[/]")
         self.console.print(command_table)
 
+
 class SLCommand(click.Command):
     """Overloads click.Command to control how the help message is formatted."""
 
-    def __init__(self, *path, **attrs):
+    def __init__(self, **attrs):
         click.Command.__init__(self, **attrs)
         self.highlighter = OptionHighlighter()
         self.console = Console(
             theme=SLCLI_THEME
         )
 
-
     def format_usage(self, ctx: click.Context, formatter: click.formatting.HelpFormatter) -> None:
         """Formats and colorizes the usage information."""
         pieces = self.collect_usage_pieces(ctx)
@@ -178,7 +185,7 @@ def format_help_text(self, ctx: click.Context, formatter: click.formatting.HelpF
         text = self.help if self.help is not None else ""
 
         if self.deprecated:
-            text = _("(Deprecated) {text}").format(text=text)
+            text = f"(Deprecated) {text}"
 
         if text:
             text = inspect.cleandoc(text)
@@ -195,8 +202,8 @@ def format_epilog(self, ctx: click.Context, formatter: click.formatting.HelpForm
     def format_options(self, ctx, formatter):
         """Prints out the options in a table format"""
 
-        ## TODO support binary options --yes/--no
-        ## SUPPORT color for IDENTIFIER and such
+        # NEXT support binary options --yes/--no
+        # NEXT SUPPORT color for IDENTIFIER and such
         options_table = Table(highlight=True, box=box.SQUARE, show_header=False)
 
         for param in self.get_params(ctx):

SoftLayer/CLI/config/setup.py

@@ -47,7 +47,7 @@ def get_api_key(client, username, secret):  # pylint: disable=inconsistent-retur
         return api_keys[0]['authenticationKey']
 
 
-@click.command()
+@click.command(cls=SLCommand)
 @click.option('-a', '--auth', type=click.Choice(['ibmid', 'cloud_key', 'classic_key', 'sso']),
               help="Select a method of authentication.", default='classic_key', show_default=True)
 @environment.pass_env

SoftLayer/CLI/core.py

@@ -5,15 +5,14 @@
 
     :license: MIT, see LICENSE for more details.
 """
-import click
-
 import logging
 import os
-import requests
 import sys
 import time
 import traceback
-import types
+
+import click
+import requests
 
 import SoftLayer
 from SoftLayer.CLI.command import CommandLoader
@@ -57,6 +56,8 @@ def get_latest_version():
     auto_envvar_prefix='SLCLI',
     max_content_width=999
 )
+
+
 def get_version_message(ctx, param, value):
     """Gets current and latest release versions message."""
     if not value or ctx.resilient_parsing:

SoftLayer/CLI/dedicatedhost/create.py

@@ -10,8 +10,8 @@
 from SoftLayer.CLI import template
 
 
-@click.command(cls=SoftLayer.CLI.command.SLCommand, 
-    epilog="See 'slcli dedicatedhost create-options' for valid options.")
+@click.command(cls=SoftLayer.CLI.command.SLCommand,
+               epilog="See 'slcli dedicatedhost create-options' for valid options.")
 @click.option('--hostname', '-H',
               help="Host portion of the FQDN",
               required=True,

SoftLayer/CLI/file/replication/disaster_recovery_failover.py

@@ -8,7 +8,8 @@
 from SoftLayer.CLI import formatting
 
 
-@click.command(cls=SoftLayer.CLI.command.SLCommand, epilog="""Failover an inaccessible file volume to its available replicant volume.
+@click.command(cls=SoftLayer.CLI.command.SLCommand,
+               epilog="""Failover an inaccessible file volume to its available replicant volume.
 If a volume (with replication) becomes inaccessible due to a disaster event, this method can be used to immediately
 failover to an available replica in another location. This method does not allow for failback via API.
 After using this method, to failback to the original volume, please open a support ticket.

SoftLayer/CLI/globalip/assign.py

@@ -13,7 +13,7 @@
 
 
 @click.command(cls=SoftLayer.CLI.command.SLCommand, epilog="More information about types and identifiers "
-                      "on https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/route/")
+               "on https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/route/")
 @click.argument('identifier')
 @click.option('--target', type=click.Choice(['vlan', 'ip', 'hardware', 'vsi']),
               help='choose the type. vlan, ip, hardware, vsi')

SoftLayer/CLI/subnet/route.py

@@ -13,7 +13,7 @@
 
 
 @click.command(cls=SoftLayer.CLI.command.SLCommand, epilog="More information about types and identifiers "
-                      "on https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/route/")
+               "on https://sldn.softlayer.com/reference/services/SoftLayer_Network_Subnet/route/")
 @click.argument('identifier')
 @click.option('--target', type=click.Choice(['vlan', 'ip', 'hardware', 'vsi']),
               help='choose the type. vlan, ip, hardware, vsi')

SoftLayer/CLI/virt/capacity/create.py

@@ -1,7 +1,6 @@
 """Create a Reserved Capacity instance."""
 
 import click
-from rich.text import Text
 
 from SoftLayer.CLI.command import SLCommand as SLCommand
 from SoftLayer.CLI import environment

SoftLayer/CLI/virt/capacity/detail.py

@@ -2,8 +2,8 @@
 
 import click
 
-from SoftLayer.CLI.command import SLCommand as SLCommand
 from SoftLayer.CLI import columns as column_helper
+from SoftLayer.CLI.command import SLCommand as SLCommand
 from SoftLayer.CLI import environment
 from SoftLayer.CLI import formatting
 from SoftLayer.managers.vs_capacity import CapacityManager as CapacityManager