mirror of
https://github.com/home-assistant/core
synced 2024-09-28 03:04:04 +02:00
44 lines
1.1 KiB
Python
44 lines
1.1 KiB
Python
"""Typing Helpers for Home Assistant."""
|
|
from collections.abc import Mapping
|
|
from enum import Enum
|
|
from typing import Any, Generic, TypeVar
|
|
|
|
import homeassistant.core
|
|
|
|
_DataT = TypeVar("_DataT")
|
|
|
|
GPSType = tuple[float, float]
|
|
ConfigType = dict[str, Any]
|
|
ContextType = homeassistant.core.Context
|
|
DiscoveryInfoType = dict[str, Any]
|
|
ServiceDataType = dict[str, Any]
|
|
StateType = str | int | float | None
|
|
TemplateVarsType = Mapping[str, Any] | None
|
|
|
|
# Custom type for recorder Queries
|
|
QueryType = Any
|
|
|
|
|
|
class UndefinedType(Enum):
|
|
"""Singleton type for use with not set sentinel values."""
|
|
|
|
_singleton = 0
|
|
|
|
|
|
UNDEFINED = UndefinedType._singleton # pylint: disable=protected-access
|
|
|
|
|
|
# The following types should not used and
|
|
# are not present in the core code base.
|
|
# They are kept in order not to break custom integrations
|
|
# that may rely on them.
|
|
# In due time they will be removed.
|
|
HomeAssistantType = homeassistant.core.HomeAssistant
|
|
ServiceCallType = homeassistant.core.ServiceCall
|
|
|
|
|
|
class EventType(homeassistant.core.Event, Generic[_DataT]):
|
|
"""Generic Event class to better type data."""
|
|
|
|
data: _DataT # type: ignore[assignment]
|