Commands moved to submodule

Author: BartoszCki

paperspace/cli.py

@@ -3,7 +3,8 @@
 
 import click
 
-from paperspace import commands, constants
+from paperspace import constants
+from paperspace.commands import experiments as experiments_commands
 
 
 class ChoiceType(click.Choice):
@@ -41,7 +42,7 @@ def cli():
     pass
 
 
-@cli.group()
+@cli.group("experiments")
 def experiments():
     pass
 
@@ -230,7 +231,7 @@ def common_experiments_create_single_node_options(f):
 @common_experiment_create_multi_node_options
 def create_multi_node(**kwargs):
     del_if_value_is_none(kwargs)
-    commands.create_experiment(kwargs)
+    experiments_commands.create_experiment(kwargs)
 
 
 @create.command(name="singlenode")
@@ -239,15 +240,15 @@ def create_multi_node(**kwargs):
 def create_single_node(**kwargs):
     kwargs["experimentTypeId"] = constants.ExperimentType.SINGLE_NODE
     del_if_value_is_none(kwargs)
-    commands.create_experiment(kwargs)
+    experiments_commands.create_experiment(kwargs)
 
 
 @create_and_start.command(name="multinode")
 @common_experiments_create_options
 @common_experiment_create_multi_node_options
 def create_and_start_multi_node(**kwargs):
     del_if_value_is_none(kwargs)
-    commands.create_and_start_experiment(kwargs)
+    experiments_commands.create_and_start_experiment(kwargs)
 
 
 @create_and_start.command(name="singlenode")
@@ -256,32 +257,32 @@ def create_and_start_multi_node(**kwargs):
 def create_and_start_single_node(**kwargs):
     kwargs["experimentTypeId"] = constants.ExperimentType.SINGLE_NODE
     del_if_value_is_none(kwargs)
-    commands.create_and_start_experiment(kwargs)
+    experiments_commands.create_and_start_experiment(kwargs)
 
 
 @experiments.command()
 @click.argument("experiment-handle")
 def start(experiment_handle):
-    commands.start_experiment(experiment_handle)
+    experiments_commands.start_experiment(experiment_handle)
 
 
 @experiments.command()
 @click.argument("experiment-handle")
 def stop(experiment_handle):
-    commands.stop_experiment(experiment_handle)
+    experiments_commands.stop_experiment(experiment_handle)
 
 
-@click.option("--projectHandle", "-p", "project_handles", multiple=True)
 @experiments.command("list")
+@click.option("--projectHandle", "-p", "project_handles", multiple=True)
 def list_experiments(project_handles):
-    command = commands.ListExperimentsCommand()
+    command = experiments_commands.ListExperimentsCommand()
     command.execute(project_handles)
 
 
 @experiments.command("details")
 @click.argument("experiment-handle")
 def get_experiment_details(experiment_handle):
-    commands.get_experiment_details(experiment_handle)
+    experiments_commands.get_experiment_details(experiment_handle)
 
 # TODO: delete experiment - not implemented in the api
 # TODO: modify experiment - not implemented in the api

paperspace/commands/__init__.py

@@ -2,28 +2,16 @@
 
 import terminaltables
 
-from paperspace import version, logger, constants, client
-from paperspace.config import config
+from paperspace import config, version, client, logger, constants
+from paperspace.logger import log_response
 from paperspace.utils import get_terminal_lines
 
 default_headers = {"X-API-Key": config.PAPERSPACE_API_KEY,
                    "ps_client_name": "paperspace-python",
                    "ps_client_version": version.version}
-
 experiments_api = client.API(config.CONFIG_EXPERIMENTS_HOST, headers=default_headers)
 
 
-def _log_response(response, success_msg, error_msg, logger_=logger):
-    if response.ok:
-        logger_.log(success_msg)
-    else:
-        try:
-            data = response.json()
-            logger_.log_error_response(data)
-        except ValueError:
-            logger_.log(error_msg)
-
-
 def _log_create_experiment(response, success_msg_template, error_msg, logger_=logger):
     if response.ok:
         j = response.json()
@@ -56,13 +44,13 @@ def create_and_start_experiment(json_, api=experiments_api):
 def start_experiment(experiment_handle, api=experiments_api):
     url = "/experiments/{}/start/".format(experiment_handle)
     response = api.put(url)
-    _log_response(response, "Experiment started", "Unknown error while starting the experiment")
+    log_response(response, "Experiment started", "Unknown error while starting the experiment")
 
 
 def stop_experiment(experiment_handle, api=experiments_api):
     url = "/experiments/{}/stop/".format(experiment_handle)
     response = api.put(url)
-    _log_response(response, "Experiment stopped", "Unknown error while stopping the experiment")
+    log_response(response, "Experiment stopped", "Unknown error while stopping the experiment")
 
 
 class ListExperimentsCommand(object):
@@ -195,4 +183,4 @@ def get_experiment_details(experiment_handle, api=experiments_api):
             logger.log("Error parsing response data")
             logger.debug(e)
 
-    _log_response(response, details, "Unknown error while retrieving details of the experiment")
+    log_response(response, details, "Unknown error while retrieving details of the experiment")

paperspace/commands.py renamed to paperspace/commands/experiments.py

@@ -39,3 +39,14 @@ def log_error_response(data):
 def debug(messages):
     if config.DEBUG:
         log("DEBUG: {}".format(messages))
+
+
+def log_response(response, success_msg, error_msg):
+    if response.ok:
+        log(success_msg)
+    else:
+        try:
+            data = response.json()
+            log_error_response(data)
+        except ValueError:
+            log(error_msg)

paperspace/logger.py

@@ -4,7 +4,7 @@
 from paperspace import cli, constants
 
 
-@mock.patch("paperspace.cli.commands")
+@mock.patch("paperspace.cli.experiments_commands")
 def test_should_execute_create_experiment_command_when_cli_singlenode_command_was_executed(commands_patched):
     runner = CliRunner()
     command = "experiments create singlenode " \
@@ -29,7 +29,7 @@ def test_should_execute_create_experiment_command_when_cli_singlenode_command_wa
     commands_patched.create_experiment.assert_called_once_with(expected_kwargs)
 
 
-@mock.patch("paperspace.cli.commands")
+@mock.patch("paperspace.cli.experiments_commands")
 def test_should_execute_create_experiment_command_when_cli_multinode_mpi_command_was_executed(commands_patched):
     runner = CliRunner()
     command = "experiments create multinode " \
@@ -65,7 +65,7 @@ def test_should_execute_create_experiment_command_when_cli_multinode_mpi_command
     commands_patched.create_experiment.assert_called_once_with(expected_kwargs)
 
 
-@mock.patch("paperspace.cli.commands")
+@mock.patch("paperspace.cli.experiments_commands")
 def test_should_execute_create_experiment_command_when_cli_multinode_grpc_command_was_executed(commands_patched):
     runner = CliRunner()
     command = "experiments create multinode " \
@@ -101,7 +101,7 @@ def test_should_execute_create_experiment_command_when_cli_multinode_grpc_comman
     commands_patched.create_experiment.assert_called_once_with(expected_kwargs)
 
 
-@mock.patch("paperspace.cli.commands")
+@mock.patch("paperspace.cli.experiments_commands")
 def test_should_execute_create_experiment_command_when_cli_create_and_start_singlenode_command_was_executed(
         commands_patched):
     runner = CliRunner()
@@ -127,7 +127,7 @@ def test_should_execute_create_experiment_command_when_cli_create_and_start_sing
     commands_patched.create_and_start_experiment.assert_called_once_with(expected_kwargs)
 
 
-@mock.patch("paperspace.cli.commands")
+@mock.patch("paperspace.cli.experiments_commands")
 def test_should_execute_create_experiment_command_when_cli_create_and_start_multinode_mpi_command_was_executed(
         commands_patched):
     runner = CliRunner()

tests/test_click_commands.py

@@ -1,7 +1,8 @@
 import mock
 from click.testing import CliRunner
 
-from paperspace import cli, constants, commands
+from paperspace import cli, constants
+from paperspace.commands import experiments as experiments_commands
 from tests import example_responses
 
 
@@ -22,7 +23,7 @@ def json(self):
 
 class TestExperimentsCreateSingleNode(object):
     URL = "https://services.paperspace.io/experiments/v1/experiments/"
-    EXPECTED_HEADERS = commands.default_headers
+    EXPECTED_HEADERS = experiments_commands.default_headers
     BASIC_OPTIONS_COMMAND = [
         "experiments", "create", "singlenode",
         "--name", "exp1",
@@ -87,7 +88,7 @@ class TestExperimentsCreateSingleNode(object):
     RESPONSE_CONTENT_404_PROJECT_NOT_FOUND = b'{"details":{"handle":"wrong_handle"},"error":"Project not found"}\n'
     EXPECTED_STDOUT_PROJECT_NOT_FOUND = "Project not found\nhandle: wrong_handle\n"
 
-    @mock.patch("paperspace.cli.commands.client.requests.post")
+    @mock.patch("paperspace.cli.experiments_commands.client.requests.post")
     def test_should_send_proper_data_and_print_message_when_create_experiment_was_run_with_basic_options(self,
                                                                                                          post_patched):
         post_patched.return_value = MockResponse(self.RESPONSE_JSON_200, 200, self.RESPONSE_CONTENT_200)
@@ -102,7 +103,7 @@ def test_should_send_proper_data_and_print_message_when_create_experiment_was_ru
         assert result.output == self.EXPECTED_STDOUT
         assert result.exit_code == 0
 
-    @mock.patch("paperspace.cli.commands.client.requests.post")
+    @mock.patch("paperspace.cli.experiments_commands.client.requests.post")
     def test_should_send_proper_data_and_print_message_when_create_experiment_was_run_with_full_options(self,
                                                                                                         post_patched):
         post_patched.return_value = MockResponse(self.RESPONSE_JSON_200, 200, self.RESPONSE_CONTENT_200)
@@ -117,7 +118,7 @@ def test_should_send_proper_data_and_print_message_when_create_experiment_was_ru
         assert result.output == self.EXPECTED_STDOUT
         assert result.exit_code == 0
 
-    @mock.patch("paperspace.cli.commands.client.requests.post")
+    @mock.patch("paperspace.cli.experiments_commands.client.requests.post")
     def test_should_send_proper_data_and_print_message_when_create_wrong_project_handle_was_given(self, post_patched):
         post_patched.return_value = MockResponse(self.RESPONSE_JSON_404_PROJECT_NOT_FOUND, 404,
                                                  self.RESPONSE_CONTENT_404_PROJECT_NOT_FOUND)
@@ -135,7 +136,7 @@ def test_should_send_proper_data_and_print_message_when_create_wrong_project_han
 
 class TestExperimentsCreateMultiNode(object):
     URL = "https://services.paperspace.io/experiments/v1/experiments/"
-    EXPECTED_HEADERS = commands.default_headers
+    EXPECTED_HEADERS = experiments_commands.default_headers
     BASIC_OPTIONS_COMMAND = [
         "experiments", "create", "multinode",
         "--name", "multinode_mpi",
@@ -226,7 +227,7 @@ class TestExperimentsCreateMultiNode(object):
     RESPONSE_CONTENT_200 = b'{"handle":"sadkfhlskdjh","message":"success"}\n'
     EXPECTED_STDOUT = "New experiment created with handle: sadkfhlskdjh\n"
 
-    @mock.patch("paperspace.cli.commands.client.requests.post")
+    @mock.patch("paperspace.cli.experiments_commands.client.requests.post")
     def test_should_send_proper_data_and_print_message_when_create_experiment_was_run_with_basic_options(self,
                                                                                                          post_patched):
         post_patched.return_value = MockResponse(self.RESPONSE_JSON_200, 200, self.RESPONSE_CONTENT_200)
@@ -241,7 +242,7 @@ def test_should_send_proper_data_and_print_message_when_create_experiment_was_ru
         assert result.output == self.EXPECTED_STDOUT
         assert result.exit_code == 0
 
-    @mock.patch("paperspace.cli.commands.client.requests.post")
+    @mock.patch("paperspace.cli.experiments_commands.client.requests.post")
     def test_should_send_proper_data_and_print_message_when_create_experiment_was_run_with_full_options(self,
                                                                                                         post_patched):
         post_patched.return_value = MockResponse(self.RESPONSE_JSON_200, 200, self.RESPONSE_CONTENT_200)
@@ -505,7 +506,7 @@ class TestExperimentDetail(object):
 +---------------------+----------------+
 """
 
-    @mock.patch("paperspace.cli.commands.client.requests.get")
+    @mock.patch("paperspace.cli.experiments_commands.client.requests.get")
     def test_should_send_get_request_and_print_single_node_experiment_details_in_a_table(self, get_patched):
         get_patched.return_value = MockResponse(self.SINGLE_NODE_RESPONSE_JSON, 200, "fake content")
 
@@ -515,7 +516,7 @@ def test_should_send_get_request_and_print_single_node_experiment_details_in_a_t
         assert result.output == self.SINGLE_NODE_DETAILS_STDOUT
         assert result.exit_code == 0
 
-    @mock.patch("paperspace.cli.commands.client.requests.get")
+    @mock.patch("paperspace.cli.experiments_commands.client.requests.get")
     def test_should_send_get_request_and_print_multi_node_experiment_details_in_a_table(self, get_patched):
         get_patched.return_value = MockResponse(self.MULTI_NODE_DETAILS_JSON, 200, "fake content")
 
@@ -525,7 +526,7 @@ def test_should_send_get_request_and_print_multi_node_experiment_details_in_a_ta
         assert result.output == self.MULTI_NODE_DETAILS_STDOUT
         assert result.exit_code == 0
 
-    @mock.patch("paperspace.cli.commands.client.requests.get")
+    @mock.patch("paperspace.cli.experiments_commands.client.requests.get")
     def test_should_send_get_request_and_print_request_content_when_response_data_was_malformed(self, get_patched):
         get_patched.return_value = MockResponse({}, 200, "fake content")
         g = """Error parsing response data
@@ -715,7 +716,7 @@ class TestExperimentList(object):
 +---------------+---------------+---------+
 """
 
-    @mock.patch("paperspace.cli.commands.client.requests.get")
+    @mock.patch("paperspace.cli.experiments_commands.client.requests.get")
     def test_should_send_get_request_and_print_list_of_experiments(self, get_patched):
         get_patched.return_value = MockResponse(self.LIST_JSON, 200, "fake content")
 
@@ -724,8 +725,8 @@ def test_should_send_get_request_and_print_list_of_experiments(self, get_patched
 
         assert result.output == self.DETAILS_STDOUT
 
-    @mock.patch("paperspace.cli.commands.pydoc")
-    @mock.patch("paperspace.cli.commands.client.requests.get")
+    @mock.patch("paperspace.cli.experiments_commands.pydoc")
+    @mock.patch("paperspace.cli.experiments_commands.client.requests.get")
     def test_should_send_get_request_and_paginate_list_when_output_table_len_is_gt_lines_in_terminal(self, get_patched,
                                                                                                      pydoc_patched):
         list_json = {"data": self.LIST_JSON["data"] * 40}
@@ -737,7 +738,7 @@ def test_should_send_get_request_and_paginate_list_when_output_table_len_is_gt_l
         pydoc_patched.pager.assert_called_once()
         assert result.exit_code == 0
 
-    @mock.patch("paperspace.cli.commands.client.requests.get")
+    @mock.patch("paperspace.cli.experiments_commands.client.requests.get")
     def test_should_send_get_request_and_print_list_of_experiments_filtered_with_two_projects(self, get_patched):
         get_patched.return_value = MockResponse(example_responses.LIST_OF_EXPERIMENTS_FILTERED_WITH_TWO_PROJECTS, 200,
                                                 "fake content")
@@ -747,7 +748,7 @@ def test_should_send_get_request_and_print_list_of_experiments_filtered_with_two
 
         assert result.output == example_responses.LIST_OF_EXPERIMENTS_FILTERED_WITH_TWO_PROJECTS_STDOUT
 
-    @mock.patch("paperspace.cli.commands.client.requests.get")
+    @mock.patch("paperspace.cli.experiments_commands.client.requests.get")
     def test_should_send_get_request_and_print_list_of_experiments_filtered_with_two_projects_but_none_found(
             self, get_patched):
         get_patched.return_value = MockResponse(example_responses.LIST_OF_EXPERIMENTS_FILTERED_BUT_NONE_FOUND, 200,
@@ -764,7 +765,7 @@ class TestStartExperiment(object):
     RESPONSE_JSON = {"message": "success"}
     START_STDOUT = "Experiment started\n"
 
-    @mock.patch("paperspace.cli.commands.client.requests.put")
+    @mock.patch("paperspace.cli.experiments_commands.client.requests.put")
     def test_should_send_put_request_and_print_confirmation(self, put_patched):
         put_patched.return_value = MockResponse(self.RESPONSE_JSON, 200, "fake content")