mirror of
https://github.com/home-assistant/core.git
synced 2026-07-17 19:43:29 +01:00
bdlcalvin
102 lines
3.2 KiB
Python
102 lines
3.2 KiB
Python
"""Utility helpers for the Whirlpool integration."""
|
|
|
|
from homeassistant.components.automation import automations_with_entity
|
|
from homeassistant.components.script import scripts_with_entity
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers import entity_registry as er
|
|
from homeassistant.helpers.issue_registry import (
|
|
IssueSeverity,
|
|
async_create_issue,
|
|
async_delete_issue,
|
|
)
|
|
|
|
from .const import DOMAIN
|
|
|
|
# Version in which deprecated entities will be removed.
|
|
DEPRECATED_REMOVAL_VERSION = "2026.12.0"
|
|
|
|
|
|
def deprecate_entity(
|
|
hass: HomeAssistant,
|
|
entity_registry: er.EntityRegistry,
|
|
*,
|
|
platform_domain: str,
|
|
entity_unique_id: str,
|
|
issue_id: str,
|
|
translation_key: str,
|
|
) -> bool:
|
|
"""Handle deprecation of an entity that has been replaced.
|
|
|
|
Return True if the deprecated entity should still be set up, which is the
|
|
case while it exists in the entity registry. A repair issue informs the user
|
|
about the replacement and the removal date; when the entity is still used by
|
|
automations or scripts they are listed in the issue. The entity is removed
|
|
once the user disables it and nothing references it anymore. New
|
|
installations never create the entity.
|
|
"""
|
|
entity_id = entity_registry.async_get_entity_id(
|
|
platform_domain, DOMAIN, entity_unique_id
|
|
)
|
|
if entity_id is None:
|
|
async_delete_issue(hass, DOMAIN, issue_id)
|
|
return False
|
|
|
|
entity_entry = entity_registry.async_get(entity_id)
|
|
if entity_entry is None:
|
|
async_delete_issue(hass, DOMAIN, issue_id)
|
|
return False
|
|
|
|
items = _automations_and_scripts_using_entity(hass, entity_registry, entity_id)
|
|
|
|
if entity_entry.disabled and not items:
|
|
entity_registry.async_remove(entity_id)
|
|
async_delete_issue(hass, DOMAIN, issue_id)
|
|
return False
|
|
|
|
placeholders = {
|
|
"entity_id": entity_id,
|
|
"entity_name": entity_entry.name or entity_entry.original_name or entity_id,
|
|
}
|
|
if items:
|
|
translation_key = f"{translation_key}_scripts"
|
|
placeholders["items"] = "\n".join(items)
|
|
|
|
async_create_issue(
|
|
hass,
|
|
DOMAIN,
|
|
issue_id,
|
|
breaks_in_ha_version=DEPRECATED_REMOVAL_VERSION,
|
|
is_fixable=False,
|
|
severity=IssueSeverity.WARNING,
|
|
translation_key=translation_key,
|
|
translation_placeholders=placeholders,
|
|
)
|
|
return True
|
|
|
|
|
|
def _automations_and_scripts_using_entity(
|
|
hass: HomeAssistant,
|
|
entity_registry: er.EntityRegistry,
|
|
entity_id: str,
|
|
) -> list[str]:
|
|
"""Return markdown list items for automations and scripts using an entity."""
|
|
automations = automations_with_entity(hass, entity_id)
|
|
scripts = scripts_with_entity(hass, entity_id)
|
|
if not automations and not scripts:
|
|
return []
|
|
|
|
items: list[str] = []
|
|
for integration, used_entities in (
|
|
("automation", automations),
|
|
("script", scripts),
|
|
):
|
|
for used_entity_id in used_entities:
|
|
if entry := entity_registry.async_get(used_entity_id):
|
|
items.append(
|
|
f"- [{entry.original_name}](/config/{integration}/edit/{entry.unique_id})"
|
|
)
|
|
else:
|
|
items.append(f"- `{used_entity_id}`")
|
|
|
|
return items
|