remotivelabs-cli 0.0.25__py3-none-any.whl → 0.0.26__py3-none-any.whl

cli/cloud/recordings_playback.py

@@ -3,20 +3,21 @@ from __future__ import annotations
 import datetime
 import json
 import os
+import sys
 import tempfile
 from pathlib import Path
-from typing import List, Union
+from typing import Any, List, Union
 
 import grpc
 import rich
 import typer
-from rich import print as rich_rprint
+from rich import print as rich_print
 from rich.progress import Progress, SpinnerColumn, TextColumn
 
 from cli.errors import ErrorPrinter
 
 from ..broker.lib.broker import Broker, SubscribableSignal
-from . import rest_helper as rest
+from .rest_helper import RestHelper as Rest
 
 app = typer.Typer(
     help="""
@@ -32,7 +33,7 @@ def play(
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
     show_progress: bool = typer.Option(False, help="Show progress after started playing"),
     repeat: bool = typer.Option(False, help="Repeat recording - must keep command running in terminal"),
-):
+) -> None:
     """
     Start playing a recording.
     There is no problem invoking play multiple times since if it is already playing the command will be ignored.
@@ -47,7 +48,7 @@ def pause(
     recording_session: str = typer.Argument(..., help="Recording session id", envvar="REMOTIVE_CLOUD_RECORDING_SESSION"),
     broker: str = typer.Option(None, help="Broker to use"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
-):
+) -> None:
     """
     Pause a recording
     """
@@ -59,7 +60,7 @@ def progress(
     recording_session: str = typer.Argument(..., help="Recording session id", envvar="REMOTIVE_CLOUD_RECORDING_SESSION"),
     broker: str = typer.Option(None, help="Broker to use"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
-):
+) -> None:
     """
     Shows progress of the recording playing.
     Use --repeat to have the recording replayed when it reaches the end.
@@ -73,7 +74,7 @@ def seek(
     seconds: int = typer.Option(..., min=0, help="Target offset in seconds"),
     broker: str = typer.Option(None, help="Broker to use"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
-):
+) -> None:
     """
     Seek seconds into a recording
     """
@@ -85,7 +86,7 @@ def stop(
     recording_session: str = typer.Argument(..., help="Recording session id", envvar="REMOTIVE_CLOUD_RECORDING_SESSION"),
     broker: str = typer.Option(None, help="Broker to use"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
-):
+) -> None:
     """
     Stop playing
     """
@@ -99,6 +100,7 @@ def read_scripted_code_file(file_path: Path) -> bytes:
         return file.read()
 
 
+# pylint: disable=R0913
 @app.command()
 def subscribe(
     recording_session: str = typer.Argument(..., help="Recording session id", envvar="REMOTIVE_CLOUD_RECORDING_SESSION"),
@@ -116,7 +118,7 @@ def subscribe(
     ),
     on_change_only: bool = typer.Option(default=False, help="Only get signal if value is changed"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
-):
+) -> None:
     """
     Allows you to subscribe to signals based on a mounted recording without knowing the broker URL.
     This simplifies when playing recordings from the cloud.
@@ -126,61 +128,66 @@ def subscribe(
     if script is None:
         if len(signal) == 0:
             ErrorPrinter.print_generic_error("You must use include at least one signal and one namespace or use script when subscribing")
-            exit(1)
+            sys.exit(1)
     if script is not None:
         if len(signal) > 0:
             ErrorPrinter.print_generic_error("You must must not specify --signal when using --script")
-            exit(1)
+            sys.exit(1)
 
     broker_client = _get_broker_info(project, recording_session, broker, "subscribe")
 
     try:
         if script is not None:
             script_src = read_scripted_code_file(script)
-            broker_client.subscribe_on_script(script_src, lambda sig: rich_rprint(json.dumps(list(sig))), on_change_only)
+            broker_client.subscribe_on_script(script_src, lambda sig: rich_print(json.dumps(list(sig))), on_change_only)
         else:
 
             def to_subscribable_signal(sig: str):
                 arr = sig.split(":")
                 if len(arr) != 2:
                     ErrorPrinter.print_hint(f"--signal must have format namespace:signal ({sig})")
-                    exit(1)
+                    sys.exit(1)
                 return SubscribableSignal(namespace=arr[0], name=arr[1])
 
             signals_to_subscribe_to = list(map(to_subscribable_signal, signal))
-            broker_client.long_name_subscribe(signals_to_subscribe_to, lambda sig: rich_rprint(json.dumps(list(sig))), on_change_only)
+            broker_client.long_name_subscribe(signals_to_subscribe_to, lambda sig: rich_print(json.dumps(list(sig))), on_change_only)
             print("Subscribing to signals, press Ctrl+C to exit")
     except grpc.RpcError as rpc_error:
         ErrorPrinter.print_grpc_error(rpc_error)
 
-    except Exception as e:
-        ErrorPrinter.print_generic_error(e)
-        exit(1)
+    except Exception as e:  # pylint: disable=W0718
+        ErrorPrinter.print_generic_error(str(e))
+        sys.exit(1)
 
 
-def _do_change_playback_mode(
+def _do_change_playback_mode(  # noqa: C901
     mode: str,
     recording_session: str,
-    broker: str,
+    brokerstr: str,
     project: str,
     seconds: int | None = None,
     progress_on_play: bool = False,
     repeat: bool = False,
-):  # noqa: C901
-    response = rest.handle_get(f"/api/project/{project}/files/recording/{recording_session}", return_response=True)
+) -> None:  # noqa: C901
+    # pylint: disable=R0913,R0912
+    response = Rest.handle_get(f"/api/project/{project}/files/recording/{recording_session}", return_response=True)
+    if response is None:
+        return
     r = json.loads(response.text)
-    recordings: list = r["recordings"]
+    recordings: List[Any] = r["recordings"]
     files = list(map(lambda rec: {"recording": rec["fileName"], "namespace": rec["metadata"]["namespace"]}, recordings))
 
-    broker_name = broker if broker is not None else "personal"
-    response = rest.handle_get(f"/api/project/{project}/brokers/{broker_name}", return_response=True, allow_status_codes=[404])
+    broker_name = brokerstr if brokerstr is not None else "personal"
+    response = Rest.handle_get(f"/api/project/{project}/brokers/{broker_name}", return_response=True, allow_status_codes=[404])
+    if response is None:
+        return
     if response.status_code == 404:
         broker_arg = ""
-        if broker is not None:
-            broker_arg = f" --broker {broker} --ensure-broker-started"
+        if brokerstr is not None:
+            broker_arg = f" --broker {brokerstr} --ensure-broker-started"
         ErrorPrinter.print_generic_error("You need to mount the recording before you play")
         ErrorPrinter.print_hint(f"remotive cloud recordings mount {recording_session}{broker_arg} --project {project}")
-        exit(1)
+        sys.exit(1)
 
     broker_info = json.loads(response.text)
     broker = Broker(broker_info["url"], None)
@@ -194,23 +201,26 @@ def _do_change_playback_mode(
         if progress_on_play or repeat:
             _track_progress(broker, repeat, files)
     elif mode == "seek":
-        broker.seek(files, int(seconds * 1000000), True)
+        if seconds is not None:
+            broker.seek(files, int(seconds * 1000000), True)
+        else:
+            broker.seek(files, 0, True)
     elif mode == "stop":
         broker.seek(files, 0, True)
     elif mode == "status":
         _track_progress(broker, repeat, files)
     else:
-        raise Exception(f"Illegal command {mode}")
+        raise ValueError(f"Illegal command {mode}")
 
 
-def _track_progress(broker: Broker, repeat: bool, files: List):
+def _track_progress(broker: Broker, repeat: bool, files: List[Any]) -> None:
     p = Progress(SpinnerColumn(), TextColumn("[progress.description]{task.description}"), transient=True)
     t = p.add_task("label", total=1)
     if repeat:
         rich.print(":point_right: Keep this command running in terminal to keep the recording play with repeat")
     with p:
 
-        def print_progress(offset: int, total: int, current_mode: str):
+        def print_progress(offset: int, total: int, current_mode: str) -> None:
             p.update(
                 t,
                 description=f"{(datetime.timedelta(seconds=offset))} " f"/ {(datetime.timedelta(seconds=total))} ({current_mode})",
@@ -219,14 +229,14 @@ def _track_progress(broker: Broker, repeat: bool, files: List):
         broker.listen_on_playback(repeat, files, print_progress)
 
 
-def _verify_recording_on_broker(broker: Broker, recording_session: str, mode: str, project: str):
+def _verify_recording_on_broker(broker: Broker, recording_session: str, mode: str, project: str) -> None:
     try:
         # Here we try to verify that we are operating on a recording that is mounted on the
         # broker so we can verify this before we try playback and can also present some good
         # error messages
         tmp = os.path.join(tempfile.gettempdir(), os.urandom(24).hex())
         broker.download(".cloud.context", tmp, True)
-        with open(tmp, "r") as f:
+        with open(tmp, "r", encoding="utf8") as f:
             json_context = json.loads(f.read())
             if json_context["recordingSessionId"] != recording_session:
                 ErrorPrinter.print_generic_error(
@@ -234,29 +244,32 @@ def _verify_recording_on_broker(broker: Broker, recording_session: str, mode: st
                     f"which not the same as you are trying to {mode}, use cmd below to mount this recording"
                 )
                 ErrorPrinter.print_hint(f"remotive cloud recordings mount {recording_session} --project {project}")
-                exit(1)
+                sys.exit(1)
     except grpc.RpcError as rpc_error:
-        if rpc_error.code() == grpc.StatusCode.NOT_FOUND:
+        if rpc_error.code() == grpc.StatusCode.NOT_FOUND:  # pylint: disable=no-member
             ErrorPrinter.print_generic_error(f"You must use mount to prepare a recording before you can use {mode}")
             ErrorPrinter.print_hint(f"remotive cloud recordings mount {recording_session} --project {project}")
         else:
             ErrorPrinter.print_grpc_error(rpc_error)
-        exit(1)
+        sys.exit(1)
 
 
 def _get_broker_info(project: str, recording_session: str, broker: Union[str, None], mode: str) -> Broker:
     # Verify it exists
-    rest.handle_get(f"/api/project/{project}/files/recording/{recording_session}", return_response=True)
+    Rest.handle_get(f"/api/project/{project}/files/recording/{recording_session}", return_response=True)
 
     broker_name = broker if broker is not None else "personal"
-    response = rest.handle_get(f"/api/project/{project}/brokers/{broker_name}", return_response=True, allow_status_codes=[404])
+    response = Rest.handle_get(f"/api/project/{project}/brokers/{broker_name}", return_response=True, allow_status_codes=[404])
+    if response is None:
+        ErrorPrinter.print_generic_error(f"No response from: /api/project/{project}/brokers/{broker_name}")
+        sys.exit(1)
     if response.status_code == 404:
         broker_arg = ""
         if broker is not None:
             broker_arg = f"--broker {broker} --ensure-broker-started"
         ErrorPrinter.print_generic_error("You need to mount the recording before you play")
         ErrorPrinter.print_hint(f"remotive cloud recordings mount {recording_session} {broker_arg} --project {project}")
-        exit(1)
+        sys.exit(1)
     broker_info = json.loads(response.text)
     broker_client = Broker(broker_info["url"], None)
     _verify_recording_on_broker(broker_client, recording_session, mode, project)