Add exception translation to SFR box (home-assistant#157756)

Author: epenet

homeassistant/components/sfr_box/__init__.py

@@ -28,9 +28,16 @@ async def async_setup_entry(hass: HomeAssistant, entry: SFRConfigEntry) -> bool:
         try:
             await box.authenticate(username=username, password=password)
         except SFRBoxAuthenticationError as err:
-            raise ConfigEntryAuthFailed from err
+            raise ConfigEntryAuthFailed(
+                translation_domain=DOMAIN,
+                translation_key="invalid_credentials",
+            ) from err
         except SFRBoxError as err:
-            raise ConfigEntryNotReady from err
+            raise ConfigEntryNotReady(
+                translation_domain=DOMAIN,
+                translation_key="unknown_error",
+                translation_placeholders={"error": str(err)},
+            ) from err
         platforms = PLATFORMS_WITH_AUTH
 
     data = SFRRuntimeData(

homeassistant/components/sfr_box/button.py

@@ -21,6 +21,7 @@
 from homeassistant.exceptions import HomeAssistantError
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 
+from .const import DOMAIN
 from .coordinator import SFRConfigEntry
 from .entity import SFREntity
 
@@ -44,7 +45,11 @@ async def wrapper(
         try:
             return await func(self, *args, **kwargs)
         except SFRBoxError as err:
-            raise HomeAssistantError(err) from err
+            raise HomeAssistantError(
+                translation_domain=DOMAIN,
+                translation_key="unknown_error",
+                translation_placeholders={"error": str(err)},
+            ) from err
 
     return wrapper
 

homeassistant/components/sfr_box/coordinator.py

@@ -16,6 +16,8 @@
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
 
+from .const import DOMAIN
+
 _LOGGER = logging.getLogger(__name__)
 _SCAN_INTERVAL = timedelta(minutes=1)
 
@@ -63,5 +65,12 @@ async def _async_update_data(self) -> _DataT:
             if data := await self._method(self.box):
                 return data
         except SFRBoxError as err:
-            raise UpdateFailed from err
-        raise UpdateFailed("No data received from SFR Box")
+            raise UpdateFailed(
+                translation_domain=DOMAIN,
+                translation_key="unknown_error",
+                translation_placeholders={"error": str(err)},
+            ) from err
+        raise UpdateFailed(
+            translation_domain=DOMAIN,
+            translation_key="no_data",
+        )

homeassistant/components/sfr_box/quality_scale.yaml

@@ -50,9 +50,7 @@ rules:
     comment: Should be possible
   stale-devices: done
   diagnostics: done
-  exception-translations:
-    status: todo
-    comment: not yet documented
+  exception-translations: done
   icon-translations: done
   reconfiguration-flow: done
   dynamic-devices: done

homeassistant/components/sfr_box/strings.json

@@ -123,5 +123,16 @@
         }
       }
     }
+  },
+  "exceptions": {
+    "invalid_credentials": {
+      "message": "The provided credentials are invalid."
+    },
+    "no_data": {
+      "message": "No data received from the SFR box."
+    },
+    "unknown_error": {
+      "message": "An unknown error occurred while communicating with the SFR box: {error}"
+    }
   }
 }