Add logging (#8)

Author: yakimka

CherryTomato/main.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-
+import logging
 import sys
 
 from PyQt5 import Qt
@@ -10,7 +10,12 @@
 from CherryTomato.settings import CherryTomatoSettings
 from CherryTomato.timer_proxy import TomatoTimerProxy
 from CherryTomato.tomato_timer import TomatoTimer
-from CherryTomato.utils import CommandExecutor
+from CherryTomato.utils import CommandExecutor, CompactFormatter, makeLogger
+
+logFmt = '%(asctime)s:%(levelname)s:%(name)s:%(message)s'
+handler = logging.StreamHandler(sys.stdout)
+handler.setFormatter(CompactFormatter(logFmt, "%Y-%m-%d %H:%M:%S"))
+logger = makeLogger('CherryTomato', handler=handler, level='INFO')
 
 
 def main():

CherryTomato/main_window.py

@@ -1,6 +1,5 @@
 import os
 from functools import lru_cache
-from warnings import warn
 
 from PyQt5 import Qt, QtCore
 from PyQt5.QtGui import QBrush, QColor, QPalette, QIcon, QKeySequence
@@ -9,11 +8,13 @@
 from CherryTomato import about_window, APP_ICON, MEDIA_DIR, settings_window
 from CherryTomato.main_ui import Ui_MainWindow
 from CherryTomato.timer_proxy import AbstractTimerProxy
+from CherryTomato.utils import classLogger
 
 
 class CherryTomatoMainWindow(Qt.QMainWindow, Ui_MainWindow):
     def __init__(self, timerProxy: AbstractTimerProxy, settings, parent=None):
         super().__init__(parent=parent)
+        self.logger = classLogger(__name__, self.__class__.__name__)
         self.settings = settings
 
         self.setupUi(self)
@@ -39,18 +40,21 @@ def __init__(self, timerProxy: AbstractTimerProxy, settings, parent=None):
 
     def setWindowSizeAndPosition(self):
         # Initial window size/pos last saved. Use default values for first time
-        for _ in range(3):
+        for _ in range(2):
             try:
                 self.resize(self.settings.size)
                 self.move(self.settings.position)
             except TypeError:
+                msg = f"Can't read window size and position settings. Restore to defaults"
+                self.logger.warning(msg)
                 del self.settings.size
                 del self.settings.position
                 continue
             else:
                 break
         else:
-            warn(UserWarning("Can't restore window settings"))
+            msg = "Can't restore window settings"
+            self.logger.error(msg)
 
     def closeEvent(self, e):
         self.saveWindowSizeAndPosition()

CherryTomato/utils.py

@@ -1,11 +1,38 @@
+import logging
 import shlex
 import subprocess
 
 from CherryTomato.settings import STATE_TOMATO, STATE_BREAK, STATE_LONG_BREAK
 
 
+class CompactFormatter(logging.Formatter):
+    """Leave class name only
+    """
+
+    def format(self, record):
+        record.name = record.name.rpartition('.')[-1]
+        return super().format(record)
+
+
+def makeLogger(name, *, handler, level):
+    """Create the root logger
+    """
+    logger = logging.getLogger(name)
+    logger.addHandler(handler)
+    logger.setLevel(level)
+    logger.propagate = False
+    return logger
+
+
+def classLogger(path, classname):
+    """Return logger for a class
+    """
+    return logging.getLogger(path).getChild(classname)
+
+
 class CommandExecutor:
     def __init__(self, settings):
+        self.logger = classLogger(__name__, self.__class__.__name__)
         self.settings = settings
 
     def onStart(self, status):
@@ -22,13 +49,15 @@ def onStateChange(self, status):
 
     def _execute(self, command, status=None):
         if command:
-            command = self._applyMacros(command, status)
+            cmd_with_macros = self._applyMacros(command, status)
             try:
                 subprocess.Popen(
-                    shlex.split(command), stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT
+                    shlex.split(cmd_with_macros),
+                    stdout=subprocess.DEVNULL,
+                    stderr=subprocess.STDOUT
                 )
-            except Exception as e:
-                print(e)
+            except Exception:
+                self.logger.exception(f'Error while executing command "{command}"', exc_info=True)
 
     @classmethod
     def _applyMacros(cls, cmd, status=None):