Add colors to help and log errors in red

Author: BartoszCki

Pipfile

@@ -14,6 +14,7 @@ gradient-statsd = "*"
 click = "*"
 terminaltables = "*"
 click-didyoumean = "*"
+click-help-colors = "*"
 
 [dev-packages]
 twine = "*"

Pipfile.lock

@@ -3,9 +3,8 @@
 
 import click
 
-from click_didyoumean import DYMGroup
-
 from paperspace import constants, client, config
+from paperspace.cli import common
 from paperspace.cli.common import api_key_option, del_if_value_is_none
 from paperspace.cli.jobs import jobs_group
 from paperspace.cli.models import models_group
@@ -23,22 +22,22 @@
 )
 
 
-@click.group(cls=DYMGroup)
+@click.group(cls=common.ClickGroup, **config.HELP_COLORS_DICT)
 def cli():
     pass
 
 
-@cli.group("experiments", help="Manage experiments", cls=DYMGroup)
+@cli.group("experiments", help="Manage experiments", cls=common.ClickGroup)
 def experiments():
     pass
 
 
-@experiments.group("create", help="Create new experiment", cls=DYMGroup)
+@experiments.group("create", help="Create new experiment", cls=common.ClickGroup)
 def create_experiment():
     pass
 
 
-@experiments.group(name="createAndStart", help="Create and start new experiment", cls=DYMGroup)
+@experiments.group(name="createAndStart", help="Create and start new experiment", cls=common.ClickGroup)
 def create_and_start_experiment():
     pass
 
@@ -330,7 +329,7 @@ def get_experiment_details(experiment_handle, api_key):
 )
 
 
-@cli.group("deployments", help="Manage deployments", cls=DYMGroup)
+@cli.group("deployments", help="Manage deployments", cls=common.ClickGroup)
 def deployments():
     pass
 
@@ -499,7 +498,7 @@ def delete_deployment(id_, api_key=None):
 )
 
 
-@cli.group("machines", help="Manage machines", cls=DYMGroup)
+@cli.group("machines", help="Manage machines", cls=common.ClickGroup)
 def machines_group():
     pass
 
@@ -1068,3 +1067,6 @@ def version():
 cli.add_command(jobs_group)
 cli.add_command(projects_group)
 cli.add_command(models_group)
+
+if __name__ == '__main__':
+    cli()

paperspace/cli/cli.py

@@ -1,4 +1,6 @@
 import click
+from click_didyoumean import DYMMixin
+from click_help_colors import HelpColorsGroup
 
 api_key_option = click.option(
     "--apiKey",
@@ -11,4 +13,8 @@ def del_if_value_is_none(dict_):
     """Remove all elements with value == None"""
     for key, val in list(dict_.items()):
         if val is None:
-            del dict_[key]
+            del dict_[key]
+
+
+class ClickGroup(DYMMixin, HelpColorsGroup):
+    pass

paperspace/cli/common.py

@@ -1,12 +1,11 @@
 import click
-from click_didyoumean import DYMGroup
 
 from paperspace import client, config
 from paperspace.cli import common
 from paperspace.commands import jobs as jobs_commands
 
 
-@click.group("jobs", help="Manage gradient jobs", cls=DYMGroup)
+@click.group("jobs", help="Manage gradient jobs", cls=common.ClickGroup)
 def jobs_group():
     pass
 

paperspace/cli/jobs.py

@@ -1,12 +1,11 @@
 import click
-from click_didyoumean import DYMGroup
 
 from paperspace import client, config
 from paperspace.cli import common
 from paperspace.commands import models as models_commands
 
 
-@click.group("models", help="Manage models", cls=DYMGroup)
+@click.group("models", help="Manage models", cls=common.ClickGroup)
 def models_group():
     pass
 

paperspace/cli/models.py

@@ -1,12 +1,11 @@
 import click
-from click_didyoumean import DYMGroup
 
 from paperspace import client, config
 from paperspace.commands import projects as projects_commands
 from . import common
 
 
-@click.group("projects", help="Manage projects", cls=DYMGroup)
+@click.group("projects", help="Manage projects", cls=common.ClickGroup)
 def projects_group():
     pass
 

paperspace/cli/projects.py

@@ -19,7 +19,7 @@ def _log_message(self, response, success_msg_template, error_msg):
                 j = response.json()
                 handle = j["deployment"]
             except (ValueError, KeyError):
-                self.logger.log(success_msg_template)
+                self.logger.error(success_msg_template)
             else:
                 msg = success_msg_template.format(**handle)
                 self.logger.log(msg)
@@ -28,7 +28,7 @@ def _log_message(self, response, success_msg_template, error_msg):
                 data = response.json()
                 self.logger.log_error_response(data)
             except ValueError:
-                self.logger.log(error_msg)
+                self.logger.error(error_msg)
 
 
 class CreateDeploymentCommand(_DeploymentCommandBase):
@@ -51,7 +51,7 @@ def execute(self, filters=None):
                 return
             deployments = self._get_deployments_list(response)
         except (ValueError, KeyError) as e:
-            self.logger.log("Error while parsing response data: {}".format(e))
+            self.logger.error("Error while parsing response data: {}".format(e))
         else:
             self._log_deployments_list(deployments)
 
@@ -74,7 +74,7 @@ def _get_deployments_list(response):
 
     def _log_deployments_list(self, deployments):
         if not deployments:
-            self.logger.log("No deployments found")
+            self.logger.warning("No deployments found")
         else:
             table_str = self._make_deployments_list_table(deployments)
             if len(table_str.splitlines()) > get_terminal_lines():

paperspace/commands/deployments.py

@@ -20,7 +20,7 @@ def _log_create_experiment(response, success_msg_template, error_msg, logger_=lo
             data = response.json()
             logger_.log_error_response(data)
         except ValueError:
-            logger_.log(error_msg)
+            logger_.error(error_msg)
 
 
 def create_experiment(json_, api=experiments_api):
@@ -63,7 +63,7 @@ def execute(self, project_handles=None):
         try:
             experiments = self._get_experiments_list(response, bool(project_handles))
         except (ValueError, KeyError) as e:
-            self.logger.log("Error while parsing response data: {}".format(e))
+            self.logger.error("Error while parsing response data: {}".format(e))
         else:
             self._log_experiments_list(experiments)
 
@@ -106,7 +106,7 @@ def _get_experiments_list(response, filtered=False):
 
     def _log_experiments_list(self, experiments):
         if not experiments:
-            self.logger.log("No experiments found")
+            self.logger.warning("No experiments found")
         else:
             table_str = self._make_experiments_list_table(experiments)
             if len(table_str.splitlines()) > get_terminal_lines():
@@ -175,7 +175,6 @@ def get_experiment_details(experiment_handle, api=experiments_api):
             experiment = response.json()["data"]
             details = _make_details_table(experiment)
         except (ValueError, KeyError) as e:
-            logger.log("Error parsing response data")
-            logger.debug(e)
+            logger.error("Error parsing response data")
 
     log_response(response, details, "Unknown error while retrieving details of the experiment")

paperspace/commands/experiments.py

@@ -21,7 +21,7 @@ def _log_message(self, response, success_msg_template, error_msg):
                 data = response.json()
                 self.logger.log_error_response(data)
             except ValueError:
-                self.logger.log(error_msg)
+                self.logger.error(error_msg)
 
 
 class DeleteJobCommand(JobsCommandBase):
@@ -53,13 +53,13 @@ def execute(self, filters=None):
                 self.logger.log_error_response(data)
                 return
         except (ValueError, KeyError) as e:
-            self.logger.log("Error while parsing response data: {}".format(e))
+            self.logger.error("Error while parsing response data: {}".format(e))
         else:
             self._log_jobs_list(data)
 
     def _log_jobs_list(self, data):
         if not data:
-            self.logger.log("No jobs found")
+            self.logger.warning("No jobs found")
         else:
             table_str = self._make_table(data)
             if len(table_str.splitlines()) > get_terminal_lines():