Feature PS-9868:

Prepare logic for retrieving job logs

Author: MudlaffP

paperspace/cli/cli.py

@@ -6,6 +6,7 @@
 from paperspace import constants, client, config
 from paperspace.cli.common import api_key_option, del_if_value_is_none
 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.validators import validate_mutually_exclusive, validate_email
@@ -1054,3 +1055,4 @@ def version():
 
 cli.add_command(jobs_group)
 cli.add_command(projects_group)
+cli.add_command(logs_group)

paperspace/cli/logs.py

@@ -0,0 +1,23 @@
+import click
+
+from paperspace import client, config
+from paperspace.cli import common
+from paperspace.commands import logs as logs_commands
+
+
+@click.group("logs", help="Manage gradient logs")
+def logs_group():
+    pass
+
+
+@logs_group.command("list", help="List job logs")
+@click.option(
+    "--jobId",
+    "job_id",
+    required=True
+)
+@common.api_key_option
+def list_logs(job_id, api_key=None):
+    logs_api = client.API(config.CONFIG_LOG_HOST, api_key=api_key)
+    command = logs_commands.ListLogsCommand(api=logs_api)
+    command.execute(job_id)

paperspace/cli/types.py

@@ -17,4 +17,4 @@ def convert(self, value, param, ctx):
 
 def json_string(val):
     """Wraps json.loads so the cli help shows proper option's type name instead of 'LOADS'"""
-    return json.loads(val)
+    return json.loads(val)

paperspace/commands/logs.py

@@ -0,0 +1,30 @@
+from paperspace.commands import CommandBase
+
+
+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)
+            else:
+                msg = success_msg_template.format(**handle)
+                self.logger.log(msg)
+        else:
+            try:
+                data = response.json()
+                self.logger.log_error_response(data)
+            except ValueError:
+                self.logger.log(error_msg)
+
+
+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"
+        )