Some refactorings (#51)

* feat: borrow things from hyperion control

- use GuiHandler, Logger and align Settings to SettingsManager from hyperion control
- remove "needs_reconnection" check
- upgrade pil dependency

* build: fix check script

Author: sanzoghenzo

Pipfile

@@ -15,4 +15,4 @@ python_version = "3.11"
 [scripts]
 pre-commit = "pre-commit install"
 lint = "pre-commit run --all"
-check = "kodi-addon-checker --branch nexus --allow-folder-id-mismatch script.service.hyperion-control"
+check = "kodi-addon-checker --branch nexus --allow-folder-id-mismatch script.service.hyperion"

script.service.hyperion/addon.xml

@@ -3,7 +3,7 @@
   <requires>
     <import addon="xbmc.addon"  version="20.0.0"/>
     <import addon="xbmc.python" version="3.0.1"/>
-    <import addon="script.module.pil" version="1.1.7"/>
+    <import addon="script.module.pil" version="5.1.0"/>
     <import addon="script.module.protobuf" version="4.23.2"/>
   </requires>
   <extension point="xbmc.service" library="service.py"/>

script.service.hyperion/resources/lib/gui.py

@@ -0,0 +1,34 @@
+"""Kodi GUI handler."""
+from __future__ import annotations
+
+import xbmcaddon
+import xbmcgui
+from resources.lib.settings import SettingsManager
+
+
+class GuiHandler:
+    """Kodi GUI handler."""
+
+    def __init__(
+        self, addon: xbmcaddon.Addon, settings_manager: SettingsManager
+    ) -> None:
+        self._addon = addon
+        self._settings = settings_manager
+        self._dialog = xbmcgui.Dialog()  # TODO: DI with embedded getlocalizedstring
+        self._addon_name = addon.getAddonInfo("name")
+        self._addon_icon = addon.getAddonInfo("icon")
+
+    def _get_localized_string(self, label_id: int) -> str:
+        """Returns the localized string of a label ID."""
+        return self._addon.getLocalizedString(label_id)
+
+    def notify_label(self, label_id: int) -> None:
+        """Displays a notification with the localized message."""
+        message = self._get_localized_string(label_id)
+        self.notify_text(message, time=1000, icon=self._addon_icon)
+
+    def notify_text(
+        self, message: str, time: int = 3000, icon: str = xbmcgui.NOTIFICATION_INFO
+    ) -> None:
+        """Displays a notification."""
+        self._dialog.notification(self._addon_name, message, icon, time)

script.service.hyperion/resources/lib/logger.py

@@ -0,0 +1,25 @@
+"""Logging facility."""
+import xbmc
+
+
+class Logger:
+    """Logging facility for Kodi add-ons."""
+
+    def __init__(self, addon_name: str) -> None:
+        self._addon_name = addon_name
+
+    def log(self, message: str, level: int = xbmc.LOGDEBUG) -> None:
+        """Writes the message to the logger with the addon name as prefix."""
+        xbmc.log(f"[{self._addon_name}] - {message}", level=level)
+
+    def debug(self, message: str) -> None:
+        """Writes a debug message to the log."""
+        self.log(message)
+
+    def info(self, message: str) -> None:
+        """Writes an info message to the log."""
+        self.log(message, level=xbmc.LOGINFO)
+
+    def error(self, message: str) -> None:
+        """Writes an error message to the log."""
+        self.log(message, level=xbmc.LOGERROR)

script.service.hyperion/resources/lib/misc.py

@@ -26,9 +26,10 @@
 import xbmc
 from PIL import Image
 
+from resources.lib.gui import GuiHandler
 from resources.lib.hyperion.hyperion import Hyperion
-from resources.lib.misc import MessageHandler
-from resources.lib.settings import Settings
+from resources.lib.logger import Logger
+from resources.lib.settings import SettingsManager
 
 State = Callable[[], "State"]
 
@@ -37,11 +38,16 @@ class HyperionMonitor(xbmc.Monitor):
     """Class to capture changes in settings and screensaver state."""
 
     def __init__(
-        self, settings: Settings, player: xbmc.Player, output_handler: MessageHandler
+        self,
+        settings: SettingsManager,
+        player: xbmc.Player,
+        output_handler: GuiHandler,
+        logger: Logger,
     ) -> None:
         super().__init__()
         self.settings = settings
         self.output_handler = output_handler
+        self._logger = logger
         self._screensaver = xbmc.getCondVisibility("System.ScreenSaverActive")
         self._player = player
         self.show_error_message = True
@@ -50,7 +56,7 @@ def __init__(
 
     def onSettingsChanged(self) -> None:
         self.settings.read_settings()
-        if self.settings.needs_reconnection and self.grabbing:
+        if self.grabbing:
             self.connect()
 
     def onScreensaverDeactivated(self) -> None:
@@ -72,7 +78,7 @@ def grabbing(self) -> bool:
 
     def notify_error(self, label_id: int) -> None:
         if self.show_error_message:
-            self.output_handler.notify(label_id)
+            self.output_handler.notify_label(label_id)
             self.show_error_message = False
 
     def main_loop(self) -> None:
@@ -101,8 +107,10 @@ def error_state(self) -> State:
         return self.disconnected_state
 
     def connect(self) -> None:
-        self.output_handler.log("Establishing connection to hyperion")
         settings = self.settings
+        self._logger.info(
+            f"Establishing connection to hyperion at {settings.address}:{settings.port}"
+        )
         self._hyperion = Hyperion(settings.address, settings.port)
         self._capture = xbmc.RenderCapture()
 
@@ -123,7 +131,7 @@ def connected_state(self) -> State:
         self._capture.capture(*capture_size)
         cap_image = self._capture.getImage(self.settings.sleep_time)
         if cap_image is None or len(cap_image) < expected_capture_size:
-            self.output_handler.log(
+            self._logger.debug(
                 f"Captured image is none or < expected. "
                 f"captured: {len(cap_image) if cap_image is not None else 'None'}, "
                 f"expected: {expected_capture_size}"
@@ -145,7 +153,7 @@ def connected_state(self) -> State:
             )
         except Exception:
             # unable to send image. notify and go to the error state
-            self.output_handler.notify(32101)
+            self.output_handler.notify_label(32101)
             return self.error_state
 
         return self.connected_state

script.service.hyperion/resources/lib/monitor.py

@@ -25,41 +25,30 @@
 
 from typing import TYPE_CHECKING
 
+from resources.lib.logger import Logger
+
 if TYPE_CHECKING:
     import xbmcaddon
 
 
-class Settings:
+class SettingsManager:
     """Class which contains all addon settings."""
 
-    def __init__(self, settings: xbmcaddon.Settings) -> None:
+    def __init__(self, settings: xbmcaddon.Settings, logger: Logger) -> None:
+        self._logger = logger
         self.rev = 0
         self._settings = settings
-        self.needs_reconnection = False
-        self._address = "localhost"
-        self._port = 19445
-        self.read_settings()
-
-    @property
-    def address(self) -> str:
-        """Hyperion server's hostname or IP-address."""
-        return self._address
-
-    @address.setter
-    def address(self, value: str) -> None:
-        """Hyperion server's hostname or IP-address."""
-        self.needs_reconnection = self._address != value
-        self._address = value
+        self.address = "localhost"
+        self.port = 19445
+        self.enable: bool
+        self.enable_screensaver: bool
+        self.priority: int
+        self.timeout: int
+        self.capture_width: int
+        self.framerate: int
+        self.sleep_time: int
 
-    @property
-    def port(self) -> int:
-        """Hyperion server port."""
-        return self._port
-
-    @port.setter
-    def port(self, value: int) -> None:
-        self.needs_reconnection = self._port != value
-        self._port = value
+        self.read_settings()
 
     def read_settings(self) -> None:
         """Read all settings."""
@@ -74,3 +63,16 @@ def read_settings(self) -> None:
         self.address = settings.getString("hyperion_ip")
         self.port = settings.getInt("hyperion_port")
         self.rev += 1
+        self._log_settings()
+
+    def _log_settings(self) -> None:
+        log = self._logger.debug
+        log("Settings updated!")
+        log(f"Hyperion ip:            {self.address}")
+        log(f"Hyperion port:          {self.port}")
+        log(f"enabled:                {self.enable}")
+        log(f"enabled on screensaver: {self.enable_screensaver}")
+        log(f"priority:               {self.priority}")
+        log(f"timeout:                {self.timeout}")
+        log(f"capture width:          {self.capture_width}")
+        log(f"framerate:              {self.framerate}")

script.service.hyperion/resources/lib/settings.py

@@ -24,17 +24,21 @@
 
 import xbmc
 import xbmcaddon
-from resources.lib.misc import MessageHandler
+from resources.lib.gui import GuiHandler
+from resources.lib.logger import Logger
 from resources.lib.monitor import HyperionMonitor
-from resources.lib.settings import Settings
+from resources.lib.settings import SettingsManager
+
+ADDON_NAME = "script.service.hyperion"
 
 
 def main() -> None:
-    addon = xbmcaddon.Addon()
+    addon = xbmcaddon.Addon(ADDON_NAME)
+    logger = Logger(addon.getAddonInfo("name"))
+    settings_manager = SettingsManager(addon.getSettings(), logger)
     player = xbmc.Player()
-    settings = Settings(addon.getSettings())
-    output_handler = MessageHandler(addon)
-    monitor = HyperionMonitor(settings, player, output_handler)
+    output_handler = GuiHandler(addon, settings_manager)
+    monitor = HyperionMonitor(settings_manager, player, output_handler, logger)
     monitor.main_loop()