feat: add purge button

Author: jcwillox

custom_components/auto_backup/__init__.py

@@ -9,7 +9,7 @@
 
 import homeassistant.helpers.config_validation as cv
 import voluptuous as vol
-from homeassistant.components.backup.const import DOMAIN as DOMAIN_BACKUP
+from homeassistant.components.backup.const import DOMAIN as DOMAIN_BACKUP, DATA_MANAGER
 from homeassistant.components.hassio import (
     ATTR_FOLDERS,
     ATTR_ADDONS,
@@ -155,10 +155,10 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry):
     if is_hassio(hass):
         handler = SupervisorHandler(getenv("SUPERVISOR"), async_get_clientsession(hass))
     else:
-        handler = BackupHandler(hass, hass.data[DOMAIN_BACKUP])
+        handler = BackupHandler(hass, hass.data[DATA_MANAGER])
 
     auto_backup = AutoBackup(hass, options, handler)
-    hass.data.setdefault(DOMAIN, {})[DATA_AUTO_BACKUP] = auto_backup
+    hass.data[DATA_AUTO_BACKUP] = auto_backup
     entry.async_on_unload(entry.add_update_listener(auto_backup.update_listener))
 
     await auto_backup.load_snapshots_expiry()

custom_components/auto_backup/button.py

@@ -0,0 +1,35 @@
+from homeassistant.components.button import ButtonEntity, ButtonEntityDescription
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
+
+from . import AutoBackup
+from .const import DATA_AUTO_BACKUP
+from .helpers import get_device_info
+
+
+async def async_setup_entry(
+    hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
+):
+    """Set up Auto Backup sensors based on a config entry."""
+    auto_backup = hass.data[DATA_AUTO_BACKUP]
+    async_add_entities([AutoBackupPurgeButton(entry, auto_backup)])
+
+
+class AutoBackupPurgeButton(ButtonEntity):
+    entity_description = ButtonEntityDescription(
+        key="purge",
+        name="Purge backups",
+        icon="mdi:close-circle",
+    )
+
+    _attr_has_entity_name = True
+
+    def __init__(self, entry: ConfigEntry, auto_backup: AutoBackup):
+        self._auto_backup = auto_backup
+        self._attr_unique_id = self.entity_description.key
+        self._attr_device_info = get_device_info(entry)
+
+    async def async_press(self) -> None:
+        """Purge backups."""
+        await self._auto_backup.purge_backups()

custom_components/auto_backup/const.py

@@ -1,7 +1,13 @@
+from typing import TYPE_CHECKING
+
 from homeassistant.const import Platform
+from homeassistant.util.hass_dict import HassKey
+
+if TYPE_CHECKING:
+    from . import AutoBackup
 
 DOMAIN = "auto_backup"
-DATA_AUTO_BACKUP = "auto_backup"
+DATA_AUTO_BACKUP: HassKey[AutoBackup] = HassKey(DOMAIN)
 UNSUB_LISTENER = "unsub_listener"
 
 CONF_AUTO_PURGE = "auto_purge"

custom_components/auto_backup/helpers.py

@@ -0,0 +1,14 @@
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
+
+from .const import DOMAIN
+
+
+def get_device_info(entry: ConfigEntry) -> DeviceInfo:
+    return DeviceInfo(
+        entry_type=DeviceEntryType.SERVICE,
+        configuration_url="https://jcwillox.github.io/hass-auto-backup",
+        manufacturer="Auto Backup",
+        identifiers={(DOMAIN, entry.entry_id)},
+        name=entry.title,
+    )