[data] added logging

Author: MrClock8163

src/instrumentman/datatransfer/__init__.py

@@ -41,7 +41,7 @@
     default=True
 )
 @option(
-    "--inclide-eof/--no-include-eof",
+    "--include-eof/--no-include-eof",
     help=(
         "wether the EOF marker is part of the output format "
         "(or just sent by the instrument regardless of the format in question)"

src/instrumentman/datatransfer/app.py

@@ -1,4 +1,5 @@
 from io import BufferedWriter, TextIOWrapper
+from logging import getLogger
 
 from serial import SerialTimeoutException
 from rich.progress import Progress, TextColumn
@@ -18,39 +19,53 @@ def main_download(
     include_eof: bool = False
 ) -> None:
     eof_bytes = eof.encode("ascii")
+    logger = getLogger("iman.data.download")
+    logger.info(f"Opening connection on {port}")
+    logger.debug(f"Connection parameters: baud={baud:d}, timeout={timeout:d}")
     with open_serial(
         port,
         speed=baud,
         timeout=timeout
     ) as com:
         eol_bytes = com.eombytes
         started = False
+        logger.info("Starting data download")
+        logger.debug("Waiting for first line...")
         while True:
             try:
                 data = com.receive_binary()
-                started = True
+                if not started:
+                    started = True
+                    logger.debug("Received first line...")
 
                 if data == eof_bytes and autoclose and not include_eof:
                     echo_green("Download finished (end-of-file)")
-                    return
+                    logger.info("Download finished (end-of-file)")
+                    break
 
                 echo(data.decode("ascii", "replace"))
                 if output is not None:
                     output.write(data + eol_bytes)
 
                 if data == eof_bytes and autoclose:
                     echo_green("Download finished (end-of-file)")
-                    return
+                    logger.info("Download finished (end-of-file)")
+                    break
             except SerialTimeoutException:
                 if started and autoclose:
                     echo_green("Download finished (timeout)")
-                    return
+                    logger.info("Download finished (timeout)")
+                    break
             except KeyboardInterrupt:
                 echo_yellow("Download stopped manually")
-                return
+                logger.info("Download stopped manually")
+                break
             except Exception as e:
                 echo_red(f"Download interrupted by error ({e})")
-                return
+                logger.exception("Download interrupted by error")
+                break
+
+    logger.info(f"Closed connection on {port}")
 
 
 def main_upload(
@@ -60,12 +75,17 @@ def main_upload(
     timeout: int = 15,
     skip: int = 0
 ) -> None:
+    logger = getLogger("iman.data.upload")
+    logger.info(f"Opening connection on {port}")
+    logger.debug(f"Connection parameters: baud={baud:d}, timeout={timeout:d}")
     with open_serial(
         port,
         speed=baud,
         timeout=timeout
     ) as com:
         try:
+            logger.info("Starting data upload")
+            logger.debug(f"Skipping {skip} line(s)")
             for _ in range(skip):
                 next(file)
 
@@ -76,8 +96,13 @@ def main_upload(
                 for line in progress.track(file, description="Uploading..."):
                     com.send(line)
 
+        except KeyboardInterrupt:
+            echo_yellow("Upload cancelled")
+            logger.info("Upload cancelled by user")
         except Exception as e:
             echo_red(f"Upload interrupted by error ({e})")
-            return
+            logger.exception("Upload interrupted by error")
+        else:
+            echo_green("Upload finished")
 
-        echo_green("Upload finished")
+    logger.info(f"Closed connection on {port}")