Home Assistant Unofficial Reference 2024.12.1
diagnostics.py
Go to the documentation of this file.
1 """Diagnostics support for OpenUV."""
2 
3 from __future__ import annotations
4 
5 from typing import Any
6 
7 from homeassistant.components.diagnostics import async_redact_data
8 from homeassistant.config_entries import ConfigEntry
9 from homeassistant.const import (
10  CONF_API_KEY,
11  CONF_LATITUDE,
12  CONF_LONGITUDE,
13  CONF_UNIQUE_ID,
14 )
15 from homeassistant.core import HomeAssistant
16 
17 from .const import DOMAIN
18 from .coordinator import OpenUvCoordinator
19 
20 CONF_COORDINATES = "coordinates"
21 CONF_TITLE = "title"
22 
23 TO_REDACT = {
24  CONF_API_KEY,
25  CONF_LATITUDE,
26  CONF_LONGITUDE,
27  # Config entry title and unique ID may contain sensitive data:
28  CONF_TITLE,
29  CONF_UNIQUE_ID,
30 }
31 
32 
34  hass: HomeAssistant, entry: ConfigEntry
35 ) -> dict[str, Any]:
36  """Return diagnostics for a config entry."""
37  coordinators: dict[str, OpenUvCoordinator] = hass.data[DOMAIN][entry.entry_id]
38 
39  return async_redact_data(
40  {
41  "entry": entry.as_dict(),
42  "data": {
43  coordinator_name: coordinator.data
44  for coordinator_name, coordinator in coordinators.items()
45  },
46  },
47  TO_REDACT,
48  )
dict async_redact_data(Mapping data, Iterable[Any] to_redact)
Definition: util.py:14
dict[str, Any] async_get_config_entry_diagnostics(HomeAssistant hass, ConfigEntry entry)
Definition: diagnostics.py:35