Merge pull request #113 from Paperspace/PS-9993/singular-alias

cli group alias supported

Author: mkulaczkowski

paperspace/cli/common.py

@@ -1,6 +1,7 @@
 import getpass
 
 import click
+from click import group
 from click_didyoumean import DYMMixin
 from click_help_colors import HelpColorsGroup
 
@@ -19,7 +20,27 @@ def del_if_value_is_none(dict_):
 
 
 class ClickGroup(DYMMixin, HelpColorsGroup):
-    pass
+    def group(self, *args, **kwargs):
+        aliases = []
+        _args = args
+        if args and isinstance(args[0], list):
+            # we have a list so create group aliases
+            aliases = args[0][1:]
+            _args = [args[0][0]] + list(args[1:])
+
+        if 'alias' in kwargs:
+            aliases.append(kwargs.pop('alias'))
+
+        def decorator(f):
+            cmd = group(*_args, **kwargs)(f)
+            self.add_command(cmd)
+            for alias in set(aliases):
+                alias_cmd = group(alias, **kwargs)(f)
+                self.add_command(alias_cmd)
+                alias_cmd.commands = cmd.commands
+            return cmd
+
+        return decorator
 
 
 def prompt_for_secret(prompt):

paperspace/cli/deployments.py

@@ -2,14 +2,14 @@
 
 import click
 
-from paperspace import constants, client, config
+from paperspace import client, config
 from paperspace.cli.cli import cli
 from paperspace.cli.cli_types import ChoiceType
 from paperspace.cli.common import api_key_option, del_if_value_is_none, ClickGroup
 from paperspace.commands import deployments as deployments_commands
 
 
-@cli.group("deployments", help="Manage deployments", cls=ClickGroup)
+@cli.group("deployments", alias='deployment', help="Manage deployments", cls=ClickGroup)
 def deployments():
     pass
 
@@ -22,7 +22,8 @@ def deployments():
 )
 
 DEPLOYMENT_MACHINE_TYPES = ("G1", "G6", "G12",
-    "K80", "P100", "GV100")
+                            "K80", "P100", "GV100")
+
 
 @deployments.command("create", help="Create new deployment")
 @click.option(
@@ -135,4 +136,4 @@ def start_deployment(id_, api_key=None):
 def stop_deployment(id_, api_key=None):
     deployments_api = client.API(config.CONFIG_HOST, api_key=api_key)
     command = deployments_commands.StopDeploymentCommand(api=deployments_api)
-    command.execute(id_)
+    command.execute(id_)

paperspace/cli/experiments.py

@@ -17,7 +17,7 @@
 )
 
 
-@cli.group("experiments", help="Manage experiments", cls=ClickGroup)
+@cli.group(["experiments", "experiment"], help="Manage experiments", cls=ClickGroup)
 def experiments():
     pass
 

paperspace/cli/hyperparameters.py

@@ -9,7 +9,7 @@
 from paperspace.commands import hyperparameters as hyperparameters_commands
 
 
-@cli.group("hyperparameters", help="Manage hyperparameters", cls=ClickGroup)
+@cli.group(["hyperparameters", "hyperparameter"], help="Manage hyperparameters", cls=ClickGroup)
 def hyperparameters_group():
     pass
 

paperspace/cli/jobs.py

@@ -7,7 +7,7 @@
 from paperspace.commands import jobs as jobs_commands
 
 
-@cli.group("jobs", help="Manage gradient jobs", cls=ClickGroup)
+@cli.group(["jobs", "job"], help="Manage gradient jobs", cls=ClickGroup)
 def jobs_group():
     pass
 

paperspace/cli/machines.py

@@ -18,7 +18,7 @@
 )
 
 
-@cli.group("machines", help="Manage machines", cls=ClickGroup)
+@cli.group(["machines", "machine"], help="Manage machines", cls=ClickGroup)
 def machines_group():
     pass
 

paperspace/cli/models.py

@@ -6,7 +6,7 @@
 from paperspace.commands import models as models_commands
 
 
-@cli.group("models", help="Manage models", cls=common.ClickGroup)
+@cli.group(["models", "model"], help="Manage models", cls=common.ClickGroup)
 def models_group():
     pass
 

paperspace/cli/projects.py

@@ -4,7 +4,7 @@
 from paperspace.cli import common
 
 
-@cli.group("projects", help="Manage projects", cls=common.ClickGroup)
+@cli.group(["projects", "project"], help="Manage projects", cls=common.ClickGroup)
 def projects_group():
     pass
 

tests/functional/test_jobs.py

@@ -16,6 +16,29 @@ class TestJobs(object):
     EXPECTED_HEADERS_WITH_CHANGED_API_KEY["X-API-Key"] = "some_key"
 
 
+class TestJobsAlias(object):
+    expected_help = """Usage: cli %s [OPTIONS] COMMAND [ARGS]...
+
+  Manage gradient jobs
+
+Options:
+  --help  Show this message and exit.
+
+Commands:
+  artifacts  Manage jobs' artifacts
+  create     Create job
+  delete     Delete job
+  list       List jobs with optional filtering
+  log        List job logs
+  stop       Stop running job
+"""
+    @pytest.mark.parametrize("group_name", ("jobs", "job"))
+    def test_alias_help(self, group_name):
+        cli_runner = CliRunner()
+        result = cli_runner.invoke(cli.cli, [group_name])
+        assert result.output == self.expected_help % group_name
+
+
 class TestListJobs(TestJobs):
     URL = "https://api.paperspace.io/jobs/getJobs/"
     BASIC_COMMAND = ["jobs", "list"]