Added job listing command

Author: MrClock8163

src/instrumentman/__init__.py

@@ -12,6 +12,7 @@
 from . import protocoltest
 from . import inclination
 from . import filetransfer
+from . import jobs
 
 
 @extra_group("iman", params=None)  # type: ignore[misc]
@@ -76,4 +77,5 @@ def cli_download() -> None:
 cli_validate.add_command(setmeasurement.cli_validate)
 cli_import.add_command(setup.cli_import)
 cli_list.add_command(filetransfer.cli_list)
+cli_list.add_command(jobs.cli_list)
 cli_download.add_command(filetransfer.cli_download)

src/instrumentman/jobs/__init__.py

@@ -0,0 +1,22 @@
+from typing import Any
+
+from click_extra import extra_command
+
+from ..utils import (
+    com_option_group,
+    com_port_argument
+)
+
+
+@extra_command(
+    "jobs",
+    params=None,
+    context_settings={"auto_envvar_prefix": None}
+)  # type: ignore[misc]
+@com_port_argument()
+@com_option_group()
+def cli_list(**kwargs: Any) -> None:
+    """List job files on an instrument."""
+    from .app import main_list
+
+    main_list(**kwargs)

src/instrumentman/jobs/app.py

@@ -0,0 +1,72 @@
+from click_extra import echo
+from geocompy.communication import open_serial
+from geocompy.geo import GeoCom
+from geocompy.geo.gctypes import GeoComCode
+
+from ..utils import echo_red, echo_yellow
+
+
+def run_listing(tps: GeoCom) -> None:
+    resp_setup = tps.csv.setup_listing()
+    if resp_setup.error != GeoComCode.OK:
+        echo_red(f"Could not set up job listing ({resp_setup.error.name})")
+        return
+
+    resp_list = tps.csv.list()
+    if resp_list.error != GeoComCode.OK or resp_list.params is None:
+        echo_red(f"Could not start listing ({resp_list.error.name})")
+        return
+
+    job, file, _, _, _ = resp_list.params
+    if job == "" or file == "":
+        echo_yellow("No jobs were found")
+        return
+
+    count = 1
+    echo(f"{'job name':<50.50s}{'file name':<50.50s}")
+    echo(f"{'--------':<50.50s}{'---------':<50.50s}")
+    fmt = "{job:<50.50s}{file:<50.50s}"
+    echo(
+        fmt.format_map(
+            {
+                "job": job,
+                "file": file
+            }
+        )
+    )
+    while True:
+        resp_list = tps.csv.list()
+        if resp_list.error != GeoComCode.OK or resp_list.params is None:
+            break
+
+        job, file, _, _, _ = resp_list.params
+        echo(
+            fmt.format_map(
+                {
+                    "job": job,
+                    "file": file
+                }
+            )
+        )
+        count += 1
+
+    echo("-" * 90)
+    echo(f"total: {count} files")
+
+
+def main_list(
+    port: str,
+    baud: int = 9600,
+    timeout: int = 15,
+    retry: int = 1,
+    sync_after_timeout: bool = False
+) -> None:
+    with open_serial(
+        port=port,
+        speed=baud,
+        timeout=timeout,
+        retry=retry,
+        sync_after_timeout=sync_after_timeout
+    ) as com:
+        tps = GeoCom(com)
+        run_listing(tps)