ucapi-framework 1.9.0b3__tar.gz → 1.9.0b4__tar.gz

{ucapi_framework-1.9.0b3 → ucapi_framework-1.9.0b4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ucapi-framework
-Version: 1.9.0b3
+Version: 1.9.0b4
 Summary: ucapi framework that provides core functionality for building integrations.
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown

{ucapi_framework-1.9.0b3 → ucapi_framework-1.9.0b4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ucapi-framework"
-version = "1.9.0b3"
+version = "1.9.0b4"
 description = "ucapi framework that provides core functionality for building integrations."
 readme = "README.md"
 requires-python = ">=3.11"

{ucapi_framework-1.9.0b3 → ucapi_framework-1.9.0b4}/ucapi_framework/driver.py

@@ -594,8 +594,8 @@ class BaseIntegrationDriver(Generic[DeviceT, ConfigT]):
             cast(FrameworkEntity, configured_entity) if has_update else None
         )
 
-        # Short-circuit: if entity has overridden sync_state(), delegate entirely to it.
-        # This is the coordinator pattern — the entity knows how to read its own device.
+        # Coordinator pattern: entity owns its state via sync_state() + subscribe_to_device().
+        # Call sync_state() directly and skip all legacy attribute-routing paths.
         if (
             framework_entity
             and type(framework_entity).sync_state is not FrameworkEntity.sync_state
@@ -1216,9 +1216,10 @@ class BaseIntegrationDriver(Generic[DeviceT, ConfigT]):
         """
         Handle device connection.
 
-        Sets integration device state to CONNECTED and refreshes all entity states
-        for this device. This ensures entity states are updated after the device
-        has connected and populated its attributes via get_device_attributes().
+        Sets integration device state to CONNECTED and refreshes state for legacy-pattern
+        entities. Coordinator-pattern entities (those with ``sync_state()`` overridden)
+        are skipped here — they receive state via ``push_update()`` emitted by the
+        device's own ``connect()`` implementation, avoiding a redundant double-sync.
 
         :param device_id: Device identifier
         """
@@ -1230,8 +1231,13 @@ class BaseIntegrationDriver(Generic[DeviceT, ConfigT]):
 
         await self.api.set_device_state(ucapi.DeviceStates.CONNECTED)
 
-        # Refresh entity states now that device is connected and has populated attributes
         for entity_id in self.get_entity_ids_for_device(device_id):
+            configured_entity = self.api.configured_entities.get(entity_id)
+            if isinstance(configured_entity, FrameworkEntity) and (
+                type(configured_entity).sync_state is not FrameworkEntity.sync_state
+            ):
+                # Coordinator pattern: entity syncs via push_update() from device.connect()
+                continue
             await self.refresh_entity_state(entity_id)
 
     async def on_device_disconnected(self, device_id: str) -> None:

{ucapi_framework-1.9.0b3 → ucapi_framework-1.9.0b4}/ucapi_framework/entity.py

@@ -173,6 +173,10 @@ class Entity(ABC):
         :param update: dictionary containing the updated properties.
         :param force: if True, update attributes even if they haven't changed.
         """
+        # Skip entirely if this entity is not configured on the Remote.
+        if not self._api.configured_entities.contains(self._framework_entity_id):
+            return
+
         # Strip None values - they represent attributes that have never been set
         # and should not be sent to the Remote. Empty strings and False are valid.
         update = {k: v for k, v in update.items() if v is not None}
@@ -289,8 +293,9 @@ class Entity(ABC):
             def on_device_disconnected(self):
                 self.set_unavailable()
         """
-        self.attributes[media_player.Attributes.STATE] = media_player.States.UNAVAILABLE  # type: ignore[attr-defined]
-        self.update(self.attributes)  # type: ignore[no-member]
+        # All ucapi States enums share the same UNAVAILABLE string value,
+        # so media_player.States.UNAVAILABLE works as a proxy for all entity types.
+        self.update({media_player.Attributes.STATE: media_player.States.UNAVAILABLE})
 
     def subscribe_to_device(self, device: "BaseDeviceInterface") -> None:
         """
@@ -317,11 +322,10 @@ class Entity(ABC):
                     self.subscribe_to_device(device)
 
                 async def sync_state(self) -> None:
-                    self.attributes[light.Attributes.STATE] = self.map_entity_states(
-                        self._device.state
-                    )
-                    self.attributes[light.Attributes.BRIGHTNESS] = self._device.brightness
-                    self.update(self.attributes)
+                    self.update({
+                        light.Attributes.STATE: self.map_entity_states(self._device.state),
+                        light.Attributes.BRIGHTNESS: self._device.brightness,
+                    })
         """
         from .device import DeviceEvents  # local import to avoid circular dependency
 
@@ -335,9 +339,9 @@ class Entity(ABC):
         """
         Sync entity state from device to Remote.
 
-        Override this method to read current values from ``self._device``,
-        write them into ``self.attributes``, and call ``self.update(self.attributes)``
-        to push the state to the Remote.
+        Override this method to read current values from ``self._device`` and call
+        ``self.update()`` with a **fresh dict or dataclass** — do not mutate
+        ``self.attributes`` directly, as that would defeat change-filtering.
 
         The framework calls this method automatically in two situations:
 
@@ -351,14 +355,21 @@ class Entity(ABC):
         manages its own state (i.e. the developer is not using the driver's
         default ``on_device_update`` attribute-routing logic).
 
-        Example::
+        Example with dict::
 
             async def sync_state(self) -> None:
-                self.attributes[light.Attributes.STATE] = self.map_entity_states(
-                    self._device.state
-                )
-                self.attributes[light.Attributes.BRIGHTNESS] = self._device.brightness
-                self.update(self.attributes)
+                self.update({
+                    light.Attributes.STATE: self.map_entity_states(self._device.state),
+                    light.Attributes.BRIGHTNESS: self._device.brightness,
+                })
+
+        Example with dataclass (recommended)::
+
+            async def sync_state(self) -> None:
+                self.update(LightAttributes(
+                    STATE=self.map_entity_states(self._device.state),
+                    BRIGHTNESS=self._device.brightness,
+                ))
         """
         # No-op by default. Subclasses override to pull from device and push to Remote.
 

{ucapi_framework-1.9.0b3 → ucapi_framework-1.9.0b4}/ucapi_framework.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ucapi-framework
-Version: 1.9.0b3
+Version: 1.9.0b4
 Summary: ucapi framework that provides core functionality for building integrations.
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown