Replace more addon management with aiohasupervisor #126236
Conversation
home-assistant
bot
added
cla-signed
code-quality
core
has-tests
integration: hassio
integration: homeassistant_hardware
integration: matter
integration: zwave_js
small-pr
|
Hey there @home-assistant/z-wave, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
|
Hey there @home-assistant/supervisor, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
|
Hey there @home-assistant/matter, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
|
Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
mdegat01
force-pushed
the
continue-addons-to-aiohasupervisor
branch
from
36dac9e
to
d26e5a9
Compare
mdegat01
force-pushed
the
continue-addons-to-aiohasupervisor
branch
from
17c47bf
to
1aeb2a9
Compare
mdegat01
requested review from
a team,
emontnemery,
jbouwh and
bdraco
as code owners
Co-authored-by: epenet <[email protected]>
| @bind_hass | ||
| @api_data | ||
| async def async_start_addon(hass: HomeAssistant, slug: str) -> dict: | ||
| """Start add-on. | ||
|
|
||
| The caller of the function should handle HassioAPIError. | ||
| """ | ||
| hassio: HassIO = hass.data[DOMAIN] | ||
| command = f"/addons/{slug}/start" | ||
| return await hassio.send_command(command, timeout=60) | ||
|
|
||
|
|
||
| @bind_hass | ||
| @api_data | ||
| async def async_restart_addon(hass: HomeAssistant, slug: str) -> dict: | ||
| """Restart add-on. | ||
|
|
||
| The caller of the function should handle HassioAPIError. | ||
| """ | ||
| hassio: HassIO = hass.data[DOMAIN] | ||
| command = f"/addons/{slug}/restart" | ||
| return await hassio.send_command(command, timeout=None) | ||
|
|
||
|
|
||
| @bind_hass | ||
| @api_data | ||
| async def async_stop_addon(hass: HomeAssistant, slug: str) -> dict: | ||
| """Stop add-on. | ||
|
|
||
| The caller of the function should handle HassioAPIError. | ||
| """ | ||
| hassio: HassIO = hass.data[DOMAIN] | ||
| command = f"/addons/{slug}/stop" | ||
| return await hassio.send_command(command, timeout=60) | ||
|
|
There was a problem hiding this comment.
Sanity check, these variables weren't used throughout the code in other components?
There was a problem hiding this comment.
No, I checked. Although I can't guarantee they aren't used in custom components. I don't know how we feel about that.
All of them have had an alternative for a while though in addon_manager. And throughout core i found zero examples of people using these 3 outside the hassio component, all other integrations were going through addon manager.
Well outside of test cases anyway. People were mocking those 3 as if it were a client library in test but going through addon manager in the runtime code. That's why I've been cutting from handler as I replace with the real client library and leaving addon manager intact.
Proposed change
Continue refactoring API calls to supervisor for addon management out of
hassio/handlerand intoaiohasupervisor. PR refactors the following to the library:start_addonrestart_addonstop_addonuninstall_addonType 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: