entity_values.py

Go to the documentation of this file.

"""A class to hold entity values."""
 
from __future__ import annotations
 
import fnmatch
from functools import lru_cache
import re
from typing import Any
 
from homeassistant.const import MAX_EXPECTED_ENTITY_IDS
from homeassistant.core import split_entity_id
 
 
class EntityValues:
    """Class to store entity id based values.
 
    This class is expected to only be used infrequently
    as it caches all entity ids up to MAX_EXPECTED_ENTITY_IDS.
 
    The cache includes `self` so it is important to
    only use this in places where usage of `EntityValues` is immortal.
    """
 
    def __init__(
        self,
        exact: dict[str, dict[str, str]] | None = None,
        domain: dict[str, dict[str, str]] | None = None,
        glob: dict[str, dict[str, str]] | None = None,
    ) -> None:
        """Initialize an EntityConfigDict."""
        self._exact_exact = exact
        self._domain_domain = domain
 
        if glob is None:
            compiled: dict[re.Pattern[str], Any] | None = None
        else:
            compiled = {
                re.compile(fnmatch.translate(key)): value for key, value in glob.items()
            }
 
        self._glob_glob = compiled
 
    @lru_cache(maxsize=MAX_EXPECTED_ENTITY_IDS)
    def get(self, entity_id: str) -> dict[str, str]:
        """Get config for an entity id."""
        domain, _ = split_entity_id(entity_id)
        result: dict[str, str] = {}
 
        if self._domain_domain is not None and domain in self._domain_domain:
            result.update(self._domain_domain[domain])
 
        if self._glob_glob is not None:
            for pattern, values in self._glob_glob.items():
                if pattern.match(entity_id):
                    result.update(values)
 
        if self._exact_exact is not None and entity_id in self._exact_exact:
            result.update(self._exact_exact[entity_id])
 
        return result