From 018e7731aeffdb4ab947500ec2178ed55af00590 Mon Sep 17 00:00:00 2001
From: Marc Mueller <30130371+cdce8p@users.noreply.github.com>
Date: Tue, 7 May 2024 18:40:57 +0200
Subject: [PATCH] Add SignificantChangeProtocol to improve platform typing
 (#117002)

---
 homeassistant/helpers/significant_change.py | 27 +++++++++++++++++----
 1 file changed, 22 insertions(+), 5 deletions(-)

diff --git a/homeassistant/helpers/significant_change.py b/homeassistant/helpers/significant_change.py
index 1b1f1b5c617..3b13c359faa 100644
--- a/homeassistant/helpers/significant_change.py
+++ b/homeassistant/helpers/significant_change.py
@@ -29,17 +29,18 @@ The following cases will never be passed to your function:
 
 from __future__ import annotations
 
-from collections.abc import Callable
+from collections.abc import Callable, Mapping
 from types import MappingProxyType
-from typing import Any
+from typing import Any, Protocol
 
 from homeassistant.const import STATE_UNAVAILABLE, STATE_UNKNOWN
 from homeassistant.core import HomeAssistant, State, callback
+from homeassistant.util.hass_dict import HassKey
 
 from .integration_platform import async_process_integration_platforms
 
 PLATFORM = "significant_change"
-DATA_FUNCTIONS = "significant_change"
+DATA_FUNCTIONS: HassKey[dict[str, CheckTypeFunc]] = HassKey("significant_change")
 CheckTypeFunc = Callable[
     [
         HomeAssistant,
@@ -65,6 +66,20 @@ ExtraCheckTypeFunc = Callable[
 ]
 
 
+class SignificantChangeProtocol(Protocol):
+    """Define the format of significant_change platforms."""
+
+    def async_check_significant_change(
+        self,
+        hass: HomeAssistant,
+        old_state: str,
+        old_attrs: Mapping[str, Any],
+        new_state: str,
+        new_attrs: Mapping[str, Any],
+    ) -> bool | None:
+        """Test if state significantly changed."""
+
+
 async def create_checker(
     hass: HomeAssistant,
     _domain: str,
@@ -85,7 +100,9 @@ async def _initialize(hass: HomeAssistant) -> None:
 
     @callback
     def process_platform(
-        hass: HomeAssistant, component_name: str, platform: Any
+        hass: HomeAssistant,
+        component_name: str,
+        platform: SignificantChangeProtocol,
     ) -> None:
         """Process a significant change platform."""
         functions[component_name] = platform.async_check_significant_change
@@ -206,7 +223,7 @@ class SignificantlyChangedChecker:
             self.last_approved_entities[new_state.entity_id] = (new_state, extra_arg)
             return True
 
-        functions: dict[str, CheckTypeFunc] | None = self.hass.data.get(DATA_FUNCTIONS)
+        functions = self.hass.data.get(DATA_FUNCTIONS)
 
         if functions is None:
             raise RuntimeError("Significant Change not initialized")