avoid imports outside top level and put models in correct module

Author: dmulcahey

tests/conftest.py

@@ -29,7 +29,7 @@
     WebSocketClientGateway,
     WebSocketServerGateway,
 )
-from zha.application.helpers import (
+from zha.application.model import (
     AlarmControlPanelOptions,
     CoordinatorConfiguration,
     LightOptions,

tests/test_discover.py

@@ -52,7 +52,7 @@
 from zha.application import Platform, discovery
 from zha.application.discovery import ENDPOINT_PROBE, EndpointProbe
 from zha.application.gateway import Gateway
-from zha.application.helpers import DeviceOverridesConfiguration
+from zha.application.model import DeviceOverridesConfiguration
 from zha.application.platforms import binary_sensor, sensor
 from zha.application.registries import SINGLE_INPUT_CLUSTER_DEVICE_CLASS
 from zha.zigbee.cluster_handlers import ClusterHandler

tests/test_gateway.py

@@ -33,7 +33,7 @@
     RawDeviceInitializedDeviceInfo,
     RawDeviceInitializedEvent,
 )
-from zha.application.helpers import ZHAData
+from zha.application.model import ZHAData
 from zha.application.platforms import GroupEntity
 from zha.application.platforms.light.const import EFFECT_OFF, LightEntityFeature
 from zha.zigbee.device import Device

tests/websocket/test_websocket_server_client.py

@@ -8,7 +8,7 @@
 
 from tests.conftest import CombinedWebsocketGateways
 from zha.application.gateway import WebSocketClientGateway, WebSocketServerGateway
-from zha.application.helpers import ZHAData
+from zha.application.model import ZHAData
 from zha.websocket import ZHAWebSocketException
 from zha.websocket.client.client import Client
 from zha.websocket.client.helpers import ClientHelper

zha/application/discovery.py

@@ -22,7 +22,6 @@
 from zigpy.zcl.clusters.general import Ota
 
 from zha.application import Platform, const as zha_const
-from zha.application.helpers import DeviceOverridesConfiguration
 from zha.application.platforms import (  # noqa: F401 pylint: disable=unused-import
     alarm_control_panel,
     binary_sensor,
@@ -108,6 +107,7 @@
 
 if TYPE_CHECKING:
     from zha.application.gateway import Gateway
+    from zha.application.model import DeviceOverridesConfiguration
     from zha.zigbee.device import Device
     from zha.zigbee.endpoint import Endpoint
 

zha/application/gateway.py

@@ -51,7 +51,7 @@
     ZHA_GW_MSG_RAW_INIT,
     RadioType,
 )
-from zha.application.helpers import DeviceAvailabilityChecker, GlobalUpdater, ZHAData
+from zha.application.helpers import DeviceAvailabilityChecker, GlobalUpdater
 from zha.application.model import (
     ConnectionLostEvent,
     DeviceFullyInitializedEvent,
@@ -69,6 +69,7 @@
     GroupRemovedEvent,
     RawDeviceInitializedDeviceInfo,
     RawDeviceInitializedEvent,
+    ZHAData,
 )
 from zha.application.platforms.websocket_api import load_platform_entity_apis
 from zha.application.websocket_api import load_api as load_zigbee_controller_api
@@ -78,6 +79,7 @@
     gather_with_limited_concurrency,
 )
 from zha.event import EventBase
+from zha.model import BaseEvent
 from zha.websocket import ZHAWebSocketException
 from zha.websocket.client.client import Client
 from zha.websocket.client.helpers import (
@@ -173,6 +175,10 @@ async def async_remove_zigpy_group(self, group_id: int) -> None:
     async def shutdown(self) -> None:
         """Stop ZHA Controller Application."""
 
+    @abstractmethod
+    def broadcast_event(self, event: BaseEvent) -> None:
+        """Broadcast an event to all listeners."""
+
 
 class Gateway(AsyncUtilMixin, BaseGateway):
     """Gateway that handles events that happen on the ZHA Zigbee network."""
@@ -800,6 +806,9 @@ def handle_message(  # pylint: disable=unused-argument
             self.devices[sender.ieee].on_network = True
             self.async_update_device(sender, available=True)
 
+    def broadcast_event(self, event: BaseEvent) -> None:
+        """Broadcast an event to all listeners."""
+
 
 class WebSocketServerGateway(Gateway):
     """ZHA websocket server implementation."""
@@ -897,6 +906,10 @@ async def __aexit__(
         await self.stop_server()
         await self.wait_closed()
 
+    def broadcast_event(self, event: BaseEvent) -> None:
+        """Broadcast an event to all listeners."""
+        self.emit(event.event, event)
+
     def _register_api_commands(self) -> None:
         """Load server API commands."""
 
@@ -1199,3 +1212,6 @@ def handle_group_removed(self, event: GroupRemovedEvent) -> None:
 
     def connection_lost(self, exc: Exception) -> None:
         """Handle connection lost event."""
+
+    def broadcast_event(self, event: BaseEvent) -> None:
+        """Broadcast an event to all listeners."""

zha/application/helpers.py

@@ -4,18 +4,13 @@
 
 import asyncio
 import binascii
-import collections
 from collections.abc import Callable
-import dataclasses
 from dataclasses import dataclass
-import datetime
 import enum
 import logging
 import re
 from typing import TYPE_CHECKING, Any, ParamSpec, TypeVar
 
-from aiohttp import ClientSession
-from pydantic import Field
 import voluptuous as vol
 import zigpy.exceptions
 import zigpy.types
@@ -24,16 +19,10 @@
 from zigpy.zcl.foundation import CommandSchema
 import zigpy.zdo.types as zdo_types
 
-from zha.application import Platform
-from zha.application.const import (
-    CLUSTER_TYPE_IN,
-    CLUSTER_TYPE_OUT,
-    CONF_DEFAULT_CONSIDER_UNAVAILABLE_BATTERY,
-    CONF_DEFAULT_CONSIDER_UNAVAILABLE_MAINS,
-)
+from zha.application.const import CLUSTER_TYPE_IN, CLUSTER_TYPE_OUT
 from zha.async_ import gather_with_limited_concurrency
 from zha.decorators import periodic
-from zha.model import BaseModel
+from zha.zigbee.cluster_handlers.registries import BINDABLE_CLUSTERS
 
 if TYPE_CHECKING:
     from zha.application.gateway import Gateway
@@ -92,9 +81,6 @@ async def get_matched_clusters(
     source_zha_device: Device, target_zha_device: Device
 ) -> list[BindingPair]:
     """Get matched input/output cluster pairs for 2 devices."""
-    from zha.zigbee.cluster_handlers.registries import (  # pylint: disable=import-outside-toplevel
-        BINDABLE_CLUSTERS,
-    )
 
     source_clusters = source_zha_device.async_get_std_clusters()
     target_clusters = target_zha_device.async_get_std_clusters()
@@ -168,9 +154,6 @@ def convert_to_zcl_values(
 
 def async_is_bindable_target(source_zha_device: Device, target_zha_device: Device):
     """Determine if target is bindable to source."""
-    from zha.zigbee.cluster_handlers.registries import (  # pylint: disable=import-outside-toplevel
-        BINDABLE_CLUSTERS,
-    )
 
     if target_zha_device.nwk == 0x0000:
         return True
@@ -264,113 +247,6 @@ def qr_to_install_code(qr_code: str) -> tuple[zigpy.types.EUI64, zigpy.types.Key
     raise vol.Invalid(f"couldn't convert qr code: {qr_code}")
 
 
-class LightOptions(BaseModel):
-    """ZHA light options."""
-
-    default_light_transition: float = Field(default=0)
-    enable_enhanced_light_transition: bool = Field(default=False)
-    enable_light_transitioning_flag: bool = Field(default=True)
-    always_prefer_xy_color_mode: bool = Field(default=True)
-    group_members_assume_state: bool = Field(default=True)
-
-
-class DeviceOptions(BaseModel):
-    """ZHA device options."""
-
-    enable_identify_on_join: bool = Field(default=True)
-    consider_unavailable_mains: int = Field(
-        default=CONF_DEFAULT_CONSIDER_UNAVAILABLE_MAINS
-    )
-    consider_unavailable_battery: int = Field(
-        default=CONF_DEFAULT_CONSIDER_UNAVAILABLE_BATTERY
-    )
-    enable_mains_startup_polling: bool = Field(default=True)
-
-
-class AlarmControlPanelOptions(BaseModel):
-    """ZHA alarm control panel options."""
-
-    master_code: str = Field(default="1234")
-    failed_tries: int = Field(default=3)
-    arm_requires_code: bool = Field(default=False)
-
-
-class CoordinatorConfiguration(BaseModel):
-    """ZHA coordinator configuration."""
-
-    path: str
-    baudrate: int = Field(default=115200)
-    flow_control: str = Field(default="hardware")
-    radio_type: str = Field(default="ezsp")
-
-
-class QuirksConfiguration(BaseModel):
-    """ZHA quirks configuration."""
-
-    enabled: bool = Field(default=True)
-    custom_quirks_path: str | None = Field(default=None)
-
-
-class DeviceOverridesConfiguration(BaseModel):
-    """ZHA device overrides configuration."""
-
-    type: Platform
-
-
-class WebsocketServerConfiguration(BaseModel):
-    """Websocket Server configuration for zha."""
-
-    host: str = "0.0.0.0"
-    port: int = 8001
-    network_auto_start: bool = False
-
-
-class WebsocketClientConfiguration(BaseModel):
-    """Websocket client configuration for zha."""
-
-    host: str = "0.0.0.0"
-    port: int = 8001
-    aiohttp_session: ClientSession | None = None
-
-
-class ZHAConfiguration(BaseModel):
-    """ZHA configuration."""
-
-    coordinator_configuration: CoordinatorConfiguration = Field(
-        default_factory=CoordinatorConfiguration
-    )
-    quirks_configuration: QuirksConfiguration = Field(
-        default_factory=QuirksConfiguration
-    )
-    device_overrides: dict[str, DeviceOverridesConfiguration] = Field(
-        default_factory=dict
-    )
-    light_options: LightOptions = Field(default_factory=LightOptions)
-    device_options: DeviceOptions = Field(default_factory=DeviceOptions)
-    alarm_control_panel_options: AlarmControlPanelOptions = Field(
-        default_factory=AlarmControlPanelOptions
-    )
-
-
-@dataclasses.dataclass(kw_only=True, slots=True)
-class ZHAData:
-    """ZHA data stored in `gateway.data`."""
-
-    config: ZHAConfiguration
-    ws_server_config: WebsocketServerConfiguration | None = None
-    ws_client_config: WebsocketClientConfiguration | None = None
-    zigpy_config: dict[str, Any] = dataclasses.field(default_factory=dict)
-    platforms: collections.defaultdict[Platform, list] = dataclasses.field(
-        default_factory=lambda: collections.defaultdict(list)
-    )
-    gateway: Gateway | None = dataclasses.field(default=None)
-    device_trigger_cache: dict[str, tuple[str, dict]] = dataclasses.field(
-        default_factory=dict
-    )
-    allow_polling: bool = dataclasses.field(default=False)
-    local_timezone: datetime.tzinfo = dataclasses.field(default=datetime.UTC)
-
-
 class GlobalUpdater:
     """Global updater for ZHA.