Paginate experiments list when table len exceeds height of terminal

Author: BartoszCki

paperspace/client.py

@@ -29,10 +29,10 @@ def put(self, url):
         logger.debug("Response content: {}".format(response.content))
         return response
 
-    def get(self, url):
+    def get(self, url, params=None):
         path = self.get_path(url)
         logger.debug("Sending GET to {}\nwith headers: {}".format(path, self.headers))
-        response = requests.get(path, headers=self.headers)
+        response = requests.get(path, params=params, headers=self.headers)
         logger.debug("Response status code: {}".format(response.status_code))
         logger.debug("Response content: {}".format(response.content))
         return response

paperspace/commands.py

@@ -1,7 +1,10 @@
+import pydoc
+
 import terminaltables
 
 from paperspace import version, logger, constants, client
 from paperspace.config import config
+from paperspace.utils import get_terminal_lines
 
 default_headers = {"X-API-Key": config.PAPERSPACE_API_KEY,
                    "ps_client_name": "paperspace-python",
@@ -76,7 +79,8 @@ def _make_experiments_list_table(experiments):
 
 
 def list_experiments(api=experiments_api):
-    response = api.get("/experiments/")
+    # TODO: change to limit: -1 when PS-9535 is deployed to production
+    response = api.get("/experiments/", params={"limit": 1000000})
     details = response.content
     if response.ok:
         try:
@@ -86,7 +90,10 @@ def list_experiments(api=experiments_api):
             logger.log("Error parsing response data")
             logger.debug(e)
 
-    _log_response(response, details, "Unknown error while retrieving list of experiments")
+    if response.ok and len(details.splitlines()) > get_terminal_lines():
+        pydoc.pager(details)
+    else:
+        _log_response(response, details, "Unknown error while retrieving list of experiments")
 
 
 def _make_details_table(experiment):

paperspace/utils.py

@@ -0,0 +1,10 @@
+import shutil
+
+import six
+
+
+def get_terminal_lines(fallback=48):
+    if six.PY3:
+        return shutil.get_terminal_size().lines
+
+    return fallback

tests/test_click_commands.py

@@ -12,13 +12,15 @@ def test_should_execute_create_experiment_command_when_cli_singlenode_command_wa
               "--projectHandle testHandle " \
               "--container testContainer " \
               "--machineType testType " \
-              "--command testCommand"
+              "--command testCommand " \
+              "--workspaceUrl wUrl"
     expected_kwargs = {"name": u"exp1",
                        "projectHandle": u"testHandle",
                        "container": u"testContainer",
                        "machineType": u"testType",
                        "command": u"testCommand",
                        "experimentTypeId": constants.ExperimentType.SINGLE_NODE,
+                       "workspaceUrl": "wUrl",
                        }
 
     result = runner.invoke(cli.cli, command.split())
@@ -41,7 +43,8 @@ def test_should_execute_create_experiment_command_when_cli_multinode_mpi_command
               "--parameterServerContainer testParameterServerContainer " \
               "--parameterServerMachineType testParameterServerMachineType " \
               "--parameterServerCommand testParameterServerCommand " \
-              "--parameterServerCount 3"
+              "--parameterServerCount 3 " \
+              "--workspaceUrl wUrl"
     expected_kwargs = {"name": u"exp1",
                        "projectHandle": u"testHandle",
                        "experimentTypeId": constants.ExperimentType.MPI_MULTI_NODE,
@@ -53,6 +56,7 @@ def test_should_execute_create_experiment_command_when_cli_multinode_mpi_command
                        "parameterServerMachineType": u"testParameterServerMachineType",
                        "parameterServerCommand": u"testParameterServerCommand",
                        "parameterServerCount": 3,
+                       "workspaceUrl": "wUrl",
                        }
 
     result = runner.invoke(cli.cli, command.split())
@@ -75,7 +79,8 @@ def test_should_execute_create_experiment_command_when_cli_multinode_grpc_comman
               "--parameterServerContainer testParameterServerContainer " \
               "--parameterServerMachineType testParameterServerMachineType " \
               "--parameterServerCommand testParameterServerCommand " \
-              "--parameterServerCount 3"
+              "--parameterServerCount 3 " \
+              "--workspaceUrl wUrl"
     expected_kwargs = {"name": u"exp1",
                        "projectHandle": u"testHandle",
                        "experimentTypeId": constants.ExperimentType.GRPC_MULTI_NODE,
@@ -87,6 +92,7 @@ def test_should_execute_create_experiment_command_when_cli_multinode_grpc_comman
                        "parameterServerMachineType": u"testParameterServerMachineType",
                        "parameterServerCommand": u"testParameterServerCommand",
                        "parameterServerCount": 3,
+                       "workspaceUrl": "wUrl",
                        }
 
     result = runner.invoke(cli.cli, command.split())
@@ -104,13 +110,15 @@ def test_should_execute_create_experiment_command_when_cli_create_and_start_sing
               "--projectHandle testHandle " \
               "--container testContainer " \
               "--machineType testType " \
-              "--command testCommand"
+              "--command testCommand " \
+              "--workspaceUrl wUrl"
     expected_kwargs = {"name": u"exp1",
                        "projectHandle": u"testHandle",
                        "container": u"testContainer",
                        "machineType": u"testType",
                        "command": u"testCommand",
                        "experimentTypeId": constants.ExperimentType.SINGLE_NODE,
+                       "workspaceUrl": "wUrl",
                        }
 
     result = runner.invoke(cli.cli, command.split())
@@ -134,7 +142,8 @@ def test_should_execute_create_experiment_command_when_cli_create_and_start_mult
               "--parameterServerContainer testParameterServerContainer " \
               "--parameterServerMachineType testParameterServerMachineType " \
               "--parameterServerCommand testParameterServerCommand " \
-              "--parameterServerCount 3"
+              "--parameterServerCount 3 " \
+              "--workspaceUrl wUrl"
     expected_kwargs = {"name": u"exp1",
                        "projectHandle": u"testHandle",
                        "experimentTypeId": constants.ExperimentType.MPI_MULTI_NODE,
@@ -146,6 +155,7 @@ def test_should_execute_create_experiment_command_when_cli_create_and_start_mult
                        "parameterServerMachineType": u"testParameterServerMachineType",
                        "parameterServerCommand": u"testParameterServerCommand",
                        "parameterServerCount": 3,
+                       "workspaceUrl": "wUrl",
                        }
 
     result = runner.invoke(cli.cli, command.split())

tests/test_experiments_functional.py

@@ -718,6 +718,19 @@ 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")
+    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}
+        get_patched.return_value = MockResponse(list_json, 200, "")
+
+        runner = CliRunner()
+        result = runner.invoke(cli.cli, self.COMMAND)
+
+        pydoc_patched.pager.assert_called_once()
+        assert result.exit_code == 0
+
 
 class TestStartExperiment(object):
     COMMAND = ["experiments", "start", "some-handle"]