Feature PS-9868:

Complete logic for retrieve logs for job.
Update project requirements.

Author: MudlaffP

Pipfile

@@ -13,6 +13,7 @@ six = "*"
 gradient-statsd = "*"
 click = "*"
 terminaltables = "*"
+colorclass = "*"
 
 [dev-packages]
 twine = "*"

Pipfile.lock

@@ -8,7 +8,7 @@
 from paperspace.cli.jobs import jobs_group
 from paperspace.cli.logs import logs_group
 from paperspace.cli.projects import projects_group
-from paperspace.cli.types import ChoiceType, json_string
+from paperspace.cli.cli_types import ChoiceType, json_string
 from paperspace.cli.validators import validate_mutually_exclusive, validate_email
 from paperspace.commands import experiments as experiments_commands, deployments as deployments_commands, \
     machines as machines_commands, login as login_commands
@@ -1056,3 +1056,7 @@ def version():
 cli.add_command(jobs_group)
 cli.add_command(projects_group)
 cli.add_command(logs_group)
+
+
+if __name__ == '__main__':
+    cli()

paperspace/cli/cli.py

@@ -1,30 +1,59 @@
+import pydoc
+
+import terminaltables
+from colorclass import Color
+
 from paperspace.commands import CommandBase
+from paperspace.utils import get_terminal_lines
+
+
+class ListLogsCommand(CommandBase):
+    last_line_number = 0
+    base_url = "/jobs/logs?jobId={}&line={}"
 
+    is_logs_complete = False
+
+    def execute(self, job_id):
+        table_data = [("LINE", "MESSAGE")]
+        table = terminaltables.AsciiTable(table_data, title=f"Job {job_id} logs")
+
+        while not self.is_logs_complete:
+            response = self._get_logs(job_id)
 
-class LogsCommandBase(CommandBase):
-    def _log_message(self, response, success_msg_template, error_msg):
-        if response.ok:
             try:
-                handle = response.json()
-            except (ValueError, KeyError):
-                self.logger.log(success_msg_template)
+                data = response.json()
+                if not response.ok:
+                    self.logger.log_error_response(data)
+                    return
+            except (ValueError, KeyError) as e:
+                if response.status_code == 204:
+                    continue
+                self.logger.log("Error while parsing response data: {}".format(e))
+                return
             else:
-                msg = success_msg_template.format(**handle)
-                self.logger.log(msg)
+                self._log_logs_list(data, table, table_data)
+
+    def _get_logs(self, job_id):
+        url = self.base_url.format(job_id, self.last_line_number)
+        return self.api.get(url)
+
+    def _log_logs_list(self, data, table, table_data):
+        if not data:
+            self.logger.log("No Logs found")
         else:
-            try:
-                data = response.json()
-                self.logger.log_error_response(data)
-            except ValueError:
-                self.logger.log(error_msg)
+            table_str = self._make_table(data, table, table_data)
+            if len(table_str.splitlines()) > get_terminal_lines():
+                pydoc.pager(table_str)
+            else:
+                self.logger.log(table_str)
+
+    def _make_table(self, logs, table, table_data):
+        if logs[-1].get("message") == "PSEOF":
+            self.is_logs_complete = True
+        else:
+            self.last_line_number = logs[-1].get("line")
 
+        for log in logs:
+            table_data.append((Color.colorize("red", log.get("line")), log.get("message")))
 
-class ListLogsCommand(LogsCommandBase):
-    def execute(self, job_id):
-        url = f"/jobs/logs?jobId={job_id}"
-        response = self.api.get(url)
-        self._log_message(
-            response,
-            "Job logs retrieved",
-            "Unknown error while retrieving job logs"
-        )
+        return table.table

paperspace/cli/types.py paperspace/cli/cli_types.pypaperspace/cli/types.py renamed to paperspace/cli/cli_types.py

@@ -40,7 +40,9 @@
     ],
     keywords='paperspace api development library',
     packages=find_packages(exclude=['contrib', 'docs', 'tests', 'old_tests']),
-    install_requires=['requests[security]', 'boto3', 'botocore', 'six', 'gradient-statsd', 'click', 'terminaltables'],
+    install_requires=[
+        'requests[security]', 'boto3', 'botocore', 'six', 'gradient-statsd', 'click', 'terminaltables', 'colorclass'
+    ],
     entry_points={'console_scripts': [
         'paperspace-python = paperspace.main:main',
     ]},