tweak: Add flag to show or hide logs. Default is hide.

Author: colin-welch

paperspace/cli/experiments.py

@@ -235,6 +235,13 @@ def common_experiments_create_single_node_options(f):
     return functools.reduce(lambda x, opt: opt(x), reversed(options), f)
 
 
+show_logs_option = click.option(
+    "--logs/--no-logs",
+    "show_logs",
+    default=False,
+)
+
+
 @create_experiment.command(name="multinode", help="Create multi node experiment")
 @common_experiments_create_options
 @common_experiment_create_multi_node_options
@@ -259,38 +266,42 @@ def create_single_node(api_key, **kwargs):
 @create_and_start_experiment.command(name="multinode", help="Create and start new multi node experiment")
 @common_experiments_create_options
 @common_experiment_create_multi_node_options
+@show_logs_option
 @click.pass_context
-def create_and_start_multi_node(ctx, api_key, **kwargs):
+def create_and_start_multi_node(ctx, api_key, show_logs, **kwargs):
     del_if_value_is_none(kwargs)
     experiments_api = client.API(config.CONFIG_EXPERIMENTS_HOST, api_key=api_key)
     command = experiments_commands.CreateAndStartExperimentCommand(api=experiments_api)
     experiment = command.execute(kwargs)
-    if experiment is not None:
+    if experiment is not None and show_logs is True:
         ctx.invoke(list_logs, experiment_id=experiment["handle"], line=0, limit=100, follow=True, api_key=api_key)
 
 
 @create_and_start_experiment.command(name="singlenode", help="Create and start new single node experiment")
 @common_experiments_create_options
 @common_experiments_create_single_node_options
+@show_logs_option
 @click.pass_context
-def create_and_start_single_node(ctx, api_key, **kwargs):
+def create_and_start_single_node(ctx, api_key, show_logs, **kwargs):
     kwargs["experimentTypeId"] = constants.ExperimentType.SINGLE_NODE
     del_if_value_is_none(kwargs)
     experiments_api = client.API(config.CONFIG_EXPERIMENTS_HOST, api_key=api_key)
     command = experiments_commands.CreateAndStartExperimentCommand(api=experiments_api)
     experiment = command.execute(kwargs)
-    if experiment is not None:
+    if experiment is not None and show_logs is True:
         ctx.invoke(list_logs, experiment_id=experiment["handle"], line=0, limit=100, follow=True, api_key=api_key)
 
 
 @experiments.command("start", help="Start experiment")
 @click.argument("experiment-id")
 @api_key_option
+@show_logs_option
 @click.pass_context
-def start_experiment(ctx, experiment_id, api_key):
+def start_experiment(ctx, experiment_id, show_logs, api_key):
     experiments_api = client.API(config.CONFIG_EXPERIMENTS_HOST, api_key=api_key)
     experiments_commands.start_experiment(experiment_id, api=experiments_api)
-    ctx.invoke(list_logs, experiment_id=experiment_id, line=0, limit=100, follow=True, api_key=api_key)
+    if show_logs is True:
+        ctx.invoke(list_logs, experiment_id=experiment_id, line=0, limit=100, follow=True, api_key=api_key)
 
 
 @experiments.command("stop", help="Stop experiment")

tests/functional/test_jobs.py

@@ -173,12 +173,13 @@ def test_should_print_proper_message_when_jobs_list_was_used_with_mutually_exclu
 
 
 class TestJobLogs(TestJobs):
-    URL = "https://logs.paperspace.io/jobs/logs?jobId=some_job_id&line=0&limit=10000"
+    URL = "https://logs.paperspace.io/jobs/logs"
 
     RESPONSE_JSON_WITH_WRONG_API_TOKEN = {"status": 400, "message": "Invalid API token"}
     EXPECTED_RESPONSE_JSON = example_responses.LIST_OF_LOGS_FOR_JOB
     BASIC_COMMAND_WITHOUT_PARAMETERS = ["jobs", "logs"]
     BASIC_COMMAND = ["jobs", "logs", "--jobId", "some_job_id", "--apiKey", "some_key"]
+    BASIC_COMMAND_PARAMS = {"jobId": "some_job_id", "line": 0, "limit": 10000}
 
     EXPECTED_STDOUT_WITHOUT_PARAMETERS = """Usage: cli jobs logs [OPTIONS]
 Try "cli jobs logs --help" for help.
@@ -225,7 +226,7 @@ def test_should_send_valid_get_request_and_print_available_logs(self, get_patche
         get_patched.assert_called_with(self.URL,
                                        headers=self.EXPECTED_HEADERS_WITH_CHANGED_API_KEY,
                                        json=None,
-                                       params=None)
+                                       params=self.BASIC_COMMAND_PARAMS)
 
         assert result.output == self.EXPECTED_STDOUT
         assert result.exit_code == 0
@@ -240,7 +241,7 @@ def test_should_send_valid_get_request_when_log_list_was_used_with_wrong_api_key
         get_patched.assert_called_with(self.URL,
                                        headers=self.EXPECTED_HEADERS_WITH_CHANGED_API_KEY,
                                        json=None,
-                                       params=None)
+                                       params=self.BASIC_COMMAND_PARAMS)
         assert result.output == self.EXPECTED_STDOUT_WITH_WRONG_API_TOKEN
         assert result.exit_code == 0
 
@@ -254,7 +255,7 @@ def test_should_print_error_message_when_error_status_code_received_but_no_conte
         get_patched.assert_called_with(self.URL,
                                        headers=self.EXPECTED_HEADERS_WITH_CHANGED_API_KEY,
                                        json=None,
-                                       params=None)
+                                       params=self.BASIC_COMMAND_PARAMS)
         assert result.output == "Error while parsing response data: No JSON\n"
         assert result.exit_code == 0