Remove deprecation for SmartThings binary sensor (home-assistant#156924)

Author: joostlek

homeassistant/components/smartthings/binary_sensor.py

@@ -8,20 +8,17 @@
 from pysmartthings import Attribute, Capability, Category, SmartThings, Status
 
 from homeassistant.components.binary_sensor import (
-    DOMAIN as BINARY_SENSOR_DOMAIN,
     BinarySensorDeviceClass,
     BinarySensorEntity,
     BinarySensorEntityDescription,
 )
 from homeassistant.const import EntityCategory
 from homeassistant.core import HomeAssistant
-from homeassistant.helpers import entity_registry as er
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 
 from . import FullDevice, SmartThingsConfigEntry
 from .const import INVALID_SWITCH_CATEGORIES, MAIN
 from .entity import SmartThingsEntity
-from .util import deprecate_entity
 
 
 @dataclass(frozen=True, kw_only=True)
@@ -31,11 +28,14 @@ class SmartThingsBinarySensorEntityDescription(BinarySensorEntityDescription):
     is_on_key: str
     category_device_class: dict[Category | str, BinarySensorDeviceClass] | None = None
     category: set[Category] | None = None
-    exists_fn: Callable[[str], bool] | None = None
+    exists_fn: (
+        Callable[
+            [str, dict[str, dict[Capability | str, dict[Attribute | str, Status]]]],
+            bool,
+        ]
+        | None
+    ) = None
     component_translation_key: dict[str, str] | None = None
-    deprecated_fn: Callable[
-        [dict[str, dict[Capability | str, dict[Attribute | str, Status]]]], str | None
-    ] = lambda _: None
 
 
 CAPABILITY_TO_SENSORS: dict[
@@ -59,17 +59,16 @@ class SmartThingsBinarySensorEntityDescription(BinarySensorEntityDescription):
                 Category.DOOR: BinarySensorDeviceClass.DOOR,
                 Category.WINDOW: BinarySensorDeviceClass.WINDOW,
             },
-            exists_fn=lambda key: key in {"freezer", "cooler", "cvroom"},
+            exists_fn=lambda component, status: (
+                not ("freezer" in status and "cooler" in status)
+                if component == MAIN
+                else True
+            ),
             component_translation_key={
                 "freezer": "freezer_door",
                 "cooler": "cooler_door",
                 "cvroom": "cool_select_plus_door",
             },
-            deprecated_fn=(
-                lambda status: "fridge_door"
-                if "freezer" in status and "cooler" in status
-                else None
-            ),
         )
     },
     Capability.CUSTOM_DRYER_WRINKLE_PREVENT: {
@@ -155,15 +154,6 @@ class SmartThingsBinarySensorEntityDescription(BinarySensorEntityDescription):
             entity_category=EntityCategory.DIAGNOSTIC,
         )
     },
-    Capability.VALVE: {
-        Attribute.VALVE: SmartThingsBinarySensorEntityDescription(
-            key=Attribute.VALVE,
-            translation_key="valve",
-            device_class=BinarySensorDeviceClass.OPENING,
-            is_on_key="open",
-            deprecated_fn=lambda _: "valve",
-        )
-    },
     Capability.WATER_SENSOR: {
         Attribute.WATER: SmartThingsBinarySensorEntityDescription(
             key=Attribute.WATER,
@@ -204,64 +194,39 @@ async def async_setup_entry(
 ) -> None:
     """Add binary sensors for a config entry."""
     entry_data = entry.runtime_data
-    entities = []
-
-    entity_registry = er.async_get(hass)
 
-    for device in entry_data.devices.values():  # pylint: disable=too-many-nested-blocks
-        for capability, attribute_map in CAPABILITY_TO_SENSORS.items():
-            for attribute, description in attribute_map.items():
-                for component in device.status:
-                    if (
-                        capability in device.status[component]
-                        and (
-                            component == MAIN
-                            or (
-                                description.exists_fn is not None
-                                and description.exists_fn(component)
-                            )
-                        )
-                        and (
-                            not description.category
-                            or get_main_component_category(device)
-                            in description.category
-                        )
-                    ):
-                        if (
-                            component == MAIN
-                            and (issue := description.deprecated_fn(device.status))
-                            is not None
-                        ):
-                            if deprecate_entity(
-                                hass,
-                                entity_registry,
-                                BINARY_SENSOR_DOMAIN,
-                                f"{device.device.device_id}_{component}_{capability}_{attribute}_{attribute}",
-                                f"deprecated_binary_{issue}",
-                            ):
-                                entities.append(
-                                    SmartThingsBinarySensor(
-                                        entry_data.client,
-                                        device,
-                                        description,
-                                        capability,
-                                        attribute,
-                                        component,
-                                    )
-                                )
-                            continue
-                        entities.append(
-                            SmartThingsBinarySensor(
-                                entry_data.client,
-                                device,
-                                description,
-                                capability,
-                                attribute,
-                                component,
-                            )
-                        )
-
-    async_add_entities(entities)
+    async_add_entities(
+        SmartThingsBinarySensor(
+            entry_data.client,
+            device,
+            description,
+            capability,
+            attribute,
+            component,
+        )
+        for device in entry_data.devices.values()
+        for capability, attribute_map in CAPABILITY_TO_SENSORS.items()
+        for attribute, description in attribute_map.items()
+        for component in device.status
+        if (
+            capability in device.status[component]
+            and (
+                component == MAIN
+                or (
+                    description.component_translation_key is not None
+                    and component in description.component_translation_key
+                )
+            )
+            and (
+                description.exists_fn is None
+                or description.exists_fn(component, device.status)
+            )
+            and (
+                not description.category
+                or get_main_component_category(device) in description.category
+            )
+        )
+    )
 
 
 class SmartThingsBinarySensor(SmartThingsEntity, BinarySensorEntity):

homeassistant/components/smartthings/strings.json

@@ -667,22 +667,6 @@
     }
   },
   "issues": {
-    "deprecated_binary_fridge_door": {
-      "description": "The refrigerator door binary sensor {entity_name} (`{entity_id}`) is deprecated and will be removed in the future. Separate entities for cooler and freezer door are available and should be used going forward. Please update your dashboards, templates accordingly and disable the entity to fix this issue.",
-      "title": "Refrigerator door binary sensor deprecated"
-    },
-    "deprecated_binary_fridge_door_scripts": {
-      "description": "The refrigerator door binary sensor {entity_name} (`{entity_id}`) is deprecated and will be removed in the future. The entity is used in the following automations or scripts:\n{items}\n\nSeparate entities for cooler and freezer door are available and should be used going forward. Please use them in the above automations or scripts and disable the entity to fix this issue.",
-      "title": "[%key:component::smartthings::issues::deprecated_binary_fridge_door::title%]"
-    },
-    "deprecated_binary_valve": {
-      "description": "The valve binary sensor {entity_name} (`{entity_id}`) is deprecated and will be removed in the future. A valve entity with controls is available and should be used going forward. Please update your dashboards, templates accordingly and disable the entity to fix this issue.",
-      "title": "Valve binary sensor deprecated"
-    },
-    "deprecated_binary_valve_scripts": {
-      "description": "The valve binary sensor {entity_name} (`{entity_id}`) is deprecated and will be removed in the future. The entity is used in the following automations or scripts:\n{items}\n\nA valve entity with controls is available and should be used going forward. Please use the new valve entity in the above automations or scripts and disable the entity to fix this issue.",
-      "title": "[%key:component::smartthings::issues::deprecated_binary_valve::title%]"
-    },
     "deprecated_dhw": {
       "description": "The sensor {entity_name} (`{entity_id}`) is deprecated because it has been replaced with a water heater entity.\n\nPlease update your dashboards and templates to use the new water heater entity and disable the sensor to fix this issue.",
       "title": "Water heater sensors deprecated"

tests/components/smartthings/test_binary_sensor.py

@@ -7,15 +7,9 @@
 import pytest
 from syrupy.assertion import SnapshotAssertion
 
-from homeassistant.components import automation, script
-from homeassistant.components.automation import automations_with_entity
-from homeassistant.components.binary_sensor import DOMAIN as BINARY_SENSOR_DOMAIN
-from homeassistant.components.script import scripts_with_entity
-from homeassistant.components.smartthings import DOMAIN, MAIN
 from homeassistant.const import STATE_OFF, STATE_ON, STATE_UNAVAILABLE, Platform
 from homeassistant.core import HomeAssistant
-from homeassistant.helpers import entity_registry as er, issue_registry as ir
-from homeassistant.setup import async_setup_component
+from homeassistant.helpers import entity_registry as er
 
 from . import (
     setup_integration,
@@ -105,172 +99,3 @@ async def test_availability_at_start(
         hass.states.get("binary_sensor.refrigerator_fridge_door").state
         == STATE_UNAVAILABLE
     )
-
-
-@pytest.mark.parametrize(
-    ("device_fixture", "unique_id", "suggested_object_id", "issue_string", "entity_id"),
-    [
-        (
-            "virtual_valve",
-            f"612ab3c2-3bb0-48f7-b2c0-15b169cb2fc3_{MAIN}_{Capability.VALVE}_{Attribute.VALVE}_{Attribute.VALVE}",
-            "volvo_valve",
-            "valve",
-            "binary_sensor.volvo_valve",
-        ),
-        (
-            "da_ref_normal_000001",
-            f"7db87911-7dce-1cf2-7119-b953432a2f09_{MAIN}_{Capability.CONTACT_SENSOR}_{Attribute.CONTACT}_{Attribute.CONTACT}",
-            "refrigerator_door",
-            "fridge_door",
-            "binary_sensor.refrigerator_door",
-        ),
-    ],
-)
-async def test_create_issue_with_items(
-    hass: HomeAssistant,
-    devices: AsyncMock,
-    mock_config_entry: MockConfigEntry,
-    entity_registry: er.EntityRegistry,
-    issue_registry: ir.IssueRegistry,
-    unique_id: str,
-    suggested_object_id: str,
-    issue_string: str,
-    entity_id: str,
-) -> None:
-    """Test we create an issue when an automation or script is using a deprecated entity."""
-    issue_id = f"deprecated_binary_{issue_string}_{entity_id}"
-
-    entity_entry = entity_registry.async_get_or_create(
-        BINARY_SENSOR_DOMAIN,
-        DOMAIN,
-        unique_id,
-        suggested_object_id=suggested_object_id,
-        original_name=suggested_object_id,
-    )
-
-    assert await async_setup_component(
-        hass,
-        automation.DOMAIN,
-        {
-            automation.DOMAIN: {
-                "id": "test",
-                "alias": "test",
-                "trigger": {"platform": "state", "entity_id": entity_id},
-                "action": {
-                    "action": "automation.turn_on",
-                    "target": {
-                        "entity_id": "automation.test",
-                    },
-                },
-            }
-        },
-    )
-    assert await async_setup_component(
-        hass,
-        script.DOMAIN,
-        {
-            script.DOMAIN: {
-                "test": {
-                    "sequence": [
-                        {
-                            "condition": "state",
-                            "entity_id": entity_id,
-                            "state": "on",
-                        },
-                    ],
-                }
-            }
-        },
-    )
-
-    await setup_integration(hass, mock_config_entry)
-
-    assert hass.states.get(entity_id).state == STATE_OFF
-
-    assert automations_with_entity(hass, entity_id)[0] == "automation.test"
-    assert scripts_with_entity(hass, entity_id)[0] == "script.test"
-
-    issue = issue_registry.async_get_issue(DOMAIN, issue_id)
-    assert issue is not None
-    assert issue.translation_key == f"deprecated_binary_{issue_string}_scripts"
-    assert issue.translation_placeholders == {
-        "entity_id": entity_id,
-        "entity_name": suggested_object_id,
-        "items": "- [test](/config/automation/edit/test)\n- [test](/config/script/edit/test)",
-    }
-
-    entity_registry.async_update_entity(
-        entity_entry.entity_id,
-        disabled_by=er.RegistryEntryDisabler.USER,
-    )
-
-    await hass.config_entries.async_reload(mock_config_entry.entry_id)
-    await hass.async_block_till_done()
-
-    # Assert the issue is no longer present
-    assert not issue_registry.async_get_issue(DOMAIN, issue_id)
-
-
-@pytest.mark.parametrize(
-    ("device_fixture", "unique_id", "suggested_object_id", "issue_string", "entity_id"),
-    [
-        (
-            "virtual_valve",
-            f"612ab3c2-3bb0-48f7-b2c0-15b169cb2fc3_{MAIN}_{Capability.VALVE}_{Attribute.VALVE}_{Attribute.VALVE}",
-            "volvo_valve",
-            "valve",
-            "binary_sensor.volvo_valve",
-        ),
-        (
-            "da_ref_normal_000001",
-            f"7db87911-7dce-1cf2-7119-b953432a2f09_{MAIN}_{Capability.CONTACT_SENSOR}_{Attribute.CONTACT}_{Attribute.CONTACT}",
-            "refrigerator_door",
-            "fridge_door",
-            "binary_sensor.refrigerator_door",
-        ),
-    ],
-)
-async def test_create_issue(
-    hass: HomeAssistant,
-    devices: AsyncMock,
-    mock_config_entry: MockConfigEntry,
-    entity_registry: er.EntityRegistry,
-    issue_registry: ir.IssueRegistry,
-    unique_id: str,
-    suggested_object_id: str,
-    issue_string: str,
-    entity_id: str,
-) -> None:
-    """Test we create an issue when an automation or script is using a deprecated entity."""
-    issue_id = f"deprecated_binary_{issue_string}_{entity_id}"
-
-    entity_entry = entity_registry.async_get_or_create(
-        BINARY_SENSOR_DOMAIN,
-        DOMAIN,
-        unique_id,
-        suggested_object_id=suggested_object_id,
-        original_name=suggested_object_id,
-    )
-
-    await setup_integration(hass, mock_config_entry)
-
-    assert hass.states.get(entity_id).state == STATE_OFF
-
-    issue = issue_registry.async_get_issue(DOMAIN, issue_id)
-    assert issue is not None
-    assert issue.translation_key == f"deprecated_binary_{issue_string}"
-    assert issue.translation_placeholders == {
-        "entity_id": entity_id,
-        "entity_name": suggested_object_id,
-    }
-
-    entity_registry.async_update_entity(
-        entity_entry.entity_id,
-        disabled_by=er.RegistryEntryDisabler.USER,
-    )
-
-    await hass.config_entries.async_reload(mock_config_entry.entry_id)
-    await hass.async_block_till_done()
-
-    # Assert the issue is no longer present
-    assert not issue_registry.async_get_issue(DOMAIN, issue_id)