Conform practicum SSD

This commit should be reversed again after the practicum SSD has finished

Author: Dennis-van-Gils

Alia_protocol_serial.py

@@ -20,7 +20,8 @@
 import numpy as np
 from numba import njit
 
-from dvg_devices import Arduino_protocol_serial
+#from dvg_devices import Arduino_protocol_serial
+from dvg_devices import Arduino
 from dvg_debug_functions import dprint, print_fancy_traceback as pft
 
 
@@ -47,7 +48,8 @@ class Waveform(Enum):
     # fmt: on
 
 
-class Alia(Arduino_protocol_serial.Arduino):
+#class Alia(Arduino_protocol_serial.Arduino):
+class Alia(Arduino):
     """This class manages the serial protocol for an Arduino lock-in amplifier,
     aka `Alia`.
     """

Alia_protocol_serial_SAMD51.py

@@ -19,7 +19,8 @@
 import serial
 import numpy as np
 
-from dvg_devices import Arduino_protocol_serial
+#from dvg_devices import Arduino_protocol_serial
+from dvg_devices import Arduino
 from dvg_debug_functions import dprint, print_fancy_traceback as pft
 
 
@@ -32,7 +33,8 @@ class Waveform(Enum):
     # fmt: on
 
 
-class Alia(Arduino_protocol_serial.Arduino):
+#class Alia(Arduino_protocol_serial.Arduino):
+class Alia(Arduino):
     """This class manages the serial protocol for an Arduino lock-in amplifier,
     aka `Alia`.
     """

dvg_debug_functions.py

@@ -0,0 +1,195 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""Provides functions for neatly printing debug information to the terminal
+output, well-suited for multithreaded programs.
+"""
+__author__ = "Dennis van Gils"
+__authoremail__ = "[email protected]"
+__url__ = "https://github.com/Dennis-van-Gils/python-dvg-debug-functions"
+__date__ = "18-07-2020"
+__version__ = "2.1.1"
+
+import os
+import sys
+import time
+import traceback
+import inspect
+
+try:
+    from PyQt5 import QtCore
+except ImportError:
+    PYQT5_IS_PRESENT = False
+else:
+    PYQT5_IS_PRESENT = True
+    dprint_mutex = QtCore.QMutex()
+
+# Setting this global module variable to `True` or `False` will overrule the
+# argument `show_full_paths` in `print_fancy_traceback()`.
+OVERRULE_SHOW_FULL_PATHS = None
+
+
+class ANSI:
+    NONE = ""
+    RED = "\033[1;31m"
+    GREEN = "\033[1;32m"
+    YELLOW = "\033[1;33m"
+    BLUE = "\033[1;34m"
+    PURPLE = "\033[1;35m"  # aka MAGENTA
+    MAGENTA = "\033[1;35m"
+    CYAN = "\033[1;36m"
+    WHITE = "\033[1;37m"
+
+
+def dprint(str_msg: str, ANSI_color: str = None):
+    """'Debug' print a single line to the terminal with optional ANSI color
+    codes. There is a lot of overhead using this print statement, but it is
+    particularly well-suited for multithreaded PyQt programs where multiple
+    threads are each printing information to the same terminal. The ``dprint()``
+    function ensure that each line sent to the terminal will remain as a
+    continious single line, whereas a regular ``print()`` statement will likely
+    result in the lines getting mixed up.
+    
+    The line will be terminated with a newline character and the terminal output
+    buffer is forced to flush before and after every print. In addition, if
+    PyQt5 is present in the Python environment, then a mutex lock will be
+    obtained and released again for each ``dprint()`` execution.
+    """
+    # Explicitly ending the string with a newline '\n' character, instead
+    # of letting the print statement end it for you (end='\n'), fixes the
+    # problem of single lines getting printed to the terminal with
+    # intermittently delayed newlines when coming from different threads.
+    # I.e. it prevents:
+    # >: Output line of thread 1Output line of thread 2   (\n)
+    # >:                                                  (\n)
+    # and makes sure we get:
+    # >: Output line of thread 1                          (\n)
+    # >: Output line of thread 2                          (\n)
+
+    if PYQT5_IS_PRESENT:
+        locker = QtCore.QMutexLocker(dprint_mutex)
+
+    sys.stdout.flush()
+    if ANSI_color is None:
+        print("%s\n" % str_msg, end="")
+    else:
+        print("%s%s%s\n" % (ANSI_color, str_msg, ANSI.WHITE), end="")
+    sys.stdout.flush()
+
+    if PYQT5_IS_PRESENT:
+        locker.unlock()
+
+
+def tprint(str_msg: str, ANSI_color: str = None):
+    """Identical to ``dprint()``, but now prepended with a ``time.perf_counter()``
+    timestamp.
+    """
+    dprint("%.4f %s" % (time.perf_counter(), str_msg), ANSI_color)
+
+
+def print_fancy_traceback(
+    err=None, back: int = 3, show_full_paths: bool = False
+):
+    """Print the exception or the current regular call-stack traceback to the
+    terminal, using ANSI color codes that mimic the IPython command shell.
+
+    Args:
+        err (``Exception`` | ``str`` | ``None``, optional):
+            When ``err`` is of type ``Exception``, then an exception traceback will
+            be printed. When ``err`` is of another type, then the current regular
+            call-stack traceback will be printed.
+
+            Default: ``None``
+
+        back (``int``, optional):
+            Depth of the traceback to print.
+
+            Default: ``3``
+
+        show_full_paths (``bool``, optional):
+            Shows the full filepath in the traceback when True, otherwise just
+            the filename.
+
+            Default: ``False``
+    """
+
+    def print_frame(filename, line_no, frame_name):
+        print(
+            (
+                ANSI.CYAN
+                + "File "
+                + ANSI.GREEN
+                + '"%s"'
+                + ANSI.CYAN
+                + ", line "
+                + ANSI.GREEN
+                + "%s"
+                + ANSI.CYAN
+                + ", in "
+                + ANSI.PURPLE
+                + "%s"
+                + ANSI.WHITE
+            )
+            % (filename, line_no, frame_name)
+        )
+
+    print(
+        "\n"
+        + ANSI.WHITE
+        + "Fancy traceback "
+        + ANSI.CYAN
+        + "(most recent call last)"
+        + ANSI.WHITE
+        + ":"
+    )
+
+    if isinstance(err, Exception):
+        # Exception traceback
+        etype, evalue, tb = sys.exc_info()
+        stack = traceback.extract_tb(tb)
+        stack = stack[-back:]
+
+        for frame in stack:
+            if OVERRULE_SHOW_FULL_PATHS is not None:
+                file_descr = (
+                    frame.filename
+                    if OVERRULE_SHOW_FULL_PATHS
+                    else os.path.basename(frame.filename)
+                )
+            else:
+                file_descr = (
+                    frame.filename
+                    if show_full_paths
+                    else os.path.basename(frame.filename)
+                )
+
+            print_frame(file_descr, frame.lineno, frame.name)
+
+        print("----> %s" % stack[-1].line)
+        print(
+            (ANSI.RED + "%s: " + ANSI.WHITE + "%s") % (etype.__name__, evalue)
+        )
+
+    else:
+        # Regular call stack traceback
+        stack = inspect.stack()
+        stack.reverse()
+        stack = stack[-back - 1 : -1]
+
+        for frame in stack:
+            if OVERRULE_SHOW_FULL_PATHS is not None:
+                file_descr = (
+                    frame.filename
+                    if OVERRULE_SHOW_FULL_PATHS
+                    else os.path.basename(frame.filename)
+                )
+            else:
+                file_descr = (
+                    frame.filename
+                    if show_full_paths
+                    else os.path.basename(frame.filename)
+                )
+
+            print_frame(file_descr, frame.lineno, frame.function)
+
+        if isinstance(err, str):
+            print((ANSI.RED + "Error: " + ANSI.WHITE + "%s") % err)