Merge pull request #3238 from bramstroker/fix/model-list-sort

fix model listing in GUI is sorted correctly

Author: bramstroker

custom_components/powercalc/power_profile/library.py

@@ -29,7 +29,7 @@ def __init__(self, hass: HomeAssistant, loader: Loader) -> None:
         self._hass = hass
         self._loader = loader
         self._profiles: dict[str, list[PowerProfile]] = {}
-        self._manufacturer_models: dict[str, list[str]] = {}
+        self._manufacturer_models: dict[str, set[str]] = {}
         self._manufacturer_device_types: dict[str, list] = {}
 
     async def initialize(self) -> None:
@@ -71,24 +71,24 @@ async def get_manufacturer_listing(self, device_types: set[DeviceType] | None =
         manufacturers = await self._loader.get_manufacturer_listing(device_types)
         return sorted(manufacturers)
 
-    async def get_model_listing(self, manufacturer: str, device_types: set[DeviceType] | None = None) -> list[str]:
+    async def get_model_listing(self, manufacturer: str, device_types: set[DeviceType] | None = None) -> set[str]:
         """Get listing of available models for a given manufacturer."""
 
         resolved_manufacturers = await self._loader.find_manufacturers(manufacturer)
         if not resolved_manufacturers:
-            return []
-        all_models: list[str] = []
+            return set()
+        all_models: set[str] = set()
         for manufacturer in resolved_manufacturers:
             cache_key = f"{manufacturer}/{device_types}"
             cached_models = self._manufacturer_models.get(cache_key)
             if cached_models:
-                all_models.extend(cached_models)
+                all_models.update(cached_models)
                 continue
             models = await self._loader.get_model_listing(manufacturer, device_types)
-            self._manufacturer_models[cache_key] = sorted(models)
-            all_models.extend(models)
+            self._manufacturer_models[cache_key] = models
+            all_models.update(models)
 
-        return all_models
+        return set(sorted(all_models))  # noqa: C414
 
     async def get_profile(
         self,

tests/power_profile/loader/test_remote.py

@@ -562,7 +562,7 @@ async def test_multiple_manufacturer_aliases(hass: HomeAssistant, mock_aiorespon
     assert manufacturers == {"manufacturer1", "manufacturer2"}
 
     model_listing = await library.get_model_listing("my-alias", {DeviceType.LIGHT})
-    assert len(model_listing) == 2
+    assert len(model_listing) == 1  # Because it's a set model1 should only be listed once
 
     models = await library.find_models(ModelInfo("my-alias", "model1"))
     assert models == {ModelInfo("manufacturer1", "model1"), ModelInfo("manufacturer2", "model1")}

tests/power_profile/test_library.py

@@ -40,6 +40,12 @@ async def test_model_listing(hass: HomeAssistant, manufacturer: str, expected_mo
         assert model in models
 
 
+async def test_model_listing_sorted(hass: HomeAssistant) -> None:
+    library = await ProfileLibrary.factory(hass)
+    models = await library.get_model_listing("signify")
+    assert models == set(sorted(models))  # noqa: C414
+
+
 @pytest.mark.parametrize(
     "model_info,expected_models",
     [