homeassistant-stubs 2025.1.1__py3-none-any.whl → 2025.1.3__py3-none-any.whl

homeassistant-stubs/data_entry_flow.pyi

@@ -91,21 +91,31 @@ class FlowManager(abc.ABC, Generic[_FlowContextT, _FlowResultT, _HandlerT], meta
     @abc.abstractmethod
     async def async_finish_flow(self, flow: FlowHandler[_FlowContextT, _FlowResultT, _HandlerT], result: _FlowResultT) -> _FlowResultT: ...
     async def async_post_init(self, flow: FlowHandler[_FlowContextT, _FlowResultT, _HandlerT], result: _FlowResultT) -> None: ...
+    @callback
     def async_get(self, flow_id: str) -> _FlowResultT: ...
+    @callback
     def async_progress(self, include_uninitialized: bool = False) -> list[_FlowResultT]: ...
+    @callback
     def async_progress_by_handler(self, handler: _HandlerT, include_uninitialized: bool = False, match_context: dict[str, Any] | None = None) -> list[_FlowResultT]: ...
+    @callback
     def async_progress_by_init_data_type(self, init_data_type: type, matcher: Callable[[Any], bool], include_uninitialized: bool = False) -> list[_FlowResultT]: ...
+    @callback
     def _async_progress_by_handler(self, handler: _HandlerT, match_context: dict[str, Any] | None) -> list[FlowHandler[_FlowContextT, _FlowResultT, _HandlerT]]: ...
     async def async_init(self, handler: _HandlerT, *, context: _FlowContextT | None = None, data: Any = None) -> _FlowResultT: ...
     async def async_configure(self, flow_id: str, user_input: dict | None = None) -> _FlowResultT: ...
     async def _async_configure(self, flow_id: str, user_input: dict | None = None) -> _FlowResultT: ...
+    @callback
     def async_abort(self, flow_id: str) -> None: ...
+    @callback
     def _async_add_flow_progress(self, flow: FlowHandler[_FlowContextT, _FlowResultT, _HandlerT]) -> None: ...
+    @callback
     def _async_remove_flow_from_index(self, flow: FlowHandler[_FlowContextT, _FlowResultT, _HandlerT]) -> None: ...
+    @callback
     def _async_remove_flow_progress(self, flow_id: str) -> None: ...
     async def _async_handle_step(self, flow: FlowHandler[_FlowContextT, _FlowResultT, _HandlerT], step_id: str, user_input: dict | BaseServiceInfo | None) -> _FlowResultT: ...
     def _raise_if_step_does_not_exist(self, flow: FlowHandler[_FlowContextT, _FlowResultT, _HandlerT], step_id: str) -> None: ...
     async def _async_setup_preview(self, flow: FlowHandler[_FlowContextT, _FlowResultT, _HandlerT]) -> None: ...
+    @callback
     def _async_flow_handler_to_flow_result(self, flows: Iterable[FlowHandler[_FlowContextT, _FlowResultT, _HandlerT]], include_uninitialized: bool) -> list[_FlowResultT]: ...
 
 class FlowHandler(Generic[_FlowContextT, _FlowResultT, _HandlerT]):
@@ -127,19 +137,31 @@ class FlowHandler(Generic[_FlowContextT, _FlowResultT, _HandlerT]):
     @property
     def show_advanced_options(self) -> bool: ...
     def add_suggested_values_to_schema(self, data_schema: vol.Schema, suggested_values: Mapping[str, Any] | None) -> vol.Schema: ...
+    @callback
     def async_show_form(self, *, step_id: str | None = None, data_schema: vol.Schema | None = None, errors: dict[str, str] | None = None, description_placeholders: Mapping[str, str] | None = None, last_step: bool | None = None, preview: str | None = None) -> _FlowResultT: ...
+    @callback
     def async_create_entry(self, *, title: str | None = None, data: Mapping[str, Any], description: str | None = None, description_placeholders: Mapping[str, str] | None = None) -> _FlowResultT: ...
+    @callback
     def async_abort(self, *, reason: str, description_placeholders: Mapping[str, str] | None = None) -> _FlowResultT: ...
+    @callback
     def async_external_step(self, *, step_id: str | None = None, url: str, description_placeholders: Mapping[str, str] | None = None) -> _FlowResultT: ...
+    @callback
     def async_external_step_done(self, *, next_step_id: str) -> _FlowResultT: ...
+    @callback
     def async_show_progress(self, *, step_id: str | None = None, progress_action: str, description_placeholders: Mapping[str, str] | None = None, progress_task: asyncio.Task[Any] | None = None) -> _FlowResultT: ...
+    @callback
     def async_show_progress_done(self, *, next_step_id: str) -> _FlowResultT: ...
+    @callback
     def async_show_menu(self, *, step_id: str | None = None, menu_options: Container[str], description_placeholders: Mapping[str, str] | None = None) -> _FlowResultT: ...
+    @callback
     def async_remove(self) -> None: ...
     @staticmethod
     async def async_setup_preview(hass: HomeAssistant) -> None: ...
+    @callback
     def async_cancel_progress_task(self) -> None: ...
+    @callback
     def async_get_progress_task(self) -> asyncio.Task[Any] | None: ...
+    @callback
     def async_set_progress_task(self, progress_task: asyncio.Task[Any]) -> None: ...
 
 class SectionConfig(TypedDict, total=False):

homeassistant-stubs/exceptions.pyi

@@ -36,13 +36,11 @@ class ConditionError(HomeAssistantError):
     def _indent(indent: int, message: str) -> str: ...
     def output(self, indent: int) -> Generator[str]: ...
     def __str__(self) -> str: ...
-    def __init__(self, type) -> None: ...
 
 @dataclass(slots=True)
 class ConditionErrorMessage(ConditionError):
     message: str
     def output(self, indent: int) -> Generator[str]: ...
-    def __init__(self, type, message) -> None: ...
 
 @dataclass(slots=True)
 class ConditionErrorIndex(ConditionError):
@@ -50,13 +48,11 @@ class ConditionErrorIndex(ConditionError):
     total: int
     error: ConditionError
     def output(self, indent: int) -> Generator[str]: ...
-    def __init__(self, type, index, total, error) -> None: ...
 
 @dataclass(slots=True)
 class ConditionErrorContainer(ConditionError):
     errors: Sequence[ConditionError]
     def output(self, indent: int) -> Generator[str]: ...
-    def __init__(self, type, errors) -> None: ...
 
 class IntegrationError(HomeAssistantError):
     def __str__(self) -> str: ...

homeassistant-stubs/helpers/aiohttp_client.pyi

@@ -26,16 +26,27 @@ MAXIMUM_CONNECTIONS_PER_HOST: int
 class HassClientResponse(aiohttp.ClientResponse):
     async def json(self, *args: Any, loads: JSONDecoder = ..., **kwargs: Any) -> Any: ...
 
+@callback
+@bind_hass
 def async_get_clientsession(hass: HomeAssistant, verify_ssl: bool = True, family: socket.AddressFamily = ..., ssl_cipher: ssl_util.SSLCipherList = ...) -> aiohttp.ClientSession: ...
+@callback
+@bind_hass
 def async_create_clientsession(hass: HomeAssistant, verify_ssl: bool = True, auto_cleanup: bool = True, family: socket.AddressFamily = ..., ssl_cipher: ssl_util.SSLCipherList = ..., **kwargs: Any) -> aiohttp.ClientSession: ...
+@callback
 def _async_create_clientsession(hass: HomeAssistant, verify_ssl: bool = True, auto_cleanup_method: Callable[[HomeAssistant, aiohttp.ClientSession], None] | None = None, family: socket.AddressFamily = ..., ssl_cipher: ssl_util.SSLCipherList = ..., **kwargs: Any) -> aiohttp.ClientSession: ...
+@bind_hass
 async def async_aiohttp_proxy_web(hass: HomeAssistant, request: web.BaseRequest, web_coro: Awaitable[aiohttp.ClientResponse], buffer_size: int = 102400, timeout: int = 10) -> web.StreamResponse | None: ...
+@bind_hass
 async def async_aiohttp_proxy_stream(hass: HomeAssistant, request: web.BaseRequest, stream: aiohttp.StreamReader, content_type: str | None, buffer_size: int = 102400, timeout: int = 10) -> web.StreamResponse: ...
+@callback
 def _async_register_clientsession_shutdown(hass: HomeAssistant, clientsession: aiohttp.ClientSession) -> None: ...
+@callback
 def _async_register_default_clientsession_shutdown(hass: HomeAssistant, clientsession: aiohttp.ClientSession) -> None: ...
+@callback
 def _make_key(verify_ssl: bool = True, family: socket.AddressFamily = ..., ssl_cipher: ssl_util.SSLCipherList = ...) -> tuple[bool, socket.AddressFamily, ssl_util.SSLCipherList]: ...
 
 class HomeAssistantTCPConnector(aiohttp.TCPConnector):
     _cleanup_closed_period: float
 
+@callback
 def _async_get_connector(hass: HomeAssistant, verify_ssl: bool = True, family: socket.AddressFamily = ..., ssl_cipher: ssl_util.SSLCipherList = ...) -> aiohttp.BaseConnector: ...

homeassistant-stubs/helpers/area_registry.pyi

@@ -6,7 +6,7 @@ from .storage import Store as Store
 from .typing import UNDEFINED as UNDEFINED, UndefinedType as UndefinedType
 from _typeshed import Incomplete
 from collections.abc import Iterable
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from homeassistant.core import HomeAssistant as HomeAssistant, callback as callback
 from homeassistant.util.dt import utc_from_timestamp as utc_from_timestamp, utcnow as utcnow
 from homeassistant.util.event_type import EventType as EventType
@@ -44,12 +44,11 @@ class AreaEntry(NormalizedNameBaseRegistryEntry):
     floor_id: str | None
     icon: str | None
     id: str
-    labels: set[str] = ...
+    labels: set[str] = field(default_factory=set)
     picture: str | None
-    _cache: dict[str, Any] = ...
+    _cache: dict[str, Any] = field(default_factory=dict, compare=False, init=False)
     @under_cached_property
     def json_fragment(self) -> json_fragment: ...
-    def __init__(self, *, name, created_at=..., modified_at=..., aliases, floor_id, icon, id, labels=..., picture) -> None: ...
 
 class AreaRegistryStore(Store[AreasRegistryStoreData]):
     async def _async_migrate_func(self, old_major_version: int, old_minor_version: int, old_data: dict[str, list[dict[str, Any]]]) -> AreasRegistryStoreData: ...
@@ -69,20 +68,33 @@ class AreaRegistry(BaseRegistry[AreasRegistryStoreData]):
     hass: Incomplete
     _store: Incomplete
     def __init__(self, hass: HomeAssistant) -> None: ...
+    @callback
     def async_get_area(self, area_id: str) -> AreaEntry | None: ...
+    @callback
     def async_get_area_by_name(self, name: str) -> AreaEntry | None: ...
+    @callback
     def async_list_areas(self) -> Iterable[AreaEntry]: ...
+    @callback
     def async_get_or_create(self, name: str) -> AreaEntry: ...
     def _generate_id(self, name: str) -> str: ...
+    @callback
     def async_create(self, name: str, *, aliases: set[str] | None = None, floor_id: str | None = None, icon: str | None = None, labels: set[str] | None = None, picture: str | None = None) -> AreaEntry: ...
+    @callback
     def async_delete(self, area_id: str) -> None: ...
+    @callback
     def async_update(self, area_id: str, *, aliases: set[str] | UndefinedType = ..., floor_id: str | None | UndefinedType = ..., icon: str | None | UndefinedType = ..., labels: set[str] | UndefinedType = ..., name: str | UndefinedType = ..., picture: str | None | UndefinedType = ...) -> AreaEntry: ...
+    @callback
     def _async_update(self, area_id: str, *, aliases: set[str] | UndefinedType = ..., floor_id: str | None | UndefinedType = ..., icon: str | None | UndefinedType = ..., labels: set[str] | UndefinedType = ..., name: str | UndefinedType = ..., picture: str | None | UndefinedType = ...) -> AreaEntry: ...
     async def async_load(self) -> None: ...
+    @callback
     def _data_to_save(self) -> AreasRegistryStoreData: ...
+    @callback
     def _async_setup_cleanup(self) -> None: ...
 
+@callback
 def async_get(hass: HomeAssistant) -> AreaRegistry: ...
 async def async_load(hass: HomeAssistant) -> None: ...
+@callback
 def async_entries_for_floor(registry: AreaRegistry, floor_id: str) -> list[AreaEntry]: ...
+@callback
 def async_entries_for_label(registry: AreaRegistry, label_id: str) -> list[AreaEntry]: ...

homeassistant-stubs/helpers/category_registry.pyi

@@ -4,7 +4,7 @@ from .storage import Store as Store
 from .typing import UNDEFINED as UNDEFINED, UndefinedType as UndefinedType
 from _typeshed import Incomplete
 from collections.abc import Iterable
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from datetime import datetime
 from homeassistant.core import Event as Event, HomeAssistant as HomeAssistant, callback as callback
 from homeassistant.util.dt import utc_from_timestamp as utc_from_timestamp, utcnow as utcnow
@@ -37,12 +37,11 @@ type EventCategoryRegistryUpdated = Event[EventCategoryRegistryUpdatedData]
 
 @dataclass(slots=True, kw_only=True, frozen=True)
 class CategoryEntry:
-    category_id: str = ...
-    created_at: datetime = ...
+    category_id: str = field(default_factory=ulid_now)
+    created_at: datetime = field(default_factory=utcnow)
     icon: str | None = ...
-    modified_at: datetime = ...
+    modified_at: datetime = field(default_factory=utcnow)
     name: str
-    def __init__(self, *, category_id=..., created_at=..., icon=..., modified_at=..., name) -> None: ...
 
 class CategoryRegistryStore(Store[CategoryRegistryStoreData]):
     async def _async_migrate_func(self, old_major_version: int, old_minor_version: int, old_data: dict[str, dict[str, list[dict[str, Any]]]]) -> CategoryRegistryStoreData: ...
@@ -52,14 +51,22 @@ class CategoryRegistry(BaseRegistry[CategoryRegistryStoreData]):
     categories: dict[str, dict[str, CategoryEntry]]
     _store: Incomplete
     def __init__(self, hass: HomeAssistant) -> None: ...
+    @callback
     def async_get_category(self, *, scope: str, category_id: str) -> CategoryEntry | None: ...
+    @callback
     def async_list_categories(self, *, scope: str) -> Iterable[CategoryEntry]: ...
+    @callback
     def async_create(self, *, name: str, scope: str, icon: str | None = None) -> CategoryEntry: ...
+    @callback
     def async_delete(self, *, scope: str, category_id: str) -> None: ...
+    @callback
     def async_update(self, *, scope: str, category_id: str, icon: str | None | UndefinedType = ..., name: str | UndefinedType = ...) -> CategoryEntry: ...
     async def async_load(self) -> None: ...
+    @callback
     def _data_to_save(self) -> CategoryRegistryStoreData: ...
+    @callback
     def _async_ensure_name_is_available(self, scope: str, name: str, category_id: str | None = None) -> None: ...
 
+@callback
 def async_get(hass: HomeAssistant) -> CategoryRegistry: ...
 async def async_load(hass: HomeAssistant) -> None: ...

homeassistant-stubs/helpers/collection.pyi

@@ -31,7 +31,6 @@ class CollectionChange:
     item_id: str
     item: Any
     item_hash: str | None = ...
-    def __init__(self, change_type, item_id, item, item_hash=...) -> None: ...
 type ChangeListener = Callable[[str, str, dict], Awaitable[None]]
 type ChangeSetListener = Callable[[Iterable[CollectionChange]], Awaitable[None]]
 
@@ -64,8 +63,11 @@ class ObservableCollection[_ItemT](ABC):
     listeners: list[ChangeListener]
     change_set_listeners: list[ChangeSetListener]
     def __init__(self, id_manager: IDManager | None) -> None: ...
+    @callback
     def async_items(self) -> list[_ItemT]: ...
+    @callback
     def async_add_listener(self, listener: ChangeListener) -> Callable[[], None]: ...
+    @callback
     def async_add_change_set_listener(self, listener: ChangeSetListener) -> Callable[[], None]: ...
     async def notify_changes(self, change_set: Iterable[CollectionChange]) -> None: ...
 
@@ -90,6 +92,7 @@ class StorageCollection[_ItemT, _StoreT: SerializedStorageCollection](Observable
     async def async_load(self) -> None: ...
     @abstractmethod
     async def _process_create_data(self, data: dict) -> dict: ...
+    @callback
     @abstractmethod
     def _get_suggested_id(self, info: dict) -> str: ...
     @abstractmethod
@@ -103,9 +106,12 @@ class StorageCollection[_ItemT, _StoreT: SerializedStorageCollection](Observable
     async def async_create_item(self, data: dict) -> _ItemT: ...
     async def async_update_item(self, item_id: str, updates: dict) -> _ItemT: ...
     async def async_delete_item(self, item_id: str) -> None: ...
+    @callback
     def _async_schedule_save(self) -> None: ...
+    @callback
     def _base_data_to_save(self) -> SerializedStorageCollection: ...
     @abstractmethod
+    @callback
     def _data_to_save(self) -> _StoreT: ...
     def _hash_item(self, item: dict) -> str: ...
 
@@ -113,6 +119,7 @@ class DictStorageCollection(StorageCollection[dict, SerializedStorageCollection]
     def _create_item(self, item_id: str, data: dict) -> dict: ...
     def _deserialize_item(self, data: dict) -> dict: ...
     def _serialize_item(self, item_id: str, item: dict) -> dict: ...
+    @callback
     def _data_to_save(self) -> SerializedStorageCollection: ...
 
 class IDLessCollection(YamlCollection):
@@ -130,14 +137,16 @@ class _CollectionLifeCycle(Generic[_EntityT]):
     entity_class: type[CollectionEntity]
     ent_reg: entity_registry.EntityRegistry
     entities: dict[str, CollectionEntity]
+    @callback
     def async_setup(self) -> None: ...
     def _entity_removed(self, item_id: str) -> None: ...
+    @callback
     def _add_entity(self, change_set: CollectionChange) -> CollectionEntity: ...
     async def _remove_entity(self, change_set: CollectionChange) -> None: ...
     async def _update_entity(self, change_set: CollectionChange) -> None: ...
     async def _collection_changed(self, change_set: Iterable[CollectionChange]) -> None: ...
-    def __init__(self, domain, platform, entity_component, collection, entity_class, ent_reg, entities) -> None: ...
 
+@callback
 def sync_entity_lifecycle(hass: HomeAssistant, domain: str, platform: str, entity_component: EntityComponent[_EntityT], collection: StorageCollection | YamlCollection, entity_class: type[CollectionEntity]) -> None: ...
 
 class StorageCollectionWebsocket[_StorageCollectionT: StorageCollection]:
@@ -151,9 +160,12 @@ class StorageCollectionWebsocket[_StorageCollectionT: StorageCollection]:
     def __init__(self, storage_collection: _StorageCollectionT, api_prefix: str, model_name: str, create_schema: VolDictType, update_schema: VolDictType) -> None: ...
     @property
     def item_id_key(self) -> str: ...
+    @callback
     def async_setup(self, hass: HomeAssistant) -> None: ...
+    @callback
     def ws_list_item(self, hass: HomeAssistant, connection: websocket_api.ActiveConnection, msg: dict) -> None: ...
     async def ws_create_item(self, hass: HomeAssistant, connection: websocket_api.ActiveConnection, msg: dict) -> None: ...
+    @callback
     def _ws_subscribe(self, hass: HomeAssistant, connection: websocket_api.ActiveConnection, msg: dict) -> None: ...
     async def ws_update_item(self, hass: HomeAssistant, connection: websocket_api.ActiveConnection, msg: dict) -> None: ...
     async def ws_delete_item(self, hass: HomeAssistant, connection: websocket_api.ActiveConnection, msg: dict) -> None: ...

homeassistant-stubs/helpers/condition.pyi

@@ -6,6 +6,7 @@ from .trace import TraceElement as TraceElement, trace_append_element as trace_a
 from .typing import ConfigType as ConfigType, TemplateVarsType as TemplateVarsType
 from _typeshed import Incomplete
 from collections.abc import Callable, Container, Generator
+from contextlib import contextmanager
 from datetime import time as dt_time, timedelta
 from homeassistant.components.sensor import SensorDeviceClass as SensorDeviceClass
 from homeassistant.const import ATTR_DEVICE_CLASS as ATTR_DEVICE_CLASS, ATTR_GPS_ACCURACY as ATTR_GPS_ACCURACY, ATTR_LATITUDE as ATTR_LATITUDE, ATTR_LONGITUDE as ATTR_LONGITUDE, CONF_ABOVE as CONF_ABOVE, CONF_AFTER as CONF_AFTER, CONF_ATTRIBUTE as CONF_ATTRIBUTE, CONF_BEFORE as CONF_BEFORE, CONF_BELOW as CONF_BELOW, CONF_CONDITION as CONF_CONDITION, CONF_DEVICE_ID as CONF_DEVICE_ID, CONF_ENABLED as CONF_ENABLED, CONF_ENTITY_ID as CONF_ENTITY_ID, CONF_FOR as CONF_FOR, CONF_ID as CONF_ID, CONF_MATCH as CONF_MATCH, CONF_STATE as CONF_STATE, CONF_VALUE_TEMPLATE as CONF_VALUE_TEMPLATE, CONF_WEEKDAY as CONF_WEEKDAY, CONF_ZONE as CONF_ZONE, ENTITY_MATCH_ALL as ENTITY_MATCH_ALL, ENTITY_MATCH_ANY as ENTITY_MATCH_ANY, STATE_UNAVAILABLE as STATE_UNAVAILABLE, STATE_UNKNOWN as STATE_UNKNOWN, SUN_EVENT_SUNRISE as SUN_EVENT_SUNRISE, SUN_EVENT_SUNSET as SUN_EVENT_SUNSET, WEEKDAYS as WEEKDAYS
@@ -30,6 +31,7 @@ type ConditionCheckerType = Callable[[HomeAssistant, TemplateVarsType], bool | N
 def condition_trace_append(variables: TemplateVarsType, path: str) -> TraceElement: ...
 def condition_trace_set_result(result: bool, **kwargs: Any) -> None: ...
 def condition_trace_update_result(**kwargs: Any) -> None: ...
+@contextmanager
 def trace_condition(variables: TemplateVarsType) -> Generator[TraceElement]: ...
 def trace_condition_function(condition: ConditionCheckerType) -> ConditionCheckerType: ...
 async def _async_get_condition_platform(hass: HomeAssistant, config: ConfigType) -> ConditionProtocol | None: ...
@@ -57,5 +59,7 @@ def state_validate_config(hass: HomeAssistant, config: ConfigType) -> ConfigType
 async def async_validate_condition_config(hass: HomeAssistant, config: ConfigType) -> ConfigType: ...
 async def async_validate_conditions_config(hass: HomeAssistant, conditions: list[ConfigType]) -> list[ConfigType | Template]: ...
 async def async_conditions_from_config(hass: HomeAssistant, condition_configs: list[ConfigType], logger: logging.Logger, name: str) -> Callable[[TemplateVarsType], bool]: ...
+@callback
 def async_extract_entities(config: ConfigType | Template) -> set[str]: ...
+@callback
 def async_extract_devices(config: ConfigType | Template) -> set[str]: ...

homeassistant-stubs/helpers/config_entry_oauth2_flow.pyi

@@ -81,9 +81,11 @@ class AbstractOAuth2FlowHandler(config_entries.ConfigFlow, metaclass=ABCMeta):
     @classmethod
     def async_register_implementation(cls, hass: HomeAssistant, local_impl: LocalOAuth2Implementation) -> None: ...
 
+@callback
 def async_register_implementation(hass: HomeAssistant, domain: str, implementation: AbstractOAuth2Implementation) -> None: ...
 async def async_get_implementations(hass: HomeAssistant, domain: str) -> dict[str, AbstractOAuth2Implementation]: ...
 async def async_get_config_entry_implementation(hass: HomeAssistant, config_entry: config_entries.ConfigEntry) -> AbstractOAuth2Implementation: ...
+@callback
 def async_add_implementation_provider(hass: HomeAssistant, provider_domain: str, async_provide_implementation: Callable[[HomeAssistant, str], Awaitable[list[AbstractOAuth2Implementation]]]) -> None: ...
 
 class OAuth2AuthorizeCallbackView(http.HomeAssistantView):
@@ -106,5 +108,7 @@ class OAuth2Session:
     async def async_request(self, method: str, url: str, **kwargs: Any) -> client.ClientResponse: ...
 
 async def async_oauth2_request(hass: HomeAssistant, token: dict, method: str, url: str, **kwargs: Any) -> client.ClientResponse: ...
+@callback
 def _encode_jwt(hass: HomeAssistant, data: dict) -> str: ...
+@callback
 def _decode_jwt(hass: HomeAssistant, encoded: str) -> dict[str, Any] | None: ...

homeassistant-stubs/helpers/config_validation.pyi

@@ -56,10 +56,13 @@ def has_at_least_one_key(*keys: Any) -> Callable[[dict], dict]: ...
 def has_at_most_one_key(*keys: Any) -> Callable[[dict], dict]: ...
 def boolean(value: Any) -> bool: ...
 def whitespace(value: Any) -> str: ...
+@not_async_friendly
 def isdevice(value: Any) -> str: ...
 def matches_regex(regex: str) -> Callable[[Any], str]: ...
 def is_regex(value: Any) -> re.Pattern[Any]: ...
+@not_async_friendly
 def isfile(value: Any) -> str: ...
+@not_async_friendly
 def isdir(value: Any) -> str: ...
 @overload
 def ensure_list(value: None) -> list[Any]: ...

homeassistant-stubs/helpers/debounce.pyi

@@ -21,11 +21,16 @@ class Debouncer[_R_co]:
     def function(self) -> Callable[[], _R_co] | None: ...
     @function.setter
     def function(self, function: Callable[[], _R_co]) -> None: ...
+    @callback
     def async_schedule_call(self) -> None: ...
     def _async_schedule_or_call_now(self) -> bool: ...
     async def async_call(self) -> None: ...
     async def _handle_timer_finish(self) -> None: ...
+    @callback
     def async_shutdown(self) -> None: ...
+    @callback
     def async_cancel(self) -> None: ...
+    @callback
     def _on_debounce(self) -> None: ...
+    @callback
     def _schedule_timer(self) -> None: ...

homeassistant-stubs/helpers/device.pyi

@@ -1,8 +1,13 @@
 from . import device_registry as dr
 from homeassistant.core import HomeAssistant as HomeAssistant, callback as callback
 
+@callback
 def async_entity_id_to_device_id(hass: HomeAssistant, entity_id_or_uuid: str) -> str | None: ...
+@callback
 def async_device_info_to_link_from_entity(hass: HomeAssistant, entity_id_or_uuid: str) -> dr.DeviceInfo | None: ...
+@callback
 def async_device_info_to_link_from_device_id(hass: HomeAssistant, device_id: str | None) -> dr.DeviceInfo | None: ...
+@callback
 def async_remove_stale_devices_links_keep_entity_device(hass: HomeAssistant, entry_id: str, source_entity_id_or_uuid: str) -> None: ...
+@callback
 def async_remove_stale_devices_links_keep_current_device(hass: HomeAssistant, entry_id: str, current_device_id: str | None) -> None: ...

homeassistant-stubs/helpers/device_registry.pyi

@@ -188,28 +188,47 @@ class DeviceRegistry(BaseRegistry[dict[str, list[dict[str, Any]]]]):
     hass: Incomplete
     _store: Incomplete
     def __init__(self, hass: HomeAssistant) -> None: ...
+    @callback
     def async_get(self, device_id: str) -> DeviceEntry | None: ...
+    @callback
     def async_get_device(self, identifiers: set[tuple[str, str]] | None = None, connections: set[tuple[str, str]] | None = None) -> DeviceEntry | None: ...
     def _async_get_deleted_device(self, identifiers: set[tuple[str, str]], connections: set[tuple[str, str]]) -> DeletedDeviceEntry | None: ...
     def _substitute_name_placeholders(self, domain: str, name: str, translation_placeholders: Mapping[str, str]) -> str: ...
+    @callback
     def async_get_or_create(self, *, config_entry_id: str, configuration_url: str | URL | None | UndefinedType = ..., connections: set[tuple[str, str]] | None | UndefinedType = ..., created_at: str | datetime | UndefinedType = ..., default_manufacturer: str | None | UndefinedType = ..., default_model: str | None | UndefinedType = ..., default_name: str | None | UndefinedType = ..., disabled_by: DeviceEntryDisabler | None | UndefinedType = ..., entry_type: DeviceEntryType | None | UndefinedType = ..., hw_version: str | None | UndefinedType = ..., identifiers: set[tuple[str, str]] | None | UndefinedType = ..., manufacturer: str | None | UndefinedType = ..., model: str | None | UndefinedType = ..., model_id: str | None | UndefinedType = ..., modified_at: str | datetime | UndefinedType = ..., name: str | None | UndefinedType = ..., serial_number: str | None | UndefinedType = ..., suggested_area: str | None | UndefinedType = ..., sw_version: str | None | UndefinedType = ..., translation_key: str | None = None, translation_placeholders: Mapping[str, str] | None = None, via_device: tuple[str, str] | None | UndefinedType = ...) -> DeviceEntry: ...
+    @callback
     def async_update_device(self, device_id: str, *, add_config_entry_id: str | UndefinedType = ..., allow_collisions: bool = False, area_id: str | None | UndefinedType = ..., configuration_url: str | URL | None | UndefinedType = ..., device_info_type: str | UndefinedType = ..., disabled_by: DeviceEntryDisabler | None | UndefinedType = ..., entry_type: DeviceEntryType | None | UndefinedType = ..., hw_version: str | None | UndefinedType = ..., labels: set[str] | UndefinedType = ..., manufacturer: str | None | UndefinedType = ..., merge_connections: set[tuple[str, str]] | UndefinedType = ..., merge_identifiers: set[tuple[str, str]] | UndefinedType = ..., model: str | None | UndefinedType = ..., model_id: str | None | UndefinedType = ..., name_by_user: str | None | UndefinedType = ..., name: str | None | UndefinedType = ..., new_connections: set[tuple[str, str]] | UndefinedType = ..., new_identifiers: set[tuple[str, str]] | UndefinedType = ..., remove_config_entry_id: str | UndefinedType = ..., serial_number: str | None | UndefinedType = ..., suggested_area: str | None | UndefinedType = ..., sw_version: str | None | UndefinedType = ..., via_device_id: str | None | UndefinedType = ...) -> DeviceEntry | None: ...
+    @callback
     def _validate_connections(self, device_id: str, connections: set[tuple[str, str]], allow_collisions: bool) -> set[tuple[str, str]]: ...
+    @callback
     def _validate_identifiers(self, device_id: str, identifiers: set[tuple[str, str]], allow_collisions: bool) -> set[tuple[str, str]]: ...
+    @callback
     def async_remove_device(self, device_id: str) -> None: ...
     async def async_load(self) -> None: ...
+    @callback
     def _data_to_save(self) -> dict[str, Any]: ...
+    @callback
     def async_clear_config_entry(self, config_entry_id: str) -> None: ...
+    @callback
     def async_purge_expired_orphaned_devices(self) -> None: ...
+    @callback
     def async_clear_area_id(self, area_id: str) -> None: ...
+    @callback
     def async_clear_label_id(self, label_id: str) -> None: ...
 
+@callback
 def async_get(hass: HomeAssistant) -> DeviceRegistry: ...
 async def async_load(hass: HomeAssistant) -> None: ...
+@callback
 def async_entries_for_area(registry: DeviceRegistry, area_id: str) -> list[DeviceEntry]: ...
+@callback
 def async_entries_for_label(registry: DeviceRegistry, label_id: str) -> list[DeviceEntry]: ...
+@callback
 def async_entries_for_config_entry(registry: DeviceRegistry, config_entry_id: str) -> list[DeviceEntry]: ...
+@callback
 def async_config_entry_disabled_by_changed(registry: DeviceRegistry, config_entry: ConfigEntry) -> None: ...
+@callback
 def async_cleanup(hass: HomeAssistant, dev_reg: DeviceRegistry, ent_reg: entity_registry.EntityRegistry) -> None: ...
+@callback
 def async_setup_cleanup(hass: HomeAssistant, dev_reg: DeviceRegistry) -> None: ...
 def _normalize_connections(connections: set[tuple[str, str]]) -> set[tuple[str, str]]: ...

homeassistant-stubs/helpers/discovery.pyi

@@ -17,9 +17,16 @@ class DiscoveryDict(TypedDict):
     platform: str | None
     discovered: DiscoveryInfoType | None
 
+@core.callback
+@bind_hass
 def async_listen(hass: core.HomeAssistant, service: str, callback: Callable[[str, DiscoveryInfoType | None], Coroutine[Any, Any, None] | None]) -> None: ...
+@bind_hass
 def discover(hass: core.HomeAssistant, service: str, discovered: DiscoveryInfoType, component: str, hass_config: ConfigType) -> None: ...
+@bind_hass
 async def async_discover(hass: core.HomeAssistant, service: str, discovered: DiscoveryInfoType | None, component: str | None, hass_config: ConfigType) -> None: ...
+@bind_hass
 def async_listen_platform(hass: core.HomeAssistant, component: str, callback: Callable[[str, dict[str, Any] | None], Any]) -> Callable[[], None]: ...
+@bind_hass
 def load_platform(hass: core.HomeAssistant, component: Platform | str, platform: str, discovered: DiscoveryInfoType | None, hass_config: ConfigType) -> None: ...
+@bind_hass
 async def async_load_platform(hass: core.HomeAssistant, component: Platform | str, platform: str, discovered: DiscoveryInfoType | None, hass_config: ConfigType) -> None: ...

homeassistant-stubs/helpers/discovery_flow.pyi

@@ -19,9 +19,11 @@ class DiscoveryKey:
     version: int
     @classmethod
     def from_json_dict(cls, json_dict: dict[str, Any]) -> Self: ...
-    def __init__(self, *, domain, key, version) -> None: ...
 
+@bind_hass
+@callback
 def async_create_flow(hass: HomeAssistant, domain: str, context: ConfigFlowContext, data: Any, *, discovery_key: DiscoveryKey | None = None) -> None: ...
+@callback
 def _async_init_flow(hass: HomeAssistant, domain: str, context: ConfigFlowContext, data: Any) -> Coroutine[None, None, ConfigFlowResult] | None: ...
 
 class PendingFlowKey(NamedTuple):
@@ -37,6 +39,8 @@ class FlowDispatcher:
     started: bool
     pending_flows: dict[PendingFlowKey, list[PendingFlowValue]]
     def __init__(self, hass: HomeAssistant) -> None: ...
+    @callback
     def async_setup(self) -> None: ...
     async def _async_start(self, event: Event) -> None: ...
+    @callback
     def async_create(self, domain: str, context: ConfigFlowContext, data: Any) -> None: ...

homeassistant-stubs/helpers/dispatcher.pyi

@@ -12,22 +12,37 @@ DATA_DISPATCHER: str
 type _DispatcherDataType[*_Ts] = dict[SignalType[*_Ts] | str, dict[Callable[[*_Ts], Any] | Callable[..., Any], HassJob[..., None | Coroutine[Any, Any, None]] | None]]
 
 @overload
+@bind_hass
 def dispatcher_connect[*_Ts](hass: HomeAssistant, signal: SignalType[*_Ts], target: Callable[[*_Ts], None]) -> Callable[[], None]: ...
 @overload
+@bind_hass
 def dispatcher_connect(hass: HomeAssistant, signal: str, target: Callable[..., None]) -> Callable[[], None]: ...
+@callback
 def _async_remove_dispatcher[*_Ts](dispatchers: _DispatcherDataType[*_Ts], signal: SignalType[*_Ts] | str, target: Callable[[*_Ts], Any] | Callable[..., Any]) -> None: ...
 @overload
+@callback
+@bind_hass
 def async_dispatcher_connect[*_Ts](hass: HomeAssistant, signal: SignalType[*_Ts], target: Callable[[*_Ts], Any]) -> Callable[[], None]: ...
 @overload
+@callback
+@bind_hass
 def async_dispatcher_connect(hass: HomeAssistant, signal: str, target: Callable[..., Any]) -> Callable[[], None]: ...
 @overload
+@bind_hass
 def dispatcher_send[*_Ts](hass: HomeAssistant, signal: SignalType[*_Ts], *args: *_Ts) -> None: ...
 @overload
+@bind_hass
 def dispatcher_send(hass: HomeAssistant, signal: str, *args: Any) -> None: ...
 def _format_err[*_Ts](signal: SignalType[*_Ts] | str, target: Callable[[*_Ts], Any] | Callable[..., Any], *args: Any) -> str: ...
 def _generate_job[*_Ts](signal: SignalType[*_Ts] | str, target: Callable[[*_Ts], Any] | Callable[..., Any]) -> HassJob[..., Coroutine[Any, Any, None] | None]: ...
 @overload
+@callback
+@bind_hass
 def async_dispatcher_send[*_Ts](hass: HomeAssistant, signal: SignalType[*_Ts], *args: *_Ts) -> None: ...
 @overload
+@callback
+@bind_hass
 def async_dispatcher_send(hass: HomeAssistant, signal: str, *args: Any) -> None: ...
+@callback
+@bind_hass
 def async_dispatcher_send_internal[*_Ts](hass: HomeAssistant, signal: SignalType[*_Ts] | str, *args: *_Ts) -> None: ...