Skip to content

Commit

Permalink
Add type hints to diagnostics test helper (home-assistant#85494)
Browse files Browse the repository at this point in the history
* Add type hints to diagnostics test helper

* Move type alias to the top

* Use Any

* Move TestClientGenerator to typing helper

* Use `dict[str, Any]` again

* Use JsonObjectType

* Add cast
  • Loading branch information
epenet authored Feb 9, 2023
1 parent ecb1d93 commit 94779dd
Showing 1 changed file with 33 additions and 8 deletions.
41 changes: 33 additions & 8 deletions tests/components/diagnostics/__init__.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,21 @@
"""Tests for the Diagnostics integration."""
from http import HTTPStatus
from typing import cast

from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.device_registry import DeviceEntry
from homeassistant.helpers.json import JsonObjectType
from homeassistant.setup import async_setup_component

from tests.typing import ClientSessionGenerator

async def _get_diagnostics_for_config_entry(hass, hass_client, config_entry):

async def _get_diagnostics_for_config_entry(
hass: HomeAssistant,
hass_client: ClientSessionGenerator,
config_entry: ConfigEntry,
) -> JsonObjectType:
"""Return the diagnostics config entry for the specified domain."""
assert await async_setup_component(hass, "diagnostics", {})

Expand All @@ -13,16 +24,25 @@ async def _get_diagnostics_for_config_entry(hass, hass_client, config_entry):
f"/api/diagnostics/config_entry/{config_entry.entry_id}"
)
assert response.status == HTTPStatus.OK
return await response.json()
return cast(JsonObjectType, await response.json())


async def get_diagnostics_for_config_entry(hass, hass_client, config_entry):
async def get_diagnostics_for_config_entry(
hass: HomeAssistant,
hass_client: ClientSessionGenerator,
config_entry: ConfigEntry,
) -> JsonObjectType:
"""Return the diagnostics config entry for the specified domain."""
data = await _get_diagnostics_for_config_entry(hass, hass_client, config_entry)
return data["data"]
return cast(JsonObjectType, data["data"])


async def _get_diagnostics_for_device(hass, hass_client, config_entry, device):
async def _get_diagnostics_for_device(
hass: HomeAssistant,
hass_client: ClientSessionGenerator,
config_entry: ConfigEntry,
device: DeviceEntry,
) -> JsonObjectType:
"""Return the diagnostics for the specified device."""
assert await async_setup_component(hass, "diagnostics", {})

Expand All @@ -31,10 +51,15 @@ async def _get_diagnostics_for_device(hass, hass_client, config_entry, device):
f"/api/diagnostics/config_entry/{config_entry.entry_id}/device/{device.id}"
)
assert response.status == HTTPStatus.OK
return await response.json()
return cast(JsonObjectType, await response.json())


async def get_diagnostics_for_device(hass, hass_client, config_entry, device):
async def get_diagnostics_for_device(
hass: HomeAssistant,
hass_client: ClientSessionGenerator,
config_entry: ConfigEntry,
device: DeviceEntry,
) -> JsonObjectType:
"""Return the diagnostics for the specified device."""
data = await _get_diagnostics_for_device(hass, hass_client, config_entry, device)
return data["data"]
return cast(JsonObjectType, data["data"])

0 comments on commit 94779dd

Please sign in to comment.