Remove deprecated set state directly in alarmcontrolpanel (home-assistant#154038)

Author: gjohansson-ST

homeassistant/components/alarm_control_panel/__init__.py

@@ -2,10 +2,9 @@
 
 from __future__ import annotations
 
-import asyncio
 from datetime import timedelta
 import logging
-from typing import TYPE_CHECKING, Any, Final, final
+from typing import Any, Final, final
 
 from propcache.api import cached_property
 import voluptuous as vol
@@ -28,8 +27,6 @@
 from homeassistant.helpers.config_validation import make_entity_service_schema
 from homeassistant.helpers.entity import Entity, EntityDescription
 from homeassistant.helpers.entity_component import EntityComponent
-from homeassistant.helpers.entity_platform import EntityPlatform
-from homeassistant.helpers.frame import ReportBehavior, report_usage
 from homeassistant.helpers.typing import ConfigType
 from homeassistant.util.hass_dict import HassKey
 
@@ -149,68 +146,11 @@ class AlarmControlPanelEntity(Entity, cached_properties=CACHED_PROPERTIES_WITH_A
     )
     _alarm_control_panel_option_default_code: str | None = None
 
-    __alarm_legacy_state: bool = False
-
-    def __init_subclass__(cls, **kwargs: Any) -> None:
-        """Post initialisation processing."""
-        super().__init_subclass__(**kwargs)
-        if any(method in cls.__dict__ for method in ("_attr_state", "state")):
-            # Integrations should use the 'alarm_state' property instead of
-            # setting the state directly.
-            cls.__alarm_legacy_state = True
-
-    def __setattr__(self, name: str, value: Any, /) -> None:
-        """Set attribute.
-
-        Deprecation warning if setting '_attr_state' directly
-        unless already reported.
-        """
-        if name == "_attr_state":
-            self._report_deprecated_alarm_state_handling()
-        return super().__setattr__(name, value)
-
-    @callback
-    def add_to_platform_start(
-        self,
-        hass: HomeAssistant,
-        platform: EntityPlatform,
-        parallel_updates: asyncio.Semaphore | None,
-    ) -> None:
-        """Start adding an entity to a platform."""
-        super().add_to_platform_start(hass, platform, parallel_updates)
-        if self.__alarm_legacy_state:
-            self._report_deprecated_alarm_state_handling()
-
-    @callback
-    def _report_deprecated_alarm_state_handling(self) -> None:
-        """Report on deprecated handling of alarm state.
-
-        Integrations should implement alarm_state instead of using state directly.
-        """
-        report_usage(
-            "is setting state directly."
-            f" Entity {self.entity_id} ({type(self)}) should implement the 'alarm_state'"
-            " property and return its state using the AlarmControlPanelState enum",
-            core_integration_behavior=ReportBehavior.ERROR,
-            custom_integration_behavior=ReportBehavior.LOG,
-            breaks_in_ha_version="2025.11",
-            integration_domain=self.platform.platform_name if self.platform else None,
-            exclude_integrations={DOMAIN},
-        )
-
     @final
     @property
     def state(self) -> str | None:
         """Return the current state."""
-        if (alarm_state := self.alarm_state) is not None:
-            return alarm_state
-        if self._attr_state is not None:
-            # Backwards compatibility for integrations that set state directly
-            # Should be removed in 2025.11
-            if TYPE_CHECKING:
-                assert isinstance(self._attr_state, str)
-            return self._attr_state
-        return None
+        return self.alarm_state
 
     @cached_property
     def alarm_state(self) -> AlarmControlPanelState | None:

tests/components/alarm_control_panel/test_init.py

@@ -6,7 +6,6 @@
 
 from homeassistant.components import alarm_control_panel
 from homeassistant.components.alarm_control_panel import (
-    DOMAIN,
     AlarmControlPanelEntityFeature,
     CodeFormat,
 )
@@ -25,16 +24,8 @@
 from homeassistant.helpers import entity_registry as er
 from homeassistant.helpers.typing import UNDEFINED, UndefinedType
 
-from . import help_async_setup_entry_init, help_async_unload_entry
 from .conftest import MockAlarmControlPanel
 
-from tests.common import (
-    MockConfigEntry,
-    MockModule,
-    mock_integration,
-    setup_test_component_platform,
-)
-
 
 async def help_test_async_alarm_control_panel_service(
     hass: HomeAssistant,
@@ -233,206 +224,3 @@ async def test_alarm_control_panel_not_log_deprecated_state_warning(
         "the 'alarm_state' property and return its state using the AlarmControlPanelState enum"
         not in caplog.text
     )
-
-
-@pytest.mark.usefixtures("mock_as_custom_component")
-async def test_alarm_control_panel_log_deprecated_state_warning_using_state_prop(
-    hass: HomeAssistant,
-    code_format: CodeFormat | None,
-    supported_features: AlarmControlPanelEntityFeature,
-    code_arm_required: bool,
-    caplog: pytest.LogCaptureFixture,
-) -> None:
-    """Test incorrectly using state property does log issue and raise repair."""
-
-    class MockLegacyAlarmControlPanel(MockAlarmControlPanel):
-        """Mocked alarm control entity."""
-
-        def __init__(
-            self,
-            supported_features: AlarmControlPanelEntityFeature = AlarmControlPanelEntityFeature(
-                0
-            ),
-            code_format: CodeFormat | None = None,
-            code_arm_required: bool = True,
-        ) -> None:
-            """Initialize the alarm control."""
-            super().__init__(supported_features, code_format, code_arm_required)
-
-        @property
-        def state(self) -> str:
-            """Return the state of the entity."""
-            return "disarmed"
-
-    entity = MockLegacyAlarmControlPanel(
-        supported_features=supported_features,
-        code_format=code_format,
-        code_arm_required=code_arm_required,
-    )
-    config_entry = MockConfigEntry(domain="test")
-    config_entry.add_to_hass(hass)
-    mock_integration(
-        hass,
-        MockModule(
-            "test",
-            async_setup_entry=help_async_setup_entry_init,
-            async_unload_entry=help_async_unload_entry,
-        ),
-        built_in=False,
-    )
-    setup_test_component_platform(hass, DOMAIN, [entity], from_config_entry=True)
-    assert await hass.config_entries.async_setup(config_entry.entry_id)
-
-    state = hass.states.get(entity.entity_id)
-    assert state is not None
-
-    assert (
-        "Detected that custom integration 'test' is setting state "
-        "directly. Entity None (<class 'tests.components.alarm_control_panel."
-        "test_init.test_alarm_control_panel_log_deprecated_state_warning_using"
-        "_state_prop.<locals>.MockLegacyAlarmControlPanel'>) should implement"
-        " the 'alarm_state' property and return its state using the AlarmControlPanelState"
-        " enum. This will stop working in Home Assistant 2025.11, please report it to"
-        " the author of the 'test' custom integration" in caplog.text
-    )
-
-
-@pytest.mark.usefixtures("mock_as_custom_component")
-async def test_alarm_control_panel_log_deprecated_state_warning_using_attr_state_attr(
-    hass: HomeAssistant,
-    code_format: CodeFormat | None,
-    supported_features: AlarmControlPanelEntityFeature,
-    code_arm_required: bool,
-    caplog: pytest.LogCaptureFixture,
-) -> None:
-    """Test incorrectly using _attr_state attribute does log issue and raise repair."""
-
-    class MockLegacyAlarmControlPanel(MockAlarmControlPanel):
-        """Mocked alarm control entity."""
-
-        def __init__(
-            self,
-            supported_features: AlarmControlPanelEntityFeature = AlarmControlPanelEntityFeature(
-                0
-            ),
-            code_format: CodeFormat | None = None,
-            code_arm_required: bool = True,
-        ) -> None:
-            """Initialize the alarm control."""
-            super().__init__(supported_features, code_format, code_arm_required)
-
-        def alarm_disarm(self, code: str | None = None) -> None:
-            """Mock alarm disarm calls."""
-            self._attr_state = "disarmed"
-
-    entity = MockLegacyAlarmControlPanel(
-        supported_features=supported_features,
-        code_format=code_format,
-        code_arm_required=code_arm_required,
-    )
-    config_entry = MockConfigEntry(domain="test")
-    config_entry.add_to_hass(hass)
-    mock_integration(
-        hass,
-        MockModule(
-            "test",
-            async_setup_entry=help_async_setup_entry_init,
-            async_unload_entry=help_async_unload_entry,
-        ),
-        built_in=False,
-    )
-    setup_test_component_platform(hass, DOMAIN, [entity], from_config_entry=True)
-    assert await hass.config_entries.async_setup(config_entry.entry_id)
-
-    state = hass.states.get(entity.entity_id)
-    assert state is not None
-
-    assert (
-        "Detected that custom integration 'test' is setting state directly."
-        not in caplog.text
-    )
-
-    await help_test_async_alarm_control_panel_service(
-        hass, entity.entity_id, SERVICE_ALARM_DISARM
-    )
-
-    assert (
-        "Detected that custom integration 'test' is setting state directly."
-        " Entity alarm_control_panel.test_alarm_control_panel"
-        " (<class 'tests.components.alarm_control_panel.test_init."
-        "test_alarm_control_panel_log_deprecated_state_warning_using_attr_state_attr."
-        "<locals>.MockLegacyAlarmControlPanel'>) should implement the 'alarm_state' property"
-        " and return its state using the AlarmControlPanelState enum. "
-        "This will stop working in Home Assistant 2025.11, please report "
-        "it to the author of the 'test' custom integration" in caplog.text
-    )
-    caplog.clear()
-    await help_test_async_alarm_control_panel_service(
-        hass, entity.entity_id, SERVICE_ALARM_DISARM
-    )
-    # Test we only log once
-    assert (
-        "Detected that custom integration 'test' is setting state directly."
-        not in caplog.text
-    )
-
-
-@pytest.mark.usefixtures("mock_as_custom_component")
-async def test_alarm_control_panel_deprecated_state_does_not_break_state(
-    hass: HomeAssistant,
-    code_format: CodeFormat | None,
-    supported_features: AlarmControlPanelEntityFeature,
-    code_arm_required: bool,
-    caplog: pytest.LogCaptureFixture,
-) -> None:
-    """Test using _attr_state attribute does not break state."""
-
-    class MockLegacyAlarmControlPanel(MockAlarmControlPanel):
-        """Mocked alarm control entity."""
-
-        def __init__(
-            self,
-            supported_features: AlarmControlPanelEntityFeature = AlarmControlPanelEntityFeature(
-                0
-            ),
-            code_format: CodeFormat | None = None,
-            code_arm_required: bool = True,
-        ) -> None:
-            """Initialize the alarm control."""
-            self._attr_state = "armed_away"
-            super().__init__(supported_features, code_format, code_arm_required)
-
-        def alarm_disarm(self, code: str | None = None) -> None:
-            """Mock alarm disarm calls."""
-            self._attr_state = "disarmed"
-
-    entity = MockLegacyAlarmControlPanel(
-        supported_features=supported_features,
-        code_format=code_format,
-        code_arm_required=code_arm_required,
-    )
-    config_entry = MockConfigEntry(domain="test")
-    config_entry.add_to_hass(hass)
-    mock_integration(
-        hass,
-        MockModule(
-            "test",
-            async_setup_entry=help_async_setup_entry_init,
-            async_unload_entry=help_async_unload_entry,
-        ),
-        built_in=False,
-    )
-    setup_test_component_platform(hass, DOMAIN, [entity], from_config_entry=True)
-    assert await hass.config_entries.async_setup(config_entry.entry_id)
-
-    state = hass.states.get(entity.entity_id)
-    assert state is not None
-    assert state.state == "armed_away"
-
-    await help_test_async_alarm_control_panel_service(
-        hass, entity.entity_id, SERVICE_ALARM_DISARM
-    )
-
-    state = hass.states.get(entity.entity_id)
-    assert state is not None
-    assert state.state == "disarmed"