Home Assistant Unofficial Reference 2024.12.1
diagnostics.py
Go to the documentation of this file.
1 """Diagnostics support for Notion."""
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 CONF_EMAIL, CONF_UNIQUE_ID, CONF_USERNAME
10 from homeassistant.core import HomeAssistant
11 
12 from .const import CONF_REFRESH_TOKEN, CONF_USER_UUID, DOMAIN
13 from .coordinator import NotionDataUpdateCoordinator
14 
15 CONF_DEVICE_KEY = "device_key"
16 CONF_HARDWARE_ID = "hardware_id"
17 CONF_LAST_BRIDGE_HARDWARE_ID = "last_bridge_hardware_id"
18 CONF_TITLE = "title"
19 CONF_USER_ID = "user_id"
20 
21 TO_REDACT = {
22  CONF_DEVICE_KEY,
23  CONF_EMAIL,
24  CONF_HARDWARE_ID,
25  CONF_LAST_BRIDGE_HARDWARE_ID,
26  CONF_REFRESH_TOKEN,
27  # Config entry title and unique ID may contain sensitive data:
28  CONF_TITLE,
29  CONF_UNIQUE_ID,
30  CONF_USERNAME,
31  CONF_USER_ID,
32  CONF_USER_UUID,
33 }
34 
35 
37  hass: HomeAssistant, entry: ConfigEntry
38 ) -> dict[str, Any]:
39  """Return diagnostics for a config entry."""
40  coordinator: NotionDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
41 
42  return async_redact_data(
43  {
44  "entry": entry.as_dict(),
45  "data": coordinator.data.asdict(),
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:38