util.py

Go to the documentation of this file.

"""Diagnostic utilities."""
 
from __future__ import annotations
 
from collections.abc import Iterable, Mapping
from typing import Any, cast, overload
 
from homeassistant.core import callback
 
from .const import REDACTED
 
 
@overload
def async_redact_data(data: Mapping, to_redact: Iterable[Any]) -> dict: ...
 
 
@overload
def async_redact_data[_T](data: _T, to_redact: Iterable[Any]) -> _T: ...
 
 
@callback
def async_redact_data[_T](data: _T, to_redact: Iterable[Any]) -> _T:
    """Redact sensitive data in a dict."""
    if not isinstance(data, (Mapping, list)):
        return data
 
    if isinstance(data, list):
        return cast(_T, [async_redact_data(val, to_redact) for val in data])
 
    redacted = {**data}
 
    for key, value in redacted.items():
        if value is None:
            continue
        if isinstance(value, str) and not value:
            continue
        if key in to_redact:
            redacted[key] = REDACTED
        elif isinstance(value, Mapping):
            redacted[key] = async_redact_data(value, to_redact)
        elif isinstance(value, list):
            redacted[key] = [async_redact_data(item, to_redact) for item in value]
 
    return cast(_T, redacted)