Add logger to replace print()

Author: mathoudebine

library/config.py

@@ -1,24 +1,16 @@
-import logging
 import os
 import queue
 import sys
 import threading
 
 import yaml
 
+from library.log import logger
 
-def load_yaml(configfile):
-    if not os.path.exists(configfile):
-        logging.critical("No YAML file found")
-        exit()
 
+def load_yaml(configfile):
     with open(configfile, "r") as stream:
-        try:
-            yamlconfig = yaml.safe_load(stream)
-        except yaml.YAMLError:
-            logging.critical("Failed loading YAML configuration file")
-            exit()
-
+        yamlconfig = yaml.safe_load(stream)
         return yamlconfig
 
 
@@ -27,11 +19,11 @@ def load_yaml(configfile):
 
 try:
     theme_path = "res/themes/" + CONFIG_DATA['config']['THEME'] + "/"
-    print("Loading theme", CONFIG_DATA['config']['THEME'], "from ", theme_path + "theme.yaml")
+    logger.info("Loading theme %s from %s" % (CONFIG_DATA['config']['THEME'], theme_path + "theme.yaml"))
     THEME_DATA = load_yaml(theme_path + "theme.yaml")
     THEME_DATA['PATH'] = theme_path
 except:
-    print("Theme not found or contains errors!")
+    logger.error("Theme not found or contains errors!")
     try:
         sys.exit(0)
     except:

library/display.py

@@ -1,6 +1,7 @@
 from library import config
 from library.lcd_comm_rev_a import LcdCommRevA
 from library.lcd_comm_rev_b import LcdCommRevB
+from library.log import logger
 
 THEME_DATA = config.THEME_DATA
 CONFIG_DATA = config.CONFIG_DATA
@@ -21,7 +22,7 @@ def __init__(self):
         elif CONFIG_DATA["display"]["REVISION"] == "B":
             self.lcd = LcdCommRevB()
         else:
-            print("Unknown display revision '", CONFIG_DATA["display"]["REVISION"], "'")
+            logger.error("Unknown display revision '", CONFIG_DATA["display"]["REVISION"], "'")
 
     def initialize_display(self):
         # Reset screen in case it was in an unstable state (screen is also cleared)
@@ -42,7 +43,7 @@ def initialize_display(self):
     def display_static_images(self):
         if THEME_DATA['static_images']:
             for image in THEME_DATA['static_images']:
-                print(f"Drawing Image: {image}")
+                logger.debug(f"Drawing Image: {image}")
                 self.lcd.DisplayBitmap(
                     bitmap_path=THEME_DATA['PATH'] + THEME_DATA['static_images'][image].get("PATH"),
                     x=THEME_DATA['static_images'][image].get("X", 0),
@@ -54,7 +55,7 @@ def display_static_images(self):
     def display_static_text(self):
         if THEME_DATA['static_text']:
             for text in THEME_DATA['static_text']:
-                print(f"Drawing Text: {text}")
+                logger.debug(f"Drawing Text: {text}")
                 self.lcd.DisplayText(
                     text=THEME_DATA['static_text'][text].get("TEXT"),
                     x=THEME_DATA['static_text'][text].get("X", 0),

library/lcd_comm.py

@@ -5,6 +5,7 @@
 from PIL import Image, ImageDraw, ImageFont
 
 from library import config
+from library.log import logger
 
 CONFIG_DATA = config.CONFIG_DATA
 THEME_DATA = config.THEME_DATA
@@ -27,7 +28,7 @@ def get_theme_orientation() -> Orientation:
     elif THEME_DATA["display"]["DISPLAY_ORIENTATION"] == 'reverse_landscape':
         return Orientation.REVERSE_LANDSCAPE
     else:
-        print("Orientation '", THEME_DATA["display"]["DISPLAY_ORIENTATION"], "' unknown, using portrait")
+        logger.warning("Orientation '", THEME_DATA["display"]["DISPLAY_ORIENTATION"], "' unknown, using portrait")
         return Orientation.PORTRAIT
 
 
@@ -50,10 +51,10 @@ def openSerial(self):
         if CONFIG_DATA['config']['COM_PORT'] == 'AUTO':
             lcd_com_port = self.auto_detect_com_port()
             self.lcd_serial = serial.Serial(lcd_com_port, 115200, timeout=1, rtscts=1)
-            print(f"Auto detected comm port: {lcd_com_port}")
+            logger.debug(f"Auto detected comm port: {lcd_com_port}")
         else:
             lcd_com_port = CONFIG_DATA["config"]["COM_PORT"]
-            print(f"Static comm port: {lcd_com_port}")
+            logger.debug(f"Static comm port: {lcd_com_port}")
             self.lcd_serial = serial.Serial(lcd_com_port, 115200, timeout=1, rtscts=1)
 
     @staticmethod

library/lcd_comm_rev_a.py

@@ -4,6 +4,7 @@
 from serial.tools.list_ports import comports
 
 from library.lcd_comm import *
+from library.log import logger
 
 
 class Command(IntEnum):
@@ -23,7 +24,6 @@ def __init__(self):
 
     def __del__(self):
         try:
-            print("close serial")
             self.lcd_serial.close()
         except:
             pass
@@ -60,7 +60,7 @@ def WriteData(self, byteBuffer: bytearray):
             self.lcd_serial.write(bytes(byteBuffer))
         except serial.serialutil.SerialTimeoutException:
             # We timed-out trying to write to our device, slow things down.
-            print("(Write data) Too fast! Slow down!")
+            logger.warn("(Write data) Too fast! Slow down!")
 
     def SendLine(self, line: bytes):
         config.update_queue.put((self.WriteLine, [line]))
@@ -70,14 +70,14 @@ def WriteLine(self, line: bytes):
             self.lcd_serial.write(line)
         except serial.serialutil.SerialTimeoutException:
             # We timed-out trying to write to our device, slow things down.
-            print("(Write line) Too fast! Slow down!")
+            logger.warn("(Write line) Too fast! Slow down!")
 
     def InitializeComm(self):
         # HW revision A does not need init commands
         pass
 
     def Reset(self):
-        print("Display reset...")
+        logger.info("Display reset...")
         # Reset command bypasses queue because it is run when queue threads are not yet started
         self.SendCommand(Command.RESET, 0, 0, 0, 0, bypass_queue=True)
         # Wait for display reset then reconnect
@@ -106,7 +106,7 @@ def SetBrightness(self, level: int = CONFIG_DATA["display"]["BRIGHTNESS"]):
         self.SendCommand(Command.SET_BRIGHTNESS, level_absolute, 0, 0, 0)
 
     def SetBackplateLedColor(self, led_color: tuple[int, int, int] = THEME_DATA['display']["DISPLAY_RGB_LED"]):
-        print("HW revision A does not support backplate LED color setting")
+        logger.info("HW revision A does not support backplate LED color setting")
         pass
 
     def SetOrientation(self, orientation: Orientation = get_theme_orientation()):

library/lcd_comm_rev_b.py

@@ -3,6 +3,7 @@
 from serial.tools.list_ports import comports
 
 from library.lcd_comm import *
+from library.log import logger
 
 
 class Command(IntEnum):
@@ -77,7 +78,7 @@ def WriteData(self, byteBuffer: bytearray):
             self.lcd_serial.write(bytes(byteBuffer))
         except serial.serialutil.SerialTimeoutException:
             # We timed-out trying to write to our device, slow things down.
-            print("(Write data) Too fast! Slow down!")
+            logger.warn("(Write data) Too fast! Slow down!")
 
     def SendLine(self, line: bytes):
         config.update_queue.put((self.WriteLine, [line]))
@@ -87,7 +88,7 @@ def WriteLine(self, line: bytes):
             self.lcd_serial.write(line)
         except serial.serialutil.SerialTimeoutException:
             # We timed-out trying to write to our device, slow things down.
-            print("(Write line) Too fast! Slow down!")
+            logger.warn("(Write line) Too fast! Slow down!")
 
     def Hello(self):
         hello = [ord('H'), ord('E'), ord('L'), ord('L'), ord('O')]
@@ -97,11 +98,11 @@ def Hello(self):
         response = self.lcd_serial.read(10)
 
         if len(response) != 10:
-            print("Device not recognised (short response to HELLO)")
+            logger.warn("Device not recognised (short response to HELLO)")
         if response[0] != Command.HELLO or response[-1] != Command.HELLO:
-            print("Device not recognised (bad framing)")
+            logger.warn("Device not recognised (bad framing)")
         if [x for x in response[1:6]] != hello:
-            print("Device not recognised (No HELLO; got %r)" % (response[1:6],))
+            logger.warn("Device not recognised (No HELLO; got %r)" % (response[1:6],))
         # The HELLO response here is followed by:
         #   0x0A, 0x12, 0x00
         # It is not clear what these might be.

library/log.py

@@ -0,0 +1,13 @@
+# Configure logging format
+import logging
+
+logging.basicConfig(# format='%(asctime)s [%(levelname)s] %(message)s in %(pathname)s:%(lineno)d',
+                    format="%(asctime)s [%(levelname)s] %(message)s",
+                    handlers=[
+                        # logging.FileHandler("log.log", mode='w'),  # Log in textfile (erased at each start)
+                        logging.StreamHandler()  # Log also in console
+                    ],
+                    datefmt='%H:%M:%S')
+
+logger = logging.getLogger('turing')
+logger.setLevel(logging.DEBUG)  # Lowest log level : print all messages

library/scheduler.py

@@ -6,6 +6,7 @@
 
 import library.config as config
 import library.stats as stats
+from library.log import logger
 
 THEME_DATA = config.THEME_DATA
 
@@ -64,61 +65,61 @@ def wrap(
 @schedule(timedelta(seconds=THEME_DATA['STATS']['CPU']['PERCENTAGE'].get("INTERVAL", None)).total_seconds())
 def CPUPercentage():
     """ Refresh the CPU Percentage """
-    # print("Refresh CPU Percentage")
+    # logger.debug("Refresh CPU Percentage")
     stats.CPU.percentage()
 
 
 @async_job("CPU_Frequency")
 @schedule(timedelta(seconds=THEME_DATA['STATS']['CPU']['FREQUENCY'].get("INTERVAL", None)).total_seconds())
 def CPUFrequency():
     """ Refresh the CPU Frequency """
-    # print("Refresh CPU Frequency")
+    # logger.debug("Refresh CPU Frequency")
     stats.CPU.frequency()
 
 
 @async_job("CPU_Load")
 @schedule(timedelta(seconds=THEME_DATA['STATS']['CPU']['LOAD'].get("INTERVAL", None)).total_seconds())
 def CPULoad():
     """ Refresh the CPU Load """
-    # print("Refresh CPU Load")
+    # logger.debug("Refresh CPU Load")
     stats.CPU.load()
 
 
 @async_job("CPU_Load")
 @schedule(timedelta(seconds=THEME_DATA['STATS']['CPU']['TEMPERATURE'].get("INTERVAL", None)).total_seconds())
 def CPUTemperature():
     """ Refresh the CPU Temperature """
-    # print("Refresh CPU Temperature")
+    # logger.debug("Refresh CPU Temperature")
     stats.CPU.temperature()
 
 
 @async_job("GPU_Stats")
 @schedule(timedelta(seconds=THEME_DATA['STATS']['GPU'].get("INTERVAL", None)).total_seconds())
 def GpuNvidiaStats():
     """ Refresh the GPU Stats """
-    # print("Refresh GPU Stats")
+    # logger.debug("Refresh GPU Stats")
     stats.GpuNvidia.stats()
 
 
 @async_job("GPU_Stats")
 @schedule(timedelta(seconds=THEME_DATA['STATS']['GPU'].get("INTERVAL", None)).total_seconds())
 def GpuAmdStats():
     """ Refresh the GPU Stats """
-    # print("Refresh GPU Stats")
+    # logger.debug("Refresh GPU Stats")
     stats.GpuAmd.stats()
 
 
 @async_job("Memory_Stats")
 @schedule(timedelta(seconds=THEME_DATA['STATS']['MEMORY'].get("INTERVAL", None)).total_seconds())
 def MemoryStats():
-    # print("Refresh memory stats")
+    # logger.debug("Refresh memory stats")
     stats.Memory.stats()
 
 
 @async_job("Disk_Stats")
 @schedule(timedelta(seconds=THEME_DATA['STATS']['DISK'].get("INTERVAL", None)).total_seconds())
 def DiskStats():
-    # print("Refresh disk stats")
+    # logger.debug("Refresh disk stats")
     stats.Disk.stats()
 
 

library/stats.py

@@ -8,6 +8,7 @@
 
 import library.config as config
 from library.display import display
+from library.log import logger
 
 THEME_DATA = config.THEME_DATA
 
@@ -23,7 +24,7 @@ class CPU:
     @staticmethod
     def percentage():
         cpu_percentage = psutil.cpu_percent(interval=THEME_DATA['STATS']['CPU']['PERCENTAGE'].get("INTERVAL", None))
-        # print(f"CPU Percentage: {cpu_percentage}")
+        # logger.debug(f"CPU Percentage: {cpu_percentage}")
 
         if THEME_DATA['STATS']['CPU']['PERCENTAGE']['TEXT'].get("SHOW", False):
             display.lcd.DisplayText(
@@ -80,7 +81,7 @@ def frequency():
     @staticmethod
     def load():
         cpu_load = psutil.getloadavg()
-        # print(f"CPU Load: ({cpu_load[0]},{cpu_load[1]},{cpu_load[2]})")
+        # logger.debug(f"CPU Load: ({cpu_load[0]},{cpu_load[1]},{cpu_load[2]})")
 
         if THEME_DATA['STATS']['CPU']['LOAD']['ONE']['TEXT'].get("SHOW", False):
             display.lcd.DisplayText(
@@ -166,7 +167,7 @@ def temperature():
 
 def display_gpu_stats(load, memory_percentage, memory_used, temperature):
     if THEME_DATA['STATS']['GPU']['PERCENTAGE']['GRAPH'].get("SHOW", False):
-        # print(f"GPU Load: {load}")
+        # logger.debug(f"GPU Load: {load}")
         display.lcd.DisplayProgressBar(
             x=THEME_DATA['STATS']['GPU']['PERCENTAGE']['GRAPH'].get("X", 0),
             y=THEME_DATA['STATS']['GPU']['PERCENTAGE']['GRAPH'].get("Y", 0),
@@ -198,7 +199,7 @@ def display_gpu_stats(load, memory_percentage, memory_used, temperature):
         )
 
     if THEME_DATA['STATS']['GPU']['MEMORY']['GRAPH'].get("SHOW", False):
-        # print(f"GPU Load: {load}")
+        # logger.debug(f"GPU Load: {load}")
         display.lcd.DisplayProgressBar(
             x=THEME_DATA['STATS']['GPU']['MEMORY']['GRAPH'].get("X", 0),
             y=THEME_DATA['STATS']['GPU']['MEMORY']['GRAPH'].get("Y", 0),

main.py

@@ -9,33 +9,34 @@
 
 MIN_PYTHON = (3, 7)
 if sys.version_info < MIN_PYTHON:
-    print("Error: Python %s.%s or later is required.\n" % MIN_PYTHON)
+    print("[ERROR] Python %s.%s or later is required." % MIN_PYTHON)
     try:
         sys.exit(0)
     except:
         os._exit(0)
 
+from library.log import logger
 import library.scheduler as scheduler
 from library.display import display
 
 if __name__ == "__main__":
 
     def sighandler(signum, frame):
-        print(" Caught signal", str(signum), ", exiting")
+        logger.info(" Caught signal %d, exiting" % signum)
 
         # Do not stop the program now in case data transmission was in progress
         # Instead, ask the scheduler to empty the action queue before stopping
         scheduler.STOPPING = True
 
         # Allow 5 seconds max. delay in case scheduler is not responding
         wait_time = 5
-        print("Waiting for all pending request to be sent to display (%ds max)..." % wait_time)
+        logger.info("Waiting for all pending request to be sent to display (%ds max)..." % wait_time)
 
         while not scheduler.is_queue_empty() and wait_time > 0:
             time.sleep(0.1)
             wait_time = wait_time - 0.1
 
-        print("(%.1fs)" % (5 - wait_time))
+        logger.debug("(%.1fs)" % (5 - wait_time))
 
         # We force the exit to avoid waiting for other scheduled tasks: they may have a long delay!
         try:
@@ -69,15 +70,15 @@ def sighandler(signum, frame):
     if stats.CPU.is_temperature_available():
         scheduler.CPUTemperature()
     else:
-        print("STATS: Your CPU temperature is not supported yet")
+        logger.warning("Your CPU temperature is not supported yet")
     if stats.GpuNvidia.is_available():
-        print("Detected Nvidia GPU(s)")
+        logger.info("Detected Nvidia GPU(s)")
         scheduler.GpuNvidiaStats()
     elif stats.GpuAmd.is_available():
-        print("Detected AMD GPU(s)")
+        logger.info("Detected AMD GPU(s)")
         scheduler.GpuAmdStats()
     else:
-        print("STATS: Your GPU is not supported yet")
+        logger.warning("Your GPU is not supported yet")
     scheduler.MemoryStats()
     scheduler.DiskStats()
     scheduler.QueueHandler()