Home Assistant Unofficial Reference 2024.12.1
diagnostics.py
Go to the documentation of this file.
1 """Diagnostics support for Ridwell."""
2 
3 from __future__ import annotations
4 
5 import dataclasses
6 from typing import Any
7 
8 from homeassistant.components.diagnostics import async_redact_data
9 from homeassistant.config_entries import ConfigEntry
10 from homeassistant.const import CONF_PASSWORD, CONF_UNIQUE_ID, CONF_USERNAME
11 from homeassistant.core import HomeAssistant
12 
13 from .const import DOMAIN
14 from .coordinator import RidwellDataUpdateCoordinator
15 
16 CONF_TITLE = "title"
17 
18 TO_REDACT = {
19  CONF_PASSWORD,
20  # Config entry title and unique ID may contain sensitive data:
21  CONF_TITLE,
22  CONF_UNIQUE_ID,
23  CONF_USERNAME,
24 }
25 
26 
28  hass: HomeAssistant, entry: ConfigEntry
29 ) -> dict[str, Any]:
30  """Return diagnostics for a config entry."""
31  coordinator: RidwellDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
32 
33  return async_redact_data(
34  {
35  "entry": entry.as_dict(),
36  "data": [
37  dataclasses.asdict(event)
38  for events in coordinator.data.values()
39  for event in events
40  ],
41  },
42  TO_REDACT,
43  )
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:29