Add filtering models by project ID and fix message when wrong api key was used

Author: BartoszCki

paperspace/cli/models.py

@@ -16,6 +16,11 @@ def models_group():
     "experimentId",
     help="Use to filter jobs by experiment ID",
 )
+@click.option(
+    "--projectId",
+    "projectId",
+    help="Use to filter jobs by project ID",
+)
 @common.api_key_option
 def list_jobs(api_key, **filters):
     common.del_if_value_is_none(filters)

paperspace/commands/models.py

@@ -14,19 +14,22 @@ def execute(self, filters):
         response = self.api.get("/mlModels/getModelList/", json=json_, params=params)
 
         try:
-            models = self._get_models_list(response)
+            data = response.json()
+            if not response.ok:
+                self.logger.log_error_response(data)
+                return
+            models = data["modelList"]
         except (ValueError, KeyError) as e:
             self.logger.log("Error while parsing response data: {}".format(e))
         else:
             self._log_models_list(models)
 
     @staticmethod
     def _get_request_json(filters):
-        experiment_id = filters.get("experimentId")
-        if not experiment_id:
+        if not filters:
             return None
 
-        json_ = {"filter": {"where": {"and": [{"experimentId": experiment_id}]}}}
+        json_ = {"filter": {"where": {"and": [filters]}}}
         return json_
 
     def _get_models_list(self, response):
@@ -37,11 +40,11 @@ def _get_models_list(self, response):
         self.logger.debug(data)
         return data
 
-    def _log_models_list(self, model):
-        if not model:
+    def _log_models_list(self, models):
+        if not models:
             self.logger.log("No models found")
         else:
-            table_str = self._make_models_list_table(model)
+            table_str = self._make_models_list_table(models)
             if len(table_str.splitlines()) > get_terminal_lines():
                 pydoc.pager(table_str)
             else:

tests/functional/test_models.py

@@ -30,6 +30,8 @@ class TestModelsList(object):
 +------+-----------------+------------+------------+---------------+
 """
 
+    EXPECTED_RESPONSE_WHEN_WRONG_API_KEY_WAS_USED = {"status": 401, "message": "No such API token"}
+
     @mock.patch("paperspace.cli.cli.client.requests.get")
     def test_should_send_get_request_and_print_list_of_experiments(self, get_patched):
         get_patched.return_value = MockResponse(example_responses.LIST_MODELS_RESPONSE_JSON, 200, "fake content")
@@ -88,3 +90,17 @@ def test_should_send_get_request_and_print_proper_message_when_no_models_were_fo
                                             params={"limit": -1})
 
         assert result.output == "No models found\n"
+
+    @mock.patch("paperspace.cli.cli.client.requests.get")
+    def test_should_print_proper_message_when_wrong_api_key_was_used(self, get_patched):
+        get_patched.return_value = MockResponse(self.EXPECTED_RESPONSE_WHEN_WRONG_API_KEY_WAS_USED, 401)
+
+        runner = CliRunner()
+        result = runner.invoke(cli.cli, self.COMMAND)
+
+        get_patched.assert_called_once_with(self.URL,
+                                            headers=self.EXPECTED_HEADERS,
+                                            json=None,
+                                            params={"limit": -1})
+
+        assert result.output == "No such API token\n"