Add exception translations to ring integration #136468
Conversation
There was a problem hiding this comment.
Exception translations are meant to provide a user-friendly message back to the user on why something went wrong. I think you're mixing up the purpose of that with the desire to capture the technical reason that something failed. Log that instead.
You can also raise the HomeAssistantError (and derivatives) from an existing exception, which will capture the stack traceback and message in the logs.
| "func": func_name, | ||
| "exc": str(err), |
There was a problem hiding this comment.
I think it's OK to include the stringified exception IF it's something understandable and useful to the user and isn't already, or can't be, represented by the exception translation message itself. Can you give some examples of what might be added here?
| translation_domain=DOMAIN, | ||
| translation_key=f"{translation_prefix}authentication", | ||
| translation_placeholders={ | ||
| "func": func_name, |
There was a problem hiding this comment.
Implementation details do not belong in user-facing error messages. If this is useful for diagnostics or troubleshooting, then log it instead.
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Proposed change
SSIA
Type of change
Additional information
Checklist
ruff format homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all.To help with the load of incoming pull requests: