Merge pull request #234 from Paperspace/PS-12850-Improve_consistency_of_options_and_commands_names

Ps 12850 improve consistency of options and commands names

Author: dandruszak

gradient/cli/clusters.py

@@ -16,6 +16,7 @@ def get_clusters_client(api_key):
 def clusters():
     pass
 
+
 @clusters.command("list", help="List your team clusters")
 @click.option(
     "--limit",

gradient/cli/common.py

@@ -244,7 +244,10 @@ def __init__(self, param_decls, **kwargs):
         super(GradientDatasetOption, self).__init__("dataset", param_decls, **kwargs)
 
 
-def validate_comma_split_option(comma_option_value, option_value):
+def validate_comma_split_option(comma_option_value, option_value, raise_if_no_tags=False):
+    if raise_if_no_tags and not any((comma_option_value, option_value)):
+        raise click.UsageError("No tags provided")
+
     if comma_option_value or option_value:
         if option_value:
             option_value = list(option_value)
@@ -253,4 +256,6 @@ def validate_comma_split_option(comma_option_value, option_value):
         if comma_option_value:
             comma_option_value = [s.strip() for s in comma_option_value.split(",")]
             option_value.extend(comma_option_value)
-        return sorted(list(set(option_value)))
+
+        tags = sorted(set(option_value))
+        return tags

gradient/cli/deployments.py

@@ -448,7 +448,13 @@ def get_deployment(deployment_id, api_key, options_file):
 
 
 @deployments_tags.command("add", help="Add tags to deployment")
-@click.argument("id", cls=common.GradientArgument)
+@click.option(
+    "--id",
+    "id",
+    required=True,
+    cls=common.GradientOption,
+    help="ID of the deployment",
+)
 @click.option(
     "--tag",
     "tags",
@@ -465,7 +471,7 @@ def get_deployment(deployment_id, api_key, options_file):
 @api_key_option
 @common.options_file
 def deployment_add_tag(id, options_file, api_key, **kwargs):
-    kwargs["tags"] = validate_comma_split_option(kwargs.pop("tags_comma"), kwargs.pop("tags"))
+    kwargs["tags"] = validate_comma_split_option(kwargs.pop("tags_comma"), kwargs.pop("tags"), raise_if_no_tags=True)
 
     deployment_client = get_deployment_client(api_key)
 
@@ -474,7 +480,13 @@ def deployment_add_tag(id, options_file, api_key, **kwargs):
 
 
 @deployments_tags.command("remove", help="Remove tags from deployment")
-@click.argument("id", cls=common.GradientArgument)
+@click.option(
+    "--id",
+    "id",
+    required=True,
+    cls=common.GradientOption,
+    help="ID of the deployment",
+)
 @click.option(
     "--tag",
     "tags",
@@ -491,7 +503,7 @@ def deployment_add_tag(id, options_file, api_key, **kwargs):
 @api_key_option
 @common.options_file
 def deployment_remove_tags(id, options_file, api_key, **kwargs):
-    kwargs["tags"] = validate_comma_split_option(kwargs.pop("tags_comma"), kwargs.pop("tags"))
+    kwargs["tags"] = validate_comma_split_option(kwargs.pop("tags_comma"), kwargs.pop("tags"), raise_if_no_tags=True)
 
     deployment_client = get_deployment_client(api_key)
 

gradient/cli/experiments.py

@@ -600,7 +600,13 @@ def create_and_start_single_node(ctx, api_key, show_logs, tensorboard, tensorboa
 
 
 @experiments_group.command("start", help="Start experiment")
-@click.argument("id", cls=common.GradientArgument)
+@click.option(
+    "--id",
+    "id",
+    required=True,
+    cls=common.GradientOption,
+    help="ID of the experiment",
+)
 @click.option(
     "--logs",
     "show_logs",
@@ -619,7 +625,13 @@ def start_experiment(ctx, id, show_logs, api_key, options_file):
 
 
 @experiments_group.command("stop", help="Stop experiment")
-@click.argument("id", cls=common.GradientArgument)
+@click.option(
+    "--id",
+    "id",
+    required=True,
+    cls=common.GradientOption,
+    help="ID of the experiment",
+)
 @api_key_option
 @common.options_file
 def stop_experiment(id, api_key, options_file):
@@ -672,7 +684,13 @@ def list_experiments(project_ids, api_key, exp_limit, exp_offset, tags, options_
 
 
 @experiments_group.command("details", help="Show detail of an experiment")
-@click.argument("id", cls=common.GradientArgument)
+@click.option(
+    "--id",
+    "id",
+    required=True,
+    cls=common.GradientOption,
+    help="ID of the experiment",
+)
 @api_key_option
 @common.options_file
 def get_experiment_details(id, options_file, api_key):
@@ -682,7 +700,7 @@ def get_experiment_details(id, options_file, api_key):
 
 @experiments_group.command("logs", help="List experiment logs")
 @click.option(
-    "--experimentId",
+    "--id",
     "experiment_id",
     required=True,
     cls=common.GradientOption,
@@ -716,7 +734,13 @@ def list_logs(experiment_id, line, limit, follow, options_file, api_key=None):
 
 
 @experiments_group.command("delete", help="Delete an experiment")
-@click.argument("id", cls=common.GradientArgument)
+@click.option(
+    "--id",
+    "id",
+    required=True,
+    cls=common.GradientOption,
+    help="ID of the experiment",
+)
 @api_key_option
 @common.options_file
 def delete_experiment(id, options_file, api_key):
@@ -725,7 +749,13 @@ def delete_experiment(id, options_file, api_key):
 
 
 @experiments_tags.command("add", help="Add tags to experiment")
-@click.argument("id", cls=common.GradientArgument)
+@click.option(
+    "--id",
+    "id",
+    required=True,
+    cls=common.GradientOption,
+    help="ID of the experiment",
+)
 @click.option(
     "--tag",
     "tags",
@@ -742,14 +772,20 @@ def delete_experiment(id, options_file, api_key):
 @api_key_option
 @common.options_file
 def experiment_add_tags(id, options_file, api_key, **kwargs):
-    kwargs["tags"] = validate_comma_split_option(kwargs.pop("tags_comma"), kwargs.pop("tags"))
+    kwargs["tags"] = validate_comma_split_option(kwargs.pop("tags_comma"), kwargs.pop("tags"), raise_if_no_tags=True)
 
     command = ExperimentAddTagsCommand(api_key=api_key)
     command.execute(id, **kwargs)
 
 
 @experiments_tags.command("remove", help="Remove tags from experiment")
-@click.argument("id", cls=common.GradientArgument)
+@click.option(
+    "--id",
+    "id",
+    required=True,
+    cls=common.GradientOption,
+    help="ID of the experiment",
+)
 @click.option(
     "--tag",
     "tags",
@@ -766,7 +802,7 @@ def experiment_add_tags(id, options_file, api_key, **kwargs):
 @api_key_option
 @common.options_file
 def experiment_remove_tags(id, options_file, api_key, **kwargs):
-    kwargs["tags"] = validate_comma_split_option(kwargs.pop("tags_comma"), kwargs.pop("tags"))
+    kwargs["tags"] = validate_comma_split_option(kwargs.pop("tags_comma"), kwargs.pop("tags"), raise_if_no_tags=True)
 
     command = ExperimentRemoveTagsCommand(api_key=api_key)
     command.execute(id, **kwargs)

gradient/cli/hyperparameters.py

@@ -195,7 +195,13 @@ def start_hyperparameter_tuning(api_key, options_file, id_):
 
 
 @hyperparameters_tags.command("add", help="Add tags to hyperparameter")
-@click.argument("id", cls=common.GradientArgument)
+@click.option(
+    "--id",
+    "id",
+    required=True,
+    cls=common.GradientOption,
+    help="ID of the hyperparameter",
+)
 @click.option(
     "--tag",
     "tags",
@@ -212,14 +218,20 @@ def start_hyperparameter_tuning(api_key, options_file, id_):
 @common.api_key_option
 @common.options_file
 def hyperparameter_add_tag(id, options_file, api_key, **kwargs):
-    kwargs["tags"] = validate_comma_split_option(kwargs.pop("tags_comma"), kwargs.pop("tags"))
+    kwargs["tags"] = validate_comma_split_option(kwargs.pop("tags_comma"), kwargs.pop("tags"), raise_if_no_tags=True)
 
     command = HyperparameterAddTagsCommand(api_key=api_key)
     command.execute(id, **kwargs)
 
 
 @hyperparameters_tags.command("remove", help="Remove tags from hyperparameter")
-@click.argument("id", cls=common.GradientArgument)
+@click.option(
+    "--id",
+    "id",
+    required=True,
+    cls=common.GradientOption,
+    help="ID of the hyperparameter",
+)
 @click.option(
     "--tag",
     "tags",
@@ -236,7 +248,7 @@ def hyperparameter_add_tag(id, options_file, api_key, **kwargs):
 @common.api_key_option
 @common.options_file
 def hyperparameter_remove_tags(id, options_file, api_key, **kwargs):
-    kwargs["tags"] = validate_comma_split_option(kwargs.pop("tags_comma"), kwargs.pop("tags"))
+    kwargs["tags"] = validate_comma_split_option(kwargs.pop("tags_comma"), kwargs.pop("tags"), raise_if_no_tags=True)
 
     command = HyperparameterRemoveTagsCommand(api_key=api_key)
     command.execute(id, **kwargs)

gradient/cli/jobs.py

@@ -33,7 +33,7 @@ def jobs_tags():
 
 @jobs_group.command("delete", help="Delete job")
 @click.option(
-    "--jobId",
+    "--id",
     "job_id",
     required=True,
     help="Delete job with given ID",
@@ -46,7 +46,7 @@ def delete_job(job_id, api_key):
 
 @jobs_group.command("stop", help="Stop running job")
 @click.option(
-    "--jobId",
+    "--id",
     "job_id",
     required=True,
     help="Stop job with given ID",
@@ -296,7 +296,7 @@ def create_job(ctx, api_key, options_file, **kwargs):
 
 @jobs_group.command("logs", help="List job logs")
 @click.option(
-    "--jobId",
+    "--id",
     "job_id",
     required=True,
     cls=common.GradientOption,
@@ -335,7 +335,12 @@ def artifacts():
 
 
 @artifacts.command("destroy", help="Destroy job's artifacts")
-@click.argument("job_id", cls=common.GradientArgument)
+@click.option(
+    "--id",
+    "job_id",
+    cls=common.GradientOption,
+    help="ID of the job",
+)
 @click.option(
     "--files",
     "files",
@@ -349,7 +354,12 @@ def destroy_artifacts(job_id, options_file, api_key=None, files=None):
 
 
 @artifacts.command("get", help="Get job's artifacts")
-@click.argument("job_id", cls=common.GradientArgument)
+@click.option(
+    "--id",
+    "job_id",
+    cls=common.GradientOption,
+    help="ID of the job",
+)
 @api_key_option
 @common.options_file
 def get_artifacts(job_id, options_file, api_key=None):
@@ -358,7 +368,12 @@ def get_artifacts(job_id, options_file, api_key=None):
 
 
 @artifacts.command("list", help="List job's artifacts")
-@click.argument("job_id", cls=common.GradientArgument)
+@click.option(
+    "--id",
+    "job_id",
+    cls=common.GradientOption,
+    help="ID of the job",
+)
 @click.option(
     "--size",
     "-s",
@@ -391,7 +406,7 @@ def list_artifacts(job_id, size, links, files, options_file, api_key=None):
 
 @artifacts.command("download", help="List job's artifacts")
 @click.option(
-    "--jobId",
+    "--id",
     "job_id",
     cls=common.GradientOption,
 )
@@ -408,7 +423,13 @@ def download_artifacts(job_id, destination_directory, options_file, api_key=None
 
 
 @jobs_tags.command("add", help="Add tags to job")
-@click.argument("id", cls=common.GradientArgument)
+@click.option(
+    "--id",
+    "id",
+    required=True,
+    cls=common.GradientOption,
+    help="ID of the job",
+)
 @click.option(
     "--tag",
     "tags",
@@ -425,14 +446,20 @@ def download_artifacts(job_id, destination_directory, options_file, api_key=None
 @api_key_option
 @common.options_file
 def job_add_tag(id, options_file, api_key, **kwargs):
-    kwargs["tags"] = validate_comma_split_option(kwargs.pop("tags_comma"), kwargs.pop("tags"))
+    kwargs["tags"] = validate_comma_split_option(kwargs.pop("tags_comma"), kwargs.pop("tags"), raise_if_no_tags=True)
 
     command = JobAddTagsCommand(api_key=api_key)
     command.execute(id, **kwargs)
 
 
 @jobs_tags.command("remove", help="Remove tags from job")
-@click.argument("id", cls=common.GradientArgument)
+@click.option(
+    "--id",
+    "id",
+    required=True,
+    cls=common.GradientOption,
+    help="ID of the job",
+)
 @click.option(
     "--tag",
     "tags",
@@ -449,7 +476,7 @@ def job_add_tag(id, options_file, api_key, **kwargs):
 @api_key_option
 @common.options_file
 def job_remove_tags(id, options_file, api_key, **kwargs):
-    kwargs["tags"] = validate_comma_split_option(kwargs.pop("tags_comma"), kwargs.pop("tags"))
+    kwargs["tags"] = validate_comma_split_option(kwargs.pop("tags_comma"), kwargs.pop("tags"), raise_if_no_tags=True)
 
     command = JobRemoveTagsCommand(api_key=api_key)
     command.execute(id, **kwargs)