Refactor CI workflow and improve code structure; update dependencies and enhance test coverage

Author: samclane

.github/workflows/main.yml

@@ -50,33 +50,25 @@ jobs:
   test:
     runs-on: windows-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python 3.8
-        uses: actions/setup-python@v1
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
         with:
-          python-version: '3.8.x' # Semantic version range syntax or exact version of a Python version
-          architecture: 'x64'
-      - name: Cache pip
-        uses: actions/cache@v1
-        with:
-          path: ~/.cache/pip # This path is specific to Ubuntu
-          # Look to see if there is a cache hit for the corresponding requirements file
-          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
-            ${{ runner.os }}-
+          python-version: '3.14'
+          cache: 'pip'
+      - name: Install deps
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt -r requirements-dev.txt
       - name: Test Project
+        working-directory: ./lifx_control_panel
         run: |
-          pip3 install --user -r requirements.txt
-          pip3 install --user -r requirements-dev.txt
-          cd ./lifx_control_panel
-          set PYTHONPATH=.
           coverage run -m unittest discover test -p "*test*.py"
           coverage report
           coverage xml -o coverage.xml
-          cd ..
       - name: Upload Coverage to Codecov
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v5
         with:
           files: ./lifx_control_panel/coverage.xml
-          flags: unittests
+          flags: unittests
+          fail_ci_if_error: false

lifx_control_panel/__main__.pyw

@@ -27,7 +27,7 @@ if os.name == 'nt':
 
 from lifx_control_panel import HEARTBEAT_RATE_MS, FRAME_PERIOD_MS, LOGFILE
 from lifx_control_panel._constants import BUILD_DATE, AUTHOR, DEBUGGING, VERSION
-from lifx_control_panel.frames import LightFrame, MultiZoneFrame, GroupFrame
+from lifx_control_panel.frames import LightFrame, GroupFrame
 from lifx_control_panel.ui import settings
 from lifx_control_panel.ui.icon_list import BulbIconList
 from lifx_control_panel.ui.settings import config
@@ -116,23 +116,16 @@ class LifxFrame(ttk.Frame):  # pylint: disable=too-many-ancestors
         self.group_icons.canvas.bind('<Button-1>', self.on_bulb_canvas_click)
 
         # Setup tray icon
-        def lambda_quit(self_):
-            """ Build an anonymous function call w/ correct 'self' scope"""
-            return lambda *_, **__: self_.on_closing()
-
-        def lambda_adjust(self_):
-            return lambda *_, **__: self_.master.deiconify()
-
         def run_tray_icon():
             """ Allow SysTrayIcon in a separate thread """
             image = Image.open(resource_path('res/icon_vector.ico'))
 
             icon = pystray.Icon("LIFX Control Panel", image, menu=pystray.Menu(
                 pystray.MenuItem('Open',
-                                 lambda_adjust(self),
+                                 lambda *_, **__: self.master.deiconify(),
                                  default=True),
                 pystray.MenuItem('Quit',
-                                 lambda_quit(self)),
+                                 lambda *_, **__: self.on_closing()),
             ))
             icon.run()
 
@@ -165,8 +158,6 @@ class LifxFrame(ttk.Frame):  # pylint: disable=too-many-ancestors
         if not stop_event.is_set():
             stop_event.set()
         device_list: List[Union[lifxlan.Group, lifxlan.Light, lifxlan.MultiZoneLight]] = self.lifx.get_devices()
-        if self.bulb_interface:
-            del self.bulb_interface
         self.bulb_interface = AsyncBulbInterface(stop_event, HEARTBEAT_RATE_MS)
         self.bulb_interface.set_device_list(device_list)
         self.bulb_interface.daemon = True
@@ -184,10 +175,8 @@ class LifxFrame(ttk.Frame):  # pylint: disable=too-many-ancestors
                 if label not in self.bulb_icons.bulb_dict:
                     self.bulb_icons.draw_bulb_icon(light, label)
                 if label not in self.frame_map:
-                    if light.supports_multizone():
-                        self.frame_map[label] = MultiZoneFrame(self, light)
-                    else:
-                        self.frame_map[label] = LightFrame(self, light)
+                    # LightFrame._get_light_info already handles multizone devices
+                    self.frame_map[label] = LightFrame(self, light)
                     self.current_lightframe = self.frame_map[label]
                     try:
                         self.bulb_icons.set_selected_bulb(label)
@@ -260,13 +249,9 @@ class LifxFrame(ttk.Frame):  # pylint: disable=too-many-ancestors
 
     def save_keybind(self, light, keypress, color):
         """ Builds a new anonymous function changing light to color when keypress is entered. """
-
-        def lambda_factory(self, light, color):
-            """ https://stackoverflow.com/questions/938429/scope-of-lambda-functions-and-their-parameters """
-            return lambda *_, **__: self.device_map[light].set_color(color,
-                                                                     duration=float(config["AverageColor"]["duration"]))
-
-        func = lambda_factory(self, light, color)
+        # default args bind light/color now, not at call time
+        func = lambda *_, light=light, color=color, **__: self.device_map[light].set_color(
+            color, duration=float(config["AverageColor"]["duration"]))
         self.key_listener.register_function(keypress, func)
 
     def delete_keybind(self, keycombo):

lifx_control_panel/frames.py

@@ -3,7 +3,6 @@
 from tkinter import ttk, font as font, messagebox, _setit
 from typing import Union, List, Tuple, Dict, Mapping
 
-import mouse
 import lifxlan
 import win32api
 
@@ -544,20 +543,12 @@ def set_color(self, color, rapid=False):
                 "Color changed to HSBK: %s", color
             )  # Don't pollute log with rapid color changes
 
-    def update_label(self, key: int):
+    def update_label(self):
         """ Update scale labels, formatted accordingly. """
-        return [
-            self.hsbk_labels[0].config(
-                text=str(f"{360 * (self.hsbk[0].get() / 65535):.3g}")
-            ),
-            self.hsbk_labels[1].config(
-                text=str(f"{100 * (self.hsbk[1].get() / 65535):.3g}") + "%"
-            ),
-            self.hsbk_labels[2].config(
-                text=str(f"{100 * (self.hsbk[2].get() / 65535):.3g}") + "%"
-            ),
-            self.hsbk_labels[3].config(text=str(self.hsbk[3].get()) + " K"),
-        ][key]
+        self.hsbk_labels[0].config(text=f"{360 * (self.hsbk[0].get() / 65535):.3g}")
+        self.hsbk_labels[1].config(text=f"{100 * (self.hsbk[1].get() / 65535):.3g}%")
+        self.hsbk_labels[2].config(text=f"{100 * (self.hsbk[2].get() / 65535):.3g}%")
+        self.hsbk_labels[3].config(text=f"{self.hsbk[3].get()} K")
 
     def update_display(self, key: int):
         """ Update color swatches to match current device state """
@@ -632,8 +623,8 @@ def update_status_from_bulb(self, run_once=False):
             require_icon_update = True
             for key, _ in enumerate(self.hsbk):
                 self.hsbk[key].set(hsbk[key])
-                self.update_label(key)
                 self.update_display(key)
+            self.update_label()
             self.current_color.config(background=tuple2hex(hsbk_to_rgb(hsbk)))
 
         if require_icon_update:
@@ -656,7 +647,7 @@ def eyedropper(self, *_, **__):
             lifxlan.sleep(0.001)
         # tkinter.Button state changed
         screen_img = get_screen_as_image()
-        cursor_pos = mouse.get_position()
+        cursor_pos = win32api.GetCursorPos()
         # Convert display coords to image coords
         cursor_pos = normalize_rectangles(
             get_display_rects() + [(cursor_pos[0], cursor_pos[1], 0, 0)]
@@ -752,7 +743,3 @@ def _get_light_info(self, target: lifxlan.Group) -> Tuple[int, Color]:
 
     def update_status_from_bulb(self, run_once=False):
         return
-
-
-class MultiZoneFrame(LightFrame):
-    pass

lifx_control_panel/test/color_thread_test.py

@@ -0,0 +1,69 @@
+import os
+import sys
+import unittest
+
+# color_thread uses package-relative imports, so make the repo root importable
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), "..", ".."))
+
+from lifx_control_panel.utilities.color_thread import (
+    ColorCycle,
+    get_monitor_bounds,
+    normalize_rectangles,
+)
+from lifx_control_panel.utilities.utils import Color
+
+
+class TestNormalizeRectangles(unittest.TestCase):
+    def test_shifts_origin_to_zero(self):
+        rects = [(-1920, 0, 0, 1080), (0, 0, 1920, 1080)]
+        self.assertEqual(
+            normalize_rectangles(rects),
+            [(0, 0, 1920, 1080), (1920, 0, 3840, 1080)],
+        )
+
+    def test_already_normalized_is_unchanged(self):
+        rects = [(0, 0, 800, 600)]
+        self.assertEqual(normalize_rectangles(rects), rects)
+
+
+class TestGetMonitorBounds(unittest.TestCase):
+    def test_uses_func_result_when_truthy(self):
+        self.assertEqual(get_monitor_bounds(lambda: "[0, 0, 100, 100]"), "[0, 0, 100, 100]")
+
+
+class TestColorCycle(unittest.TestCase):
+    def _tick(self, cycle):
+        # Backdate the throttle so get_color advances immediately
+        cycle.last_change = 0
+        return cycle.get_color()
+
+    def test_respects_brightness(self):
+        cycle = ColorCycle()
+        cycle.initial_color = Color(0, 65535, 0, 3500)
+        hsbk = self._tick(cycle)
+        self.assertEqual(hsbk[2], 0)  # zero input brightness stays dark
+
+        cycle.initial_color = Color(0, 65535, 65535, 3500)
+        hsbk = self._tick(cycle)
+        self.assertEqual(hsbk[2], 65535)
+
+    def test_hue_advances_and_wraps(self):
+        cycle = ColorCycle()
+        cycle.initial_color = Color(0, 65535, 65535, 3500)
+        cycle.pos = 359
+        self._tick(cycle)
+        self.assertEqual(cycle.pos, 0)
+        self._tick(cycle)
+        self.assertEqual(cycle.pos, 1)
+
+    def test_throttles_within_interval(self):
+        cycle = ColorCycle()
+        cycle.initial_color = Color(0, 65535, 65535, 3500)
+        self._tick(cycle)
+        pos = cycle.pos
+        cycle.get_color()  # last_change is fresh, so no advance
+        self.assertEqual(cycle.pos, pos)
+
+
+if __name__ == "__main__":
+    unittest.main()

lifx_control_panel/test/dummy_devices.py

@@ -2,6 +2,7 @@
 
 import logging
 import os
+import sys
 import time
 import traceback
 from tkinter import *
@@ -240,16 +241,16 @@ def set_infared(self, val: int):
         self.infared_brightness = val
 
     def set_hue(self, hue, duration=0, rapid=False):
-        self.color.hue = hue
+        self.color = self.color._replace(hue=hue)
 
     def set_brightness(self, brightness, duration=0, rapid=False):
-        self.color.brightness = brightness
+        self.color = self.color._replace(brightness=brightness)
 
     def set_saturation(self, saturation, duration=0, rapid=False):
-        self.color.saturation = saturation
+        self.color = self.color._replace(saturation=saturation)
 
     def set_colortemp(self, kelvin, duration=0, rapid=False):
-        self.color.kelvin = kelvin
+        self.color = self.color._replace(kelvin=kelvin)
 
 
 class MultiZoneDummy(DummyBulb):

lifx_control_panel/test/functional_test.py

@@ -3,6 +3,7 @@
     Color,
     hsbk_to_rgb,
     hsv_to_rgb,
+    kelvin_to_rgb,
     tuple2hex,
     str2list,
     str2tuple,
@@ -28,14 +29,7 @@ def test_color(self):
         c2 = Color(65535, 65535, 65535, 9000)
         self._cmp_color(c2, 65535, 65535, 65535, 9000)
 
-        c3 = c1 + c2
-        self._cmp_color(c3, 65535, 65535, 65535, 9000)
-
-        self.assertEqual(c3 - c2, c1)
-
-        self.assertEqual(str(c1), "[0, 0, 0, 0]")
-
-        c3[0] = 12345
+        c3 = c2._replace(hue=12345)
         self._cmp_color(c3, 12345, 65535, 65535, 9000)
 
         for i, v in enumerate(c3):
@@ -49,6 +43,33 @@ def test_conversion(self):
         hsv1 = hsv_to_rgb(*(0, 0, 0))
         self.assertEqual(hsv1, rgb1)
 
+    def test_hsbk_to_rgb_hues(self):
+        # Pure hues at full saturation/brightness, neutral kelvin
+        self.assertEqual(hsbk_to_rgb(Color(0, 65535, 65535, 3500)), (255, 0, 0))
+        self.assertEqual(hsbk_to_rgb(Color(21845, 65535, 65535, 3500)), (0, 255, 0))
+        self.assertEqual(hsbk_to_rgb(Color(43690, 65535, 65535, 3500)), (0, 0, 255))
+
+    def test_hsbk_to_rgb_brightness(self):
+        # Half brightness halves the output
+        self.assertEqual(hsbk_to_rgb(Color(0, 65535, 32768, 3500)), (127, 0, 0))
+
+    def test_hsbk_to_rgb_desaturated(self):
+        # Zero saturation falls through to the kelvin white point
+        self.assertEqual(
+            hsbk_to_rgb(Color(0, 0, 65535, 6500)), kelvin_to_rgb(6500)
+        )
+
+    def test_kelvin_to_rgb(self):
+        # Known white points: warm is red-heavy, cool is blue-heavy
+        self.assertEqual(kelvin_to_rgb(1500), (255, 108, 0))
+        self.assertEqual(kelvin_to_rgb(3500), (255, 192, 140))
+        self.assertEqual(kelvin_to_rgb(6500), (255, 254, 250))
+        self.assertEqual(kelvin_to_rgb(9000), (209, 222, 255))
+        # Every component stays in displayable range across the LIFX span
+        for kelvin in range(1500, 9001, 500):
+            for component in kelvin_to_rgb(kelvin):
+                self.assertTrue(0 <= component <= 255, f"{kelvin}K -> {component}")
+
     def test_str_conversion(self):
         rgb1 = (1, 2, 3)
         self.assertEqual(tuple2hex(rgb1), "#010203")

lifx_control_panel/ui/colorscale.py

@@ -61,7 +61,6 @@ def __init__(
 
         self.bind("<Configure>", lambda _: self._draw_gradient(val))
         self.bind("<ButtonPress-1>", self._on_click)
-        # self.bind('<ButtonRelease-1>', self._on_release)
         self.bind("<B1-Motion>", self._on_move)
 
     def _draw_gradient(self, val):