Skip to content
This repository was archived by the owner on Aug 11, 2020. It is now read-only.

Commit 7e3e629

Browse files
BartoszCkikossak
authored andcommitted
Remove command group aliases so the help messages are not duplicated
1 parent a06f0d0 commit 7e3e629

File tree

9 files changed

+8
-51
lines changed

9 files changed

+8
-51
lines changed

paperspace/cli/common.py

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -31,27 +31,7 @@ def jsonify_dicts(dict_):
3131

3232

3333
class ClickGroup(DYMMixin, HelpColorsGroup):
34-
def group(self, *args, **kwargs):
35-
aliases = []
36-
_args = args
37-
if args and isinstance(args[0], list):
38-
# we have a list so create group aliases
39-
aliases = args[0][1:]
40-
_args = [args[0][0]] + list(args[1:])
41-
42-
if 'alias' in kwargs:
43-
aliases.append(kwargs.pop('alias'))
44-
45-
def decorator(f):
46-
cmd = click.group(*_args, **kwargs)(f)
47-
self.add_command(cmd)
48-
for alias in set(aliases):
49-
alias_cmd = click.group(alias, **kwargs)(f)
50-
self.add_command(alias_cmd)
51-
alias_cmd.commands = cmd.commands
52-
return cmd
53-
54-
return decorator
34+
pass
5535

5636

5737
def prompt_for_secret(prompt):

paperspace/cli/deployments.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
from paperspace.commands import deployments as deployments_commands
1010

1111

12-
@cli.group("deployments", alias='deployment', help="Manage deployments", cls=ClickGroup)
12+
@cli.group("deployments", help="Manage deployments", cls=ClickGroup)
1313
def deployments():
1414
pass
1515

paperspace/cli/experiments.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
)
1818

1919

20-
@cli.group(["experiments", "experiment"], help="Manage experiments", cls=ClickGroup)
20+
@cli.group("experiments", help="Manage experiments", cls=ClickGroup)
2121
def experiments():
2222
pass
2323

paperspace/cli/hyperparameters.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ def add_use_docker_file_flag_if_used(ctx, param, value):
1616
return value
1717

1818

19-
@cli.group(["hyperparameters", "hyperparameter"], help="Manage hyperparameters", cls=ClickGroup)
19+
@cli.group("hyperparameters", help="Manage hyperparameters", cls=ClickGroup)
2020
def hyperparameters_group():
2121
pass
2222

paperspace/cli/jobs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
from paperspace.commands import jobs as jobs_commands
1010

1111

12-
@cli.group(["jobs", "job"], help="Manage gradient jobs", cls=ClickGroup)
12+
@cli.group("jobs", help="Manage gradient jobs", cls=ClickGroup)
1313
def jobs_group():
1414
pass
1515

paperspace/cli/machines.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
)
1919

2020

21-
@cli.group(["machines", "machine"], help="Manage machines", cls=ClickGroup)
21+
@cli.group("machines", help="Manage machines", cls=ClickGroup)
2222
def machines_group():
2323
pass
2424

paperspace/cli/models.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
from paperspace.commands import models as models_commands
77

88

9-
@cli.group(["models", "model"], help="Manage models", cls=common.ClickGroup)
9+
@cli.group("models", help="Manage models", cls=common.ClickGroup)
1010
def models_group():
1111
pass
1212

paperspace/cli/projects.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
from paperspace.cli import common
55

66

7-
@cli.group(["projects", "project"], help="Manage projects", cls=common.ClickGroup)
7+
@cli.group("projects", help="Manage projects", cls=common.ClickGroup)
88
def projects_group():
99
pass
1010

tests/functional/test_jobs.py

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -16,29 +16,6 @@ class TestJobs(object):
1616
EXPECTED_HEADERS_WITH_CHANGED_API_KEY["X-API-Key"] = "some_key"
1717

1818

19-
class TestJobsAlias(object):
20-
expected_help = """Usage: cli %s [OPTIONS] COMMAND [ARGS]...
21-
22-
Manage gradient jobs
23-
24-
Options:
25-
--help Show this message and exit.
26-
27-
Commands:
28-
artifacts Manage jobs' artifacts
29-
create Create job
30-
delete Delete job
31-
list List jobs with optional filtering
32-
logs List job logs
33-
stop Stop running job
34-
"""
35-
@pytest.mark.parametrize("group_name", ("jobs", "job"))
36-
def test_alias_help(self, group_name):
37-
cli_runner = CliRunner()
38-
result = cli_runner.invoke(cli.cli, [group_name])
39-
assert result.output == self.expected_help % group_name
40-
41-
4219
class TestListJobs(TestJobs):
4320
URL = "https://api.paperspace.io/jobs/getJobs/"
4421
BASIC_COMMAND = ["jobs", "list"]

0 commit comments

Comments
 (0)