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

cli/broker/playback.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import List
+from typing import Dict, List
 
 import grpc
 import typer
@@ -9,7 +9,15 @@ from cli.errors import ErrorPrinter
 
 from .lib.broker import Broker
 
-app = typer.Typer(help=help)
+app = typer.Typer(help=help)  # type: ignore
+
+
+def recording_and_namespace(recording: str) -> Dict[str, str]:
+    splitted = recording.split("::")
+    if len(splitted) != 2:
+        print("Invalid --recording option, expected file_name::namespace")
+        raise typer.Exit(1)
+    return {"recording": splitted[0], "namespace": splitted[1]}
 
 
 @app.command()
@@ -17,7 +25,7 @@ def play(
     recording: List[str] = typer.Option(..., help="Which recording and which namespace to play"),
     url: str = typer.Option(..., help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
     api_key: str = typer.Option("offline", help="Cloud Broker API-KEY or access token", envvar="REMOTIVE_BROKER_API_KEY"),
-):
+) -> None:
     """
     Play recording files on broker.
 
@@ -26,13 +34,6 @@ def play(
     remotive broker playback play --recording myrecording_can0::can0 --recording myrecording_can1::can1
     """
 
-    def recording_and_namespace(recording: str):
-        splitted = recording.split("::")
-        if len(splitted) != 2:
-            print("Invalid --recording option, expected file_name::namespace")
-            raise typer.Exit(1)
-        return {"recording": splitted[0], "namespace": splitted[1]}
-
     rec = list(map(recording_and_namespace, recording))
     try:
         broker = Broker(url, api_key)
@@ -48,7 +49,7 @@ def stop(
     recording: List[str] = typer.Option(..., help="Which recording and which namespace to stop"),
     url: str = typer.Option(..., help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
     api_key: str = typer.Option("offline", help="Cloud Broker API-KEY or access token", envvar="REMOTIVE_BROKER_API_KEY"),
-):
+) -> None:
     """
     Stop recordings that are beeing played on brokers are done with the same syntax as when you start them.
 
@@ -57,13 +58,6 @@ def stop(
     remotive broker playback stop --recording myrecording_can0::can0 --recording myrecording_can1::can1
     """
 
-    def recording_and_namespace(recording: str):
-        splitted = recording.split("::")
-        if len(splitted) != 2:
-            print("Invalid --recording option, expected file_name::namespace")
-            raise typer.Exit(1)
-        return {"recording": splitted[0], "namespace": splitted[1]}
-
     rec = list(map(recording_and_namespace, recording))
 
     try:
@@ -79,7 +73,7 @@ def pause(
     recording: List[str] = typer.Option(..., help="Which recording and which namespace to stop"),
     url: str = typer.Option(..., help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
     api_key: str = typer.Option("offline", help="Cloud Broker API-KEY or access token", envvar="REMOTIVE_BROKER_API_KEY"),
-):
+) -> None:
     """
     Pause recordings that are beeing played on brokers are done with the same syntax as when you start them.
 
@@ -88,13 +82,6 @@ def pause(
     remotive broker playback pause --recording myrecording_can0::can0 --recording myrecording_can1::can1
     """
 
-    def recording_and_namespace(recording: str):
-        splitted = recording.split("::")
-        if len(splitted) != 2:
-            print("Invalid --recording option, expected file_name::namespace")
-            raise typer.Exit(1)
-        return {"recording": splitted[0], "namespace": splitted[1]}
-
     rec = list(map(recording_and_namespace, recording))
     try:
         broker = Broker(url, api_key)
@@ -110,7 +97,7 @@ def seek(
     seconds: float = typer.Option(..., help="Target offset in seconds"),
     url: str = typer.Option(..., help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
     api_key: str = typer.Option("offline", help="Cloud Broker API-KEY or access token", envvar="REMOTIVE_BROKER_API_KEY"),
-):
+) -> None:
     """
     Seeks to a position in seconds into the recording
 
@@ -121,13 +108,6 @@ def seek(
 
     broker = Broker(url, api_key)
 
-    def recording_and_namespace(recording: str):
-        splitted = recording.split("::")
-        if len(splitted) != 2:
-            print("Invalid --recording option, expected file_name::namespace")
-            raise typer.Exit(1)
-        return {"recording": splitted[0], "namespace": splitted[1]}
-
     rec = list(map(recording_and_namespace, recording))
 
     try:

cli/broker/record.py

@@ -9,7 +9,7 @@ from cli.errors import ErrorPrinter
 
 from .lib.broker import Broker
 
-app = typer.Typer(help=help)
+app = typer.Typer(help=help)  # type: ignore
 
 
 @app.command()
@@ -18,7 +18,7 @@ def start(
     namespace: List[str] = typer.Option(..., help="Namespace to record"),
     url: str = typer.Option(..., help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
     api_key: str = typer.Option("offline", help="Cloud Broker API-KEY or access token", envvar="REMOTIVE_BROKER_API_KEY"),
-):
+) -> None:
     try:
         broker = Broker(url, api_key)
         broker.record_multiple(namespace, filename)
@@ -32,7 +32,7 @@ def stop(
     namespace: List[str] = typer.Option(..., help="Namespace to record"),
     url: str = typer.Option(..., help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
     api_key: str = typer.Option("offline", help="Cloud Broker API-KEY or access token", envvar="REMOTIVE_BROKER_API_KEY"),
-):
+) -> None:
     try:
         broker = Broker(url, api_key)
         broker.stop_multiple(namespace, filename)

cli/broker/scripting.py

@@ -16,7 +16,7 @@ app = typer.Typer(
 )
 
 
-def write(signal_name, script):
+def write(signal_name: str, script: str) -> None:
     path = f"{signal_name}.lua"
     f = open(path, "w")
     f.write(script)
@@ -29,7 +29,7 @@ def new_script(
     input_signal: List[str] = typer.Option(..., help="Required input signal names"),
     output_signal: str = typer.Option(..., help="Name of output signal"),
     save: bool = typer.Option(False, help="Save file to disk - Default stored as __output_signal__.lua"),
-):
+) -> None:
     def to_subscribable_signal(sig: str) -> tuple[str, str]:
         arr = sig.split(":")
         if len(arr) != 2:
@@ -39,7 +39,7 @@ def new_script(
 
     signals_to_subscribe_to = list(map(to_subscribable_signal, input_signal))
 
-    def to_local_signal(sig_name: tuple[str, str]):
+    def to_local_signal(sig_name: tuple[str, str]) -> str:
         t = Template(
             """
     {
@@ -51,7 +51,7 @@ def new_script(
 
     local_signals = ",".join(list(map(to_local_signal, signals_to_subscribe_to)))
 
-    def to_subscribe_pattern(sig_name: tuple[str, str]):
+    def to_subscribe_pattern(sig_name: tuple[str, str]) -> str:
         t = Template(
             """
     if (signals["$sig_name"] ~= nil) then

cli/broker/signals.py

@@ -5,10 +5,10 @@ import numbers
 import os
 import signal as os_signal
 from pathlib import Path
-from typing import List, TypedDict
+from typing import Any, Dict, Iterable, List, TypedDict
 
 import grpc
-import plotext as plt
+import plotext as plt  # type: ignore
 import typer
 from rich import print as rich_rprint
 
@@ -16,7 +16,7 @@ from cli.errors import ErrorPrinter
 
 from .lib.broker import Broker, SubscribableSignal
 
-app = typer.Typer(help=help)
+app = typer.Typer(help=help)  # type: ignore
 
 
 # signal_values:list = list()
@@ -24,17 +24,25 @@ app = typer.Typer(help=help)
 
 class Signals(TypedDict):
     name: str
-    signals: List
+    signals: List[Any]
 
 
-signal_values = {}
+signal_values: Dict[Any, Any] = {}
 
 
-@app.command(help="List signals names on broker")
+@app.command(name="list", help="List frame and signal metadata on broker")
+def list_signals(
+    url: str = typer.Option(..., help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
+    api_key: str = typer.Option(None, help="Cloud Broker API-KEY or access token", envvar="REMOTIVE_BROKER_API_KEY"),
+) -> None:
+    signal_names(url, api_key)
+
+
+@app.command(help="List signals names on broker", deprecated=True)
 def signal_names(
     url: str = typer.Option(..., help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
     api_key: str = typer.Option(None, help="Cloud Broker API-KEY or access token", envvar="REMOTIVE_BROKER_API_KEY"),
-):
+) -> None:
     try:
         broker = Broker(url, api_key)
         # print("Listing available signals")
@@ -73,7 +81,7 @@ def subscribe(  # noqa: C901
     x_plot: bool = typer.Option(default=False, help="Experimental: Plot the signal in terminal. Note graphs are not " "aligned by time"),
     x_plot_size: int = typer.Option(default=100, help="Experimental: how many points show for each plot"),
     # samples: int = typer.Option(default=0, he)
-):
+) -> None:
     """
     Subscribe to a selection of signals
 
@@ -100,10 +108,10 @@ def subscribe(  # noqa: C901
 
     plt.title("Signals")
 
-    def exit_on_ctrlc(sig, frame):
+    def exit_on_ctrlc(sig: Any, frame: Any) -> None:
         os._exit(0)
 
-    def on_frame_plot(x):
+    def on_frame_plot(x: Iterable[Any]) -> None:
         global signal_values
 
         plt.clt()  # to clear the terminal
@@ -144,7 +152,7 @@ def subscribe(  # noqa: C901
         plt.sleep(0.001)  # to add
         plt.show()
 
-    def on_frame_print(x):
+    def on_frame_print(x: Iterable[Any]) -> None:
         rich_rprint(json.dumps(list(x)))
 
     os_signal.signal(os_signal.SIGINT, exit_on_ctrlc)
@@ -181,7 +189,7 @@ def subscribe(  # noqa: C901
 def namespaces(
     url: str = typer.Option(..., help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
     api_key: str = typer.Option(None, help="Cloud Broker API-KEY or access token", envvar="REMOTIVE_BROKER_API_KEY"),
-):
+) -> None:
     try:
         broker = Broker(url, api_key)
         namespaces_json = broker.list_namespaces()

cli/cloud/__init__.py

@@ -1 +0,0 @@
-

cli/cloud/auth.py

@@ -4,29 +4,33 @@ import webbrowser
 from http.server import BaseHTTPRequestHandler, HTTPServer
 from pathlib import Path
 from threading import Thread
+from typing import Any
 
 import typer
+from typing_extensions import override
 
 from cli import settings
 
 from . import auth_tokens
-from . import rest_helper as rest
+from .rest_helper import RestHelper as Rest
 
-apa = settings.config_dir_name
+APA = settings.CONFIG_DIR_NAME
 
-help = """
+HELP = """
 Manage how you authenticate with our cloud platform
 """
 
-app = typer.Typer(help=help)
+httpd: HTTPServer
+
+app = typer.Typer(help=HELP)
 
 app.add_typer(auth_tokens.app, name="tokens", help="Manage users personal access tokens")
-config_dir_name = settings.config_dir_name  # str(Path.home()) + "/.config/.remotive/"
-token_file_name = settings.token_file_name  # str(Path.home()) + "/.config/.remotive/cloud.secret.token"
+CONFIG_DIR_NAME = settings.CONFIG_DIR_NAME  # str(Path.home()) + "/.config/.remotive/"
+TOKEN_FILE_NAME = settings.TOKEN_FILE_NAME  # str(Path.home()) + "/.config/.remotive/cloud.secret.token"
 
 
 class S(BaseHTTPRequestHandler):
-    def _set_response(self):
+    def _set_response(self) -> None:
         self.send_response(200)
         # self.send_response(301)
         # self.send_header('Location', 'https://cloud.remotivelabs.com')
@@ -34,10 +38,13 @@ class S(BaseHTTPRequestHandler):
         self.send_header("Content-type", "text/html")
         self.end_headers()
 
-    def log_message(self, format, *args):
+    def log_message(self, format: Any, *args: Any) -> None:  # pylint: disable=W0622
         return
 
-    def do_GET(self):  # noqa
+    # Please do not change this into lowercase!
+    @override
+    # type: ignore
+    def do_GET(self):  # pylint: disable=invalid-name,
         self._set_response()
         self.wfile.write("Successfully setup CLI, return to your terminal to continue".encode("utf-8"))
         path = self.path
@@ -47,15 +54,15 @@ class S(BaseHTTPRequestHandler):
         killerthread = Thread(target=httpd.shutdown)
         killerthread.start()
 
-        if not os.path.exists(config_dir_name):
-            os.makedirs(config_dir_name)
+        if not os.path.exists(CONFIG_DIR_NAME):
+            os.makedirs(CONFIG_DIR_NAME)
         write_token(path[1:])
         print("Successfully logged on, you are ready to go with cli")
 
 
-def start_local_webserver(server_class=HTTPServer, handler_class=S, port=0):
+def start_local_webserver(server_class: type = HTTPServer, handler_class: type = S, port: int = 0) -> None:
     server_address = ("", port)
-    global httpd
+    global httpd  # pylint: disable=W0603
     httpd = server_class(server_address, handler_class)
 
 
@@ -65,7 +72,7 @@ def start_local_webserver(server_class=HTTPServer, handler_class=S, port=0):
 
 
 @app.command(name="login")
-def login():
+def login() -> None:
     """
     Login to the cli using browser
 
@@ -73,20 +80,21 @@ def login():
     be the same as activating a personal access key or service-account access key.
     """
     start_local_webserver()
-    webbrowser.open(f"{rest.base_url}/login?redirectUrl=http://localhost:{httpd.server_address[1]}", new=1, autoraise=True)
+    webbrowser.open(f"{Rest.get_base_url()}/login?redirectUrl=http://localhost:{httpd.server_address[1]}", new=1, autoraise=True)
+
     httpd.serve_forever()
 
 
 @app.command()
-def whoami():
+def whoami() -> None:
     """
     Validates authentication and fetches your user information
     """
-    rest.handle_get("/api/whoami")
+    Rest.handle_get("/api/whoami")
 
 
 @app.command()
-def print_access_token():
+def print_access_token() -> None:
     """
     Print current active access token
     """
@@ -94,36 +102,33 @@ def print_access_token():
 
 
 @app.command(help="Clear access token")
-def logout():
-    os.remove(settings.token_file_name)
+def logout() -> None:
+    os.remove(settings.TOKEN_FILE_NAME)
     print("Access token removed")
 
 
-def read_token():
+def read_token() -> str:
     # f = open(token_file_name, "r")
     # token = f.read()
     # f.close()
     return settings.read_token()
 
 
-def read_file_with_path(file):
-    f = open(file, "r")
-    token = f.read()
-    f.close()
-    return token
+def read_file_with_path(file: str) -> str:
+    with open(file, "r", encoding="utf8") as f:
+        token = f.read()
+        return token
 
 
-def read_file(file):
-    f = open(str(Path.home()) + f"/.config/.remotive/{file}", "r")
-    token = f.read()
-    f.close()
-    return token
+def read_file(file: str) -> str:
+    with open(str(Path.home()) + f"/.config/.remotive/{file}", "r", encoding="utf8") as f:
+        token = f.read()
+        return token
 
 
-def write_token(token):
-    f = open(token_file_name, "w")
-    f.write(token)
-    f.close()
+def write_token(token: str) -> None:
+    with open(TOKEN_FILE_NAME, "w", encoding="utf8") as f:
+        f.write(token)
 
 
 # Key stuff

cli/cloud/auth_tokens.py

@@ -1,22 +1,26 @@
 import json
 import os
 import sys
+from json.decoder import JSONDecodeError
 from pathlib import Path
 
 import typer
 
-from . import rest_helper as rest
+from .rest_helper import RestHelper as Rest
 
 app = typer.Typer()
 
-token_file_name = str(Path.home()) + "/.config/.remotive/cloud.secret.token"
-config_dir_name = str(Path.home()) + "/.config/.remotive/"
+TOKEN_FILE_NAME = str(Path.home()) + "/.config/.remotive/cloud.secret.token"
+CONFIG_DIR_NAME = str(Path.home()) + "/.config/.remotive/"
 
 
 @app.command(name="create", help="Create and download a new personal access token")
-def get_personal_access_token(activate: bool = typer.Option(False, help="Activate the token for use after download")):
-    rest.ensure_auth_token()
-    response = rest.handle_post(url="/api/me/keys", return_response=True)
+def get_personal_access_token(activate: bool = typer.Option(False, help="Activate the token for use after download")) -> None:  # pylint: disable=W0621
+    Rest.ensure_auth_token()
+    response = Rest.handle_post(url="/api/me/keys", return_response=True)
+
+    if response is None:
+        return
 
     if response.status_code == 200:
         name = response.json()["name"]
@@ -34,19 +38,42 @@ def get_personal_access_token(activate: bool = typer.Option(False, help="Activat
 
 
 @app.command(name="list", help="List personal access tokens")
-def list_personal_access_tokens():
-    rest.ensure_auth_token()
-    rest.handle_get("/api/me/keys")
+def list_personal_access_tokens() -> None:
+    Rest.ensure_auth_token()
+    Rest.handle_get("/api/me/keys")
+
 
+@app.command(name="revoke")
+def revoke(name_or_file: str = typer.Argument(help="Name or file path of the access token to revoke")) -> None:
+    """
+        Revoke an access token by token name or path to a file containing that token
 
-@app.command(name="revoke", help="Revoke the specified access token")
-def revoke(name: str = typer.Option(..., help="Name of the access token to revoke")):
-    rest.ensure_auth_token()
-    rest.handle_delete(f"/api/me/keys/{name}", success_msg="Successfully revoked")
+        Name is found in the json file
+
+        {
+            "expires": "2034-07-31",
+            "token": "xxx",
+            "created": "2024-07-31T09:18:50.406+02:00",
+            "name": "token_name"
+    }
+    """
+    name = name_or_file
+    if "." in name_or_file:
+        json_str = read_file(name_or_file)
+        try:
+            name = json.loads(json_str)["name"]
+        except JSONDecodeError:
+            sys.stderr.write("Failed to parse json, make sure its a correct access token file\n")
+            sys.exit(1)
+        except KeyError:
+            sys.stderr.write("Json does not contain a name property, make sure its a correct access token file\n")
+            sys.exit(1)
+    Rest.ensure_auth_token()
+    Rest.handle_delete(f"/api/me/keys/{name}")
 
 
 @app.command()
-def describe(file: str = typer.Option(..., help="File name")):
+def describe(file: str = typer.Argument(help="File name")) -> None:
     """
     Show contents of specified access token file
     """
@@ -54,7 +81,7 @@ def describe(file: str = typer.Option(..., help="File name")):
 
 
 @app.command()
-def activate(file: str = typer.Argument(..., help="File name")):
+def activate(file: str = typer.Argument(..., help="File name")) -> None:
     """
     Activate a access token file to be used for authentication.
 
@@ -66,7 +93,7 @@ def activate(file: str = typer.Argument(..., help="File name")):
     do_activate(file)
 
 
-def do_activate(file: str):
+def do_activate(file: str) -> None:
     # Best effort to read file
     if os.path.exists(file):
         token_file = json.loads(read_file_with_path(file))
@@ -79,38 +106,47 @@ def do_activate(file: str):
 
 
 @app.command(name="list-files")
-def list_files():
+def list_files() -> None:
     """
     List personal access token files in remotivelabs config directory
     """
-    personal_files = filter(lambda f: f.startswith("personal"), os.listdir(config_dir_name))
+    personal_files = filter(lambda f: f.startswith("personal"), os.listdir(CONFIG_DIR_NAME))
     for file in personal_files:
         print(file)
 
 
-def read_file(file):
-    f = open(str(Path.home()) + f"/.config/.remotive/{file}", "r")
-    token = f.read()
-    f.close()
-    return token
+def read_file(file: str) -> str:
+    """
+    Reads a file using file path or if that does not exist check under ~/.config/.remotive
+    """
+    path = file
+    if not Path(file).exists():
+        path = str(Path.home()) + f"/.config/.remotive/{file}"
+        if not Path(path).exists():
+            sys.stderr.write(f"Failed to find file using {file} or {path}\n")
+            sys.exit(1)
+    with open(path, "r", encoding="utf8") as f:
+        token = f.read()
+        f.close()
+        return token
 
 
-def read_file_with_path(file):
-    f = open(file, "r")
-    token = f.read()
-    f.close()
-    return token
+def read_file_with_path(file: str) -> str:
+    with open(file, "r", encoding="utf8") as f:
+        token = f.read()
+        f.close()
+        return token
 
 
-def write_token(token):
-    f = open(token_file_name, "w")
-    f.write(token)
-    f.close()
+def write_token(token: str) -> None:
+    with open(TOKEN_FILE_NAME, "w", encoding="utf8") as f:
+        f.write(token)
+        f.close()
 
 
-def write_personal_token(file: str, token: str):
+def write_personal_token(file: str, token: str) -> str:
     path = str(Path.home()) + f"/.config/.remotive/{file}"
-    f = open(path, "w")
-    f.write(token)
-    f.close()
-    return path
+    with open(path, "w", encoding="utf8") as f:
+        f.write(token)
+        f.close()
+        return path