clean up with constants and exceptions

dmulcahey · dmulcahey · commit 31c8aded2b47 · 2024-11-13T11:57:36.000-05:00
diff --git a/zha/application/platforms/alarm_control_panel/__init__.py b/zha/application/platforms/alarm_control_panel/__init__.py
@@ -22,6 +22,7 @@
 )
 from zha.application.platforms.model import EntityState
 from zha.application.registries import PLATFORM_ENTITIES
+from zha.websocket.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_IAS_ACE,
     CLUSTER_HANDLER_STATE_CHANGED,
@@ -114,7 +115,7 @@ def __init__(
     def info_object(self) -> AlarmControlPanelEntityInfo:
         """Return a representation of the alarm control panel."""
         return AlarmControlPanelEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"]),
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             code_arm_required=self.code_arm_required,
             code_format=self.code_format,
             supported_features=self.supported_features,
diff --git a/zha/application/platforms/binary_sensor/__init__.py b/zha/application/platforms/binary_sensor/__init__.py
@@ -21,6 +21,7 @@
 from zha.application.platforms.helpers import validate_device_class
 from zha.application.platforms.model import EntityState
 from zha.application.registries import PLATFORM_ENTITIES
+from zha.websocket.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ACCELEROMETER,
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
@@ -97,7 +98,7 @@ def _init_from_quirks_metadata(self, entity_metadata: BinarySensorMetadata) -> N
     def info_object(self) -> BinarySensorEntityInfo:
         """Return a representation of the binary sensor."""
         return BinarySensorEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"]),
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             attribute_name=self._attribute_name,
         )
 
diff --git a/zha/application/platforms/button/__init__.py b/zha/application/platforms/button/__init__.py
@@ -21,6 +21,7 @@
 from zha.application.platforms.const import EntityCategory
 from zha.application.platforms.model import EntityState
 from zha.application.registries import PLATFORM_ENTITIES
+from zha.websocket.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import CLUSTER_HANDLER_IDENTIFY
 
 if TYPE_CHECKING:
@@ -81,7 +82,7 @@ def _init_from_quirks_metadata(
     def info_object(self) -> CommandButtonEntityInfo:
         """Return a representation of the button."""
         return CommandButtonEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"]),
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             command=self._command_name,
             args=self._args,
             kwargs=self._kwargs,
@@ -176,7 +177,7 @@ def _init_from_quirks_metadata(
     def info_object(self) -> WriteAttributeButtonEntityInfo:
         """Return a representation of the button."""
         return WriteAttributeButtonEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"]),
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             attribute_name=self._attribute_name,
             attribute_value=self._attribute_value,
         )
diff --git a/zha/application/platforms/climate/__init__.py b/zha/application/platforms/climate/__init__.py
@@ -44,6 +44,7 @@
 from zha.application.registries import PLATFORM_ENTITIES
 from zha.decorators import periodic
 from zha.units import UnitOfTemperature
+from zha.websocket.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
     CLUSTER_HANDLER_FAN,
@@ -223,7 +224,7 @@ def __init__(
     def info_object(self) -> ThermostatEntityInfo:
         """Return a representation of the thermostat."""
         return ThermostatEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"]),
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             max_temp=self.max_temp,
             min_temp=self.min_temp,
             supported_features=self.supported_features,
diff --git a/zha/application/platforms/cover/__init__.py b/zha/application/platforms/cover/__init__.py
@@ -34,6 +34,7 @@
 )
 from zha.application.registries import PLATFORM_ENTITIES
 from zha.exceptions import ZHAException
+from zha.websocket.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.closures import WindowCoveringClusterHandler
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
@@ -167,7 +168,7 @@ def supported_features(self) -> CoverEntityFeature:
     def info_object(self) -> CoverEntityInfo:
         """Return the info object for this entity."""
         return CoverEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"]),
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             supported_features=self.supported_features,
         )
 
@@ -485,7 +486,7 @@ def __init__(
     def info_object(self) -> ShadeEntityInfo:
         """Return the info object for this entity."""
         return ShadeEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"]),
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             supported_features=self.supported_features,
         )
 
diff --git a/zha/application/platforms/device_tracker/__init__.py b/zha/application/platforms/device_tracker/__init__.py
@@ -19,6 +19,7 @@
 from zha.application.platforms.sensor import Battery
 from zha.application.registries import PLATFORM_ENTITIES
 from zha.decorators import periodic
+from zha.websocket.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
     CLUSTER_HANDLER_POWER_CONFIGURATION,
@@ -104,7 +105,7 @@ def __init__(
     def info_object(self) -> DeviceTrackerEntityInfo:
         """Return a representation of the device tracker."""
         return DeviceTrackerEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"])
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME])
         )
 
     @property
diff --git a/zha/application/platforms/fan/__init__.py b/zha/application/platforms/fan/__init__.py
@@ -39,6 +39,7 @@
 )
 from zha.application.platforms.fan.model import FanEntityInfo, FanState
 from zha.application.registries import PLATFORM_ENTITIES
+from zha.websocket.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers import wrap_zigpy_exceptions
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
@@ -282,7 +283,7 @@ def __init__(
     def info_object(self) -> FanEntityInfo:
         """Return a representation of the binary sensor."""
         return FanEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"]),
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             preset_modes=self.preset_modes,
             supported_features=self.supported_features,
             speed_count=self.speed_count,
@@ -352,7 +353,7 @@ def __init__(self, group: Group):
     def info_object(self) -> FanEntityInfo:
         """Return a representation of the binary sensor."""
         return FanEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"]),
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             preset_modes=self.preset_modes,
             supported_features=self.supported_features,
             speed_count=self.speed_count,
diff --git a/zha/application/platforms/light/__init__.py b/zha/application/platforms/light/__init__.py
@@ -64,6 +64,7 @@
 from zha.application.registries import PLATFORM_ENTITIES
 from zha.debounce import Debouncer
 from zha.decorators import periodic
+from zha.websocket.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
     CLUSTER_HANDLER_COLOR,
@@ -778,7 +779,7 @@ def __init__(
     def info_object(self) -> LightEntityInfo:
         """Return a representation of the select."""
         return LightEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"]),
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             effect_list=self.effect_list,
             supported_features=self.supported_features,
             min_mireds=self.min_mireds,
@@ -1148,7 +1149,7 @@ def __init__(self, group: Group):
     def info_object(self) -> LightEntityInfo:
         """Return a representation of the select."""
         return LightEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"]),
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             effect_list=self.effect_list,
             supported_features=self.supported_features,
             min_mireds=self.min_mireds,
diff --git a/zha/application/platforms/lock/__init__.py b/zha/application/platforms/lock/__init__.py
@@ -18,6 +18,7 @@
 )
 from zha.application.platforms.lock.model import LockEntityInfo, LockState
 from zha.application.registries import PLATFORM_ENTITIES
+from zha.websocket.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
     CLUSTER_HANDLER_DOORLOCK,
@@ -97,7 +98,7 @@ def __init__(
     def info_object(self) -> LockEntityInfo:
         """Return a representation of the lock."""
         return LockEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"])
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME])
         )
 
     @property
diff --git a/zha/application/platforms/number/__init__.py b/zha/application/platforms/number/__init__.py
@@ -29,6 +29,7 @@
 )
 from zha.application.registries import PLATFORM_ENTITIES
 from zha.units import UnitOfMass, UnitOfTemperature, UnitOfTime, validate_unit
+from zha.websocket.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ANALOG_OUTPUT,
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
@@ -131,7 +132,7 @@ def __init__(
     def info_object(self) -> NumberEntityInfo:
         """Return a representation of the number entity."""
         return NumberEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"]),
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             engineering_units=self._analog_output_cluster_handler.engineering_units,
             application_type=self._analog_output_cluster_handler.application_type,
             min_value=self.native_min_value,
@@ -310,7 +311,7 @@ def _init_from_quirks_metadata(self, entity_metadata: NumberMetadata) -> None:
     def info_object(self) -> NumberConfigurationEntityInfo:
         """Return a representation of the number entity."""
         return NumberConfigurationEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"]),
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             min_value=self._attr_native_min_value,
             max_value=self._attr_native_max_value,
             step=self._attr_native_step,
diff --git a/zha/application/platforms/select/__init__.py b/zha/application/platforms/select/__init__.py
@@ -31,6 +31,7 @@
     SelectEntityInfo,
 )
 from zha.application.registries import PLATFORM_ENTITIES
+from zha.websocket.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
     CLUSTER_HANDLER_HUE_OCCUPANCY,
@@ -100,7 +101,7 @@ def __init__(
     def info_object(self) -> EnumSelectEntityInfo:
         """Return a representation of the select."""
         return EnumSelectEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"]),
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             enum=self._enum.__name__,
             options=self._attr_options,
         )
@@ -243,7 +244,7 @@ def _init_from_quirks_metadata(self, entity_metadata: ZCLEnumMetadata) -> None:
     def info_object(self) -> EnumSelectEntityInfo:
         """Return a representation of the select."""
         return EnumSelectEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"]),
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             enum=self._enum.__name__,
             options=self._attr_options,
         )
diff --git a/zha/application/platforms/sensor/__init__.py b/zha/application/platforms/sensor/__init__.py
@@ -71,6 +71,7 @@
     UnitOfVolumeFlowRate,
     validate_unit,
 )
+from zha.websocket.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ANALOG_INPUT,
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
@@ -214,7 +215,7 @@ def _init_from_quirks_metadata(self, entity_metadata: ZCLSensorMetadata) -> None
     def info_object(self) -> SensorEntityInfo:
         """Return a representation of the sensor."""
         return SensorEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"]),
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             attribute=self._attribute_name,
             decimals=self._decimals,
             divisor=self._divisor,
@@ -413,7 +414,7 @@ def identifiers(self) -> DeviceCounterSensorIdentifiers:
     @property
     def info_object(self) -> DeviceCounterSensorEntityInfo:
         """Return a representation of the platform entity."""
-        data = super().info_object.model_dump(exclude=["model_class_name"])
+        data = super().info_object.model_dump(exclude=[MODEL_CLASS_NAME])
         data.pop("device_ieee")
         data.pop("available")
         return DeviceCounterSensorEntityInfo(
@@ -571,7 +572,7 @@ def formatter(value: int) -> int | None:  # pylint: disable=arguments-differ
     def info_object(self) -> BatteryEntityInfo:
         """Return a representation of the sensor."""
         return BatteryEntityInfo(
-            **super(Sensor, self).info_object.model_dump(exclude=["model_class_name"]),
+            **super(Sensor, self).info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             attribute=self._attribute_name,
             decimals=self._decimals,
             divisor=self._divisor,
@@ -637,7 +638,7 @@ def __init__(
     def info_object(self) -> ElectricalMeasurementEntityInfo:
         """Return a representation of the sensor."""
         return ElectricalMeasurementEntityInfo(
-            **super(Sensor, self).info_object.model_dump(exclude=["model_class_name"]),
+            **super(Sensor, self).info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             attribute=self._attribute_name,
             decimals=self._decimals,
             divisor=self._divisor,
@@ -914,7 +915,7 @@ def __init__(
     def info_object(self) -> SmartEnergyMeteringEntityInfo:
         """Return a representation of the sensor."""
         return SmartEnergyMeteringEntityInfo(
-            **super(Sensor, self).info_object.model_dump(exclude=["model_class_name"]),
+            **super(Sensor, self).info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             attribute=self._attribute_name,
             decimals=self._decimals,
             divisor=self._divisor,
@@ -1734,7 +1735,7 @@ class SetpointChangeSourceTimestamp(TimestampSensor):
     def info_object(self) -> SetpointChangeSourceTimestampSensorEntityInfo:
         """Return the info object for this entity."""
         return SetpointChangeSourceTimestampSensorEntityInfo(
-            **super(Sensor, self).info_object.model_dump(exclude=["model_class_name"]),
+            **super(Sensor, self).info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             attribute=self._attribute_name,
             decimals=self._decimals,
             divisor=self._divisor,
diff --git a/zha/application/platforms/siren/__init__.py b/zha/application/platforms/siren/__init__.py
@@ -35,6 +35,7 @@
 )
 from zha.application.platforms.siren.model import SirenEntityInfo
 from zha.application.registries import PLATFORM_ENTITIES
+from zha.websocket.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import CLUSTER_HANDLER_IAS_WD
 from zha.zigbee.cluster_handlers.security import IasWdClusterHandler
 
@@ -110,7 +111,7 @@ def __init__(
     def info_object(self) -> SirenEntityInfo:
         """Return representation of the siren."""
         return SirenEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"]),
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             available_tones=self._attr_available_tones,
             supported_features=self._attr_supported_features,
         )
diff --git a/zha/application/platforms/switch/__init__.py b/zha/application/platforms/switch/__init__.py
@@ -28,6 +28,7 @@
     SwitchState,
 )
 from zha.application.registries import PLATFORM_ENTITIES
+from zha.websocket.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
     CLUSTER_HANDLER_BASIC,
@@ -131,7 +132,7 @@ def __init__(
     def info_object(self) -> SwitchEntityInfo:
         """Return representation of the switch entity."""
         return SwitchEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"]),
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
         )
 
     @property
@@ -163,7 +164,7 @@ def __init__(self, group: Group):
     def info_object(self) -> SwitchEntityInfo:
         """Return representation of the switch entity."""
         return SwitchEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"]),
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
         )
 
     @property
@@ -278,7 +279,7 @@ def _init_from_quirks_metadata(self, entity_metadata: SwitchMetadata) -> None:
     def info_object(self) -> ConfigurableAttributeSwitchEntityInfo:
         """Return representation of the switch configuration entity."""
         return ConfigurableAttributeSwitchEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"]),
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             attribute_name=self._attribute_name,
             invert_attribute_name=self._inverter_attribute_name,
             force_inverted=self._force_inverted,
diff --git a/zha/application/platforms/update/__init__.py b/zha/application/platforms/update/__init__.py
@@ -32,6 +32,7 @@
 )
 from zha.application.registries import PLATFORM_ENTITIES
 from zha.exceptions import ZHAException
+from zha.websocket.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
     CLUSTER_HANDLER_OTA,
@@ -167,7 +168,7 @@ def __init__(
     def info_object(self) -> FirmwareUpdateEntityInfo:
         """Return a representation of the entity."""
         return FirmwareUpdateEntityInfo(
-            **super().info_object.model_dump(exclude=["model_class_name"]),
+            **super().info_object.model_dump(exclude=[MODEL_CLASS_NAME]),
             supported_features=self.supported_features,
         )
 
diff --git a/zha/model.py b/zha/model.py
@@ -20,6 +20,7 @@
 from zigpy.types.named import EUI64, NWK
 
 from zha.event import EventBase
+from zha.websocket.const import MODEL_CLASS_NAME
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -138,7 +139,7 @@ class to be instantiated is given by the model_class_name field, and the remaini
             case TypedBaseModel():
                 return x.__class__.__name__
             case dict() as serialized:
-                return serialized.pop("model_class_name", None)
+                return serialized.pop(MODEL_CLASS_NAME, None)
             case _:
                 return None
 
diff --git a/zha/websocket/client/client.py b/zha/websocket/client/client.py
diff --git a/zha/websocket/client/helpers.py b/zha/websocket/client/helpers.py
diff --git a/zha/websocket/const.py b/zha/websocket/const.py
diff --git a/zha/websocket/server/client.py b/zha/websocket/server/client.py
