homeassistant-stubs 2025.1.2__py3-none-any.whl → 2025.1.4__py3-none-any.whl

homeassistant-stubs/config_entries.pyi

@@ -33,6 +33,7 @@ from collections.abc import Callable, Coroutine, Generator, Iterable, Mapping, V
 from contextvars import ContextVar
 from datetime import datetime
 from enum import Enum, StrEnum
+from functools import cache
 from propcache import cached_property
 from types import MappingProxyType
 from typing import Any, Generic, Self
@@ -86,6 +87,7 @@ RECONFIGURE_NOTIFICATION_ID: str
 EVENT_FLOW_DISCOVERED: str
 SIGNAL_CONFIG_ENTRY_CHANGED: Incomplete
 
+@cache
 def signal_discovered_config_entry_removed(discovery_domain: str) -> SignalType[ConfigEntry]: ...
 
 NO_RESET_TRIES_STATES: Incomplete
@@ -181,22 +183,31 @@ class ConfigEntry(Generic[_DataT]):
     def as_storage_fragment(self) -> json_fragment: ...
     async def async_setup(self, hass: HomeAssistant, *, integration: loader.Integration | None = None) -> None: ...
     async def __async_setup_with_context(self, hass: HomeAssistant, integration: loader.Integration | None) -> None: ...
+    @callback
     def _async_setup_again(self, hass: HomeAssistant, *_: Any) -> None: ...
     async def async_setup_locked(self, hass: HomeAssistant, integration: loader.Integration | None = None) -> None: ...
+    @callback
     def async_shutdown(self) -> None: ...
+    @callback
     def async_cancel_retry_setup(self) -> None: ...
     async def async_unload(self, hass: HomeAssistant, *, integration: loader.Integration | None = None) -> bool: ...
     async def async_remove(self, hass: HomeAssistant) -> None: ...
+    @callback
     def _async_set_state(self, hass: HomeAssistant, state: ConfigEntryState, reason: str | None, error_reason_translation_key: str | None = None, error_reason_translation_placeholders: dict[str, str] | None = None) -> None: ...
     async def async_migrate(self, hass: HomeAssistant) -> bool: ...
     def add_update_listener(self, listener: UpdateListenerType) -> CALLBACK_TYPE: ...
     def as_dict(self) -> dict[str, Any]: ...
+    @callback
     def async_on_unload(self, func: Callable[[], Coroutine[Any, Any, None] | None]) -> None: ...
     async def _async_process_on_unload(self, hass: HomeAssistant) -> None: ...
+    @callback
     def async_start_reauth(self, hass: HomeAssistant, context: ConfigFlowContext | None = None, data: dict[str, Any] | None = None) -> None: ...
     async def _async_init_reauth(self, hass: HomeAssistant, context: ConfigFlowContext | None = None, data: dict[str, Any] | None = None) -> None: ...
+    @callback
     def async_get_active_flows(self, hass: HomeAssistant, sources: set[str]) -> Generator[ConfigFlowResult]: ...
+    @callback
     def async_create_task[_R](self, hass: HomeAssistant, target: Coroutine[Any, Any, _R], name: str | None = None, eager_start: bool = True) -> asyncio.Task[_R]: ...
+    @callback
     def async_create_background_task[_R](self, hass: HomeAssistant, target: Coroutine[Any, Any, _R], name: str, eager_start: bool = True) -> asyncio.Task[_R]: ...
 
 current_entry: ContextVar[ConfigEntry | None]
@@ -214,16 +225,21 @@ class ConfigEntriesFlowManager(data_entry_flow.FlowManager[ConfigFlowContext, Co
     _discovery_debouncer: Incomplete
     def __init__(self, hass: HomeAssistant, config_entries: ConfigEntries, hass_config: ConfigType) -> None: ...
     async def async_wait_import_flow_initialized(self, handler: str) -> None: ...
+    @callback
     def _async_has_other_discovery_flows(self, flow_id: str) -> bool: ...
     async def async_init(self, handler: str, *, context: ConfigFlowContext | None = None, data: Any = None) -> ConfigFlowResult: ...
     async def _async_init(self, flow_id: str, handler: str, context: ConfigFlowContext, data: Any) -> tuple[ConfigFlow, ConfigFlowResult]: ...
     def _set_pending_import_done(self, flow: ConfigFlow) -> None: ...
+    @callback
     def async_shutdown(self) -> None: ...
     async def async_finish_flow(self, flow: data_entry_flow.FlowHandler[ConfigFlowContext, ConfigFlowResult], result: ConfigFlowResult) -> ConfigFlowResult: ...
     async def async_create_flow(self, handler_key: str, *, context: ConfigFlowContext | None = None, data: Any = None) -> ConfigFlow: ...
     async def async_post_init(self, flow: data_entry_flow.FlowHandler[ConfigFlowContext, ConfigFlowResult], result: ConfigFlowResult) -> None: ...
+    @callback
     def _async_discovery(self) -> None: ...
+    @callback
     def async_has_matching_discovery_flow(self, handler: str, match_context: ConfigFlowContext, data: Any) -> bool: ...
+    @callback
     def async_has_matching_flow(self, flow: ConfigFlow) -> bool: ...
 
 class ConfigEntryItems(UserDict[str, ConfigEntry]):
@@ -253,26 +269,39 @@ class ConfigEntries:
     _entries: Incomplete
     _store: Incomplete
     def __init__(self, hass: HomeAssistant, hass_config: ConfigType) -> None: ...
+    @callback
     def async_domains(self, include_ignore: bool = False, include_disabled: bool = False) -> list[str]: ...
+    @callback
     def async_get_entry(self, entry_id: str) -> ConfigEntry | None: ...
+    @callback
     def async_get_known_entry(self, entry_id: str) -> ConfigEntry: ...
+    @callback
     def async_entry_ids(self) -> list[str]: ...
+    @callback
     def async_has_entries(self, domain: str, include_ignore: bool = True, include_disabled: bool = True) -> bool: ...
+    @callback
     def async_entries(self, domain: str | None = None, include_ignore: bool = True, include_disabled: bool = True) -> list[ConfigEntry]: ...
+    @callback
     def async_loaded_entries(self, domain: str) -> list[ConfigEntry]: ...
+    @callback
     def async_entry_for_domain_unique_id(self, domain: str, unique_id: str) -> ConfigEntry | None: ...
     async def async_add(self, entry: ConfigEntry) -> None: ...
     async def async_remove(self, entry_id: str) -> dict[str, Any]: ...
     async def _async_remove(self, entry_id: str) -> tuple[bool, ConfigEntry]: ...
+    @callback
     def _async_clean_up(self, entry: ConfigEntry) -> None: ...
+    @callback
     def _async_shutdown(self, event: Event) -> None: ...
     async def async_initialize(self) -> None: ...
     async def async_setup(self, entry_id: str, _lock: bool = True) -> bool: ...
     async def async_unload(self, entry_id: str, _lock: bool = True) -> bool: ...
+    @callback
     def async_schedule_reload(self, entry_id: str) -> None: ...
     async def async_reload(self, entry_id: str) -> bool: ...
     async def async_set_disabled_by(self, entry_id: str, disabled_by: ConfigEntryDisabler | None) -> bool: ...
+    @callback
     def async_update_entry(self, entry: ConfigEntry, *, data: Mapping[str, Any] | UndefinedType = ..., discovery_keys: MappingProxyType[str, tuple[DiscoveryKey, ...]] | UndefinedType = ..., minor_version: int | UndefinedType = ..., options: Mapping[str, Any] | UndefinedType = ..., pref_disable_new_entities: bool | UndefinedType = ..., pref_disable_polling: bool | UndefinedType = ..., title: str | UndefinedType = ..., unique_id: str | None | UndefinedType = ..., version: int | UndefinedType = ...) -> bool: ...
+    @callback
     def _async_dispatch(self, change_type: ConfigEntryChange, entry: ConfigEntry) -> None: ...
     async def async_forward_entry_setups(self, entry: ConfigEntry, platforms: Iterable[Platform | str]) -> None: ...
     async def _async_forward_entry_setups_locked(self, entry: ConfigEntry, platforms: Iterable[Platform | str]) -> None: ...
@@ -280,11 +309,15 @@ class ConfigEntries:
     async def _async_forward_entry_setup(self, entry: ConfigEntry, domain: Platform | str, preload_platform: bool) -> bool: ...
     async def async_unload_platforms(self, entry: ConfigEntry, platforms: Iterable[Platform | str]) -> bool: ...
     async def async_forward_entry_unload(self, entry: ConfigEntry, domain: Platform | str) -> bool: ...
+    @callback
     def _async_schedule_save(self) -> None: ...
+    @callback
     def _data_to_save(self) -> dict[str, list[dict[str, Any]]]: ...
     async def async_wait_component(self, entry: ConfigEntry) -> bool: ...
+    @callback
     def async_update_issues(self) -> None: ...
 
+@callback
 def _async_abort_entries_match(other_entries: list[ConfigEntry], match_dict: dict[str, Any] | None = None) -> None: ...
 
 class ConfigEntryBaseFlow(data_entry_flow.FlowHandler[ConfigFlowContext, ConfigFlowResult]):
@@ -295,22 +328,32 @@ class ConfigFlow(ConfigEntryBaseFlow):
     @property
     def unique_id(self) -> str | None: ...
     @staticmethod
+    @callback
     def async_get_options_flow(config_entry: ConfigEntry) -> OptionsFlow: ...
     @classmethod
+    @callback
     def async_supports_options_flow(cls, config_entry: ConfigEntry) -> bool: ...
+    @callback
     def _async_abort_entries_match(self, match_dict: dict[str, Any] | None = None) -> None: ...
+    @callback
     def _abort_if_unique_id_mismatch(self, *, reason: str = 'unique_id_mismatch', description_placeholders: Mapping[str, str] | None = None) -> None: ...
+    @callback
     def _abort_if_unique_id_configured(self, updates: dict[str, Any] | None = None, reload_on_update: bool = True, *, error: str = 'already_configured') -> None: ...
     async def async_set_unique_id(self, unique_id: str | None = None, *, raise_on_progress: bool = True) -> ConfigEntry | None: ...
+    @callback
     def _set_confirm_only(self) -> None: ...
+    @callback
     def _async_current_entries(self, include_ignore: bool | None = None) -> list[ConfigEntry]: ...
+    @callback
     def _async_current_ids(self, include_ignore: bool = True) -> set[str | None]: ...
+    @callback
     def _async_in_progress(self, include_uninitialized: bool = False, match_context: dict[str, Any] | None = None) -> list[ConfigFlowResult]: ...
     async def async_step_ignore(self, user_input: dict[str, Any]) -> ConfigFlowResult: ...
     async def async_step_user(self, user_input: dict[str, Any] | None = None) -> ConfigFlowResult: ...
     async def _async_handle_discovery_without_unique_id(self) -> None: ...
     async def _async_step_discovery_without_unique_id(self) -> ConfigFlowResult: ...
     async def async_step_discovery(self, discovery_info: DiscoveryInfoType) -> ConfigFlowResult: ...
+    @callback
     def async_abort(self, *, reason: str, description_placeholders: Mapping[str, str] | None = None) -> ConfigFlowResult: ...
     async def async_step_bluetooth(self, discovery_info: BluetoothServiceInfoBleak) -> ConfigFlowResult: ...
     async def async_step_dhcp(self, discovery_info: DhcpServiceInfo) -> ConfigFlowResult: ...
@@ -321,15 +364,20 @@ class ConfigFlow(ConfigEntryBaseFlow):
     async def async_step_ssdp(self, discovery_info: SsdpServiceInfo) -> ConfigFlowResult: ...
     async def async_step_usb(self, discovery_info: UsbServiceInfo) -> ConfigFlowResult: ...
     async def async_step_zeroconf(self, discovery_info: ZeroconfServiceInfo) -> ConfigFlowResult: ...
+    @callback
     def async_create_entry(self, *, title: str, data: Mapping[str, Any], description: str | None = None, description_placeholders: Mapping[str, str] | None = None, options: Mapping[str, Any] | None = None) -> ConfigFlowResult: ...
+    @callback
     def async_update_reload_and_abort(self, entry: ConfigEntry, *, unique_id: str | None | UndefinedType = ..., title: str | UndefinedType = ..., data: Mapping[str, Any] | UndefinedType = ..., data_updates: Mapping[str, Any] | UndefinedType = ..., options: Mapping[str, Any] | UndefinedType = ..., reason: str | UndefinedType = ..., reload_even_if_entry_is_unchanged: bool = True) -> ConfigFlowResult: ...
+    @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) -> ConfigFlowResult: ...
     def is_matching(self, other_flow: Self) -> bool: ...
     @property
     def _reauth_entry_id(self) -> str: ...
+    @callback
     def _get_reauth_entry(self) -> ConfigEntry: ...
     @property
     def _reconfigure_entry_id(self) -> str: ...
+    @callback
     def _get_reconfigure_entry(self) -> ConfigEntry: ...
 
 class OptionsFlowManager(data_entry_flow.FlowManager[ConfigFlowContext, ConfigFlowResult]):
@@ -342,6 +390,7 @@ class OptionsFlowManager(data_entry_flow.FlowManager[ConfigFlowContext, ConfigFl
 class OptionsFlow(ConfigEntryBaseFlow):
     handler: str
     _config_entry: ConfigEntry
+    @callback
     def _async_abort_entries_match(self, match_dict: dict[str, Any] | None = None) -> None: ...
     @property
     def _config_entry_id(self) -> str: ...
@@ -363,10 +412,14 @@ class EntityRegistryDisabledHandler:
     changed: set[str]
     _remove_call_later: Callable[[], None] | None
     def __init__(self, hass: HomeAssistant) -> None: ...
+    @callback
     def async_setup(self) -> None: ...
+    @callback
     def _handle_entry_updated(self, event: Event[er.EventEntityRegistryUpdatedData]) -> None: ...
+    @callback
     def _async_handle_reload(self, _now: Any) -> None: ...
 
+@callback
 def _handle_entry_updated_filter(event_data: er.EventEntityRegistryUpdatedData) -> bool: ...
 async def support_entry_unload(hass: HomeAssistant, domain: str) -> bool: ...
 async def support_remove_from_device(hass: HomeAssistant, domain: str) -> bool: ...

homeassistant-stubs/core.pyi

@@ -2,6 +2,7 @@ import asyncio
 import concurrent.futures
 import datetime
 import enum
+import functools
 import threading
 import voluptuous as vol
 from . import util as util
@@ -84,6 +85,7 @@ class _Hass(threading.local):
 
 _hass: Incomplete
 
+@callback
 def async_get_hass() -> HomeAssistant: ...
 def async_get_hass_or_none() -> HomeAssistant | None: ...
 
@@ -93,6 +95,7 @@ class ReleaseChannel(enum.StrEnum):
     NIGHTLY = 'nightly'
     STABLE = 'stable'
 
+@callback
 def get_release_channel() -> ReleaseChannel: ...
 
 class HassJobType(enum.Enum):
@@ -167,41 +170,60 @@ class HomeAssistant:
     async def async_start(self) -> None: ...
     def add_job[*_Ts](self, target: Callable[[*_Ts], Any] | Coroutine[Any, Any, Any], *args: *_Ts) -> None: ...
     @overload
+    @callback
     def async_add_job[_R, *_Ts](self, target: Callable[[*_Ts], Coroutine[Any, Any, _R]], *args: *_Ts, eager_start: bool = False) -> asyncio.Future[_R] | None: ...
     @overload
+    @callback
     def async_add_job[_R, *_Ts](self, target: Callable[[*_Ts], Coroutine[Any, Any, _R] | _R], *args: *_Ts, eager_start: bool = False) -> asyncio.Future[_R] | None: ...
     @overload
+    @callback
     def async_add_job[_R](self, target: Coroutine[Any, Any, _R], *args: Any, eager_start: bool = False) -> asyncio.Future[_R] | None: ...
     @overload
+    @callback
     def async_add_hass_job[_R](self, hassjob: HassJob[..., Coroutine[Any, Any, _R]], *args: Any, eager_start: bool = False, background: bool = False) -> asyncio.Future[_R] | None: ...
     @overload
+    @callback
     def async_add_hass_job[_R](self, hassjob: HassJob[..., Coroutine[Any, Any, _R] | _R], *args: Any, eager_start: bool = False, background: bool = False) -> asyncio.Future[_R] | None: ...
     @overload
+    @callback
     def _async_add_hass_job[_R](self, hassjob: HassJob[..., Coroutine[Any, Any, _R]], *args: Any, background: bool = False) -> asyncio.Future[_R] | None: ...
     @overload
+    @callback
     def _async_add_hass_job[_R](self, hassjob: HassJob[..., Coroutine[Any, Any, _R] | _R], *args: Any, background: bool = False) -> asyncio.Future[_R] | None: ...
     def create_task(self, target: Coroutine[Any, Any, Any], name: str | None = None) -> None: ...
+    @callback
     def async_create_task[_R](self, target: Coroutine[Any, Any, _R], name: str | None = None, eager_start: bool = True) -> asyncio.Task[_R]: ...
+    @callback
     def async_create_task_internal[_R](self, target: Coroutine[Any, Any, _R], name: str | None = None, eager_start: bool = True) -> asyncio.Task[_R]: ...
+    @callback
     def async_create_background_task[_R](self, target: Coroutine[Any, Any, _R], name: str, eager_start: bool = True) -> asyncio.Task[_R]: ...
+    @callback
     def async_add_executor_job[*_Ts, _T](self, target: Callable[[*_Ts], _T], *args: *_Ts) -> asyncio.Future[_T]: ...
+    @callback
     def async_add_import_executor_job[*_Ts, _T](self, target: Callable[[*_Ts], _T], *args: *_Ts) -> asyncio.Future[_T]: ...
     @overload
+    @callback
     def async_run_hass_job[_R](self, hassjob: HassJob[..., Coroutine[Any, Any, _R]], *args: Any, background: bool = False) -> asyncio.Future[_R] | None: ...
     @overload
+    @callback
     def async_run_hass_job[_R](self, hassjob: HassJob[..., Coroutine[Any, Any, _R] | _R], *args: Any, background: bool = False) -> asyncio.Future[_R] | None: ...
     @overload
+    @callback
     def async_run_job[_R, *_Ts](self, target: Callable[[*_Ts], Coroutine[Any, Any, _R]], *args: *_Ts) -> asyncio.Future[_R] | None: ...
     @overload
+    @callback
     def async_run_job[_R, *_Ts](self, target: Callable[[*_Ts], Coroutine[Any, Any, _R] | _R], *args: *_Ts) -> asyncio.Future[_R] | None: ...
     @overload
+    @callback
     def async_run_job[_R](self, target: Coroutine[Any, Any, _R], *args: Any) -> asyncio.Future[_R] | None: ...
     def block_till_done(self, wait_background_tasks: bool = False) -> None: ...
     async def async_block_till_done(self, wait_background_tasks: bool = False) -> None: ...
     async def _await_and_log_pending(self, pending: Collection[asyncio.Future[Any]]) -> None: ...
     @overload
+    @callback
     def async_add_shutdown_job(self, hassjob: HassJob[..., Coroutine[Any, Any, Any]], *args: Any) -> CALLBACK_TYPE: ...
     @overload
+    @callback
     def async_add_shutdown_job(self, hassjob: HassJob[..., Coroutine[Any, Any, Any] | Any], *args: Any) -> CALLBACK_TYPE: ...
     def stop(self) -> None: ...
     async def async_stop(self, exit_code: int = 0, *, force: bool = False) -> None: ...
@@ -263,11 +285,13 @@ class _OneTimeListener(Generic[_DataT]):
     hass: HomeAssistant
     listener_job: HassJob[[Event[_DataT]], Coroutine[Any, Any, None] | None]
     remove: CALLBACK_TYPE | None = ...
+    @callback
     def __call__(self, event: Event[_DataT]) -> None: ...
     def __repr__(self) -> str: ...
 
 EMPTY_LIST: list[Any]
 
+@functools.lru_cache
 def _verify_event_type_length_or_raise(event_type: EventType[_DataT] | str) -> None: ...
 
 class EventBus:
@@ -277,18 +301,26 @@ class EventBus:
     _hass: Incomplete
     def __init__(self, hass: HomeAssistant) -> None: ...
     _debug: Incomplete
+    @callback
     def _async_logging_changed(self, event: Event | None = None) -> None: ...
+    @callback
     def async_listeners(self) -> dict[EventType[Any] | str, int]: ...
     @property
     def listeners(self) -> dict[EventType[Any] | str, int]: ...
     def fire(self, event_type: EventType[_DataT] | str, event_data: _DataT | None = None, origin: EventOrigin = ..., context: Context | None = None) -> None: ...
+    @callback
     def async_fire(self, event_type: EventType[_DataT] | str, event_data: _DataT | None = None, origin: EventOrigin = ..., context: Context | None = None, time_fired: float | None = None) -> None: ...
+    @callback
     def async_fire_internal(self, event_type: EventType[_DataT] | str, event_data: _DataT | None = None, origin: EventOrigin = ..., context: Context | None = None, time_fired: float | None = None) -> None: ...
     def listen(self, event_type: EventType[_DataT] | str, listener: Callable[[Event[_DataT]], Coroutine[Any, Any, None] | None]) -> CALLBACK_TYPE: ...
+    @callback
     def async_listen(self, event_type: EventType[_DataT] | str, listener: Callable[[Event[_DataT]], Coroutine[Any, Any, None] | None], event_filter: Callable[[_DataT], bool] | None = None, run_immediately: bool | object = ...) -> CALLBACK_TYPE: ...
+    @callback
     def _async_listen_filterable_job(self, event_type: EventType[_DataT] | str, filterable_job: _FilterableJobType[_DataT]) -> CALLBACK_TYPE: ...
     def listen_once(self, event_type: EventType[_DataT] | str, listener: Callable[[Event[_DataT]], Coroutine[Any, Any, None] | None]) -> CALLBACK_TYPE: ...
+    @callback
     def async_listen_once(self, event_type: EventType[_DataT] | str, listener: Callable[[Event[_DataT]], Coroutine[Any, Any, None] | None], run_immediately: bool | object = ...) -> CALLBACK_TYPE: ...
+    @callback
     def _async_remove_listener(self, event_type: EventType[_DataT] | str, filterable_job: _FilterableJobType[_DataT]) -> None: ...
 
 class CompressedState(TypedDict):
@@ -353,18 +385,26 @@ class StateMachine:
     _loop: Incomplete
     def __init__(self, bus: EventBus, loop: asyncio.events.AbstractEventLoop) -> None: ...
     def entity_ids(self, domain_filter: str | None = None) -> list[str]: ...
+    @callback
     def async_entity_ids(self, domain_filter: str | Iterable[str] | None = None) -> list[str]: ...
+    @callback
     def async_entity_ids_count(self, domain_filter: str | Iterable[str] | None = None) -> int: ...
     def all(self, domain_filter: str | Iterable[str] | None = None) -> list[State]: ...
+    @callback
     def async_all(self, domain_filter: str | Iterable[str] | None = None) -> list[State]: ...
     def get(self, entity_id: str) -> State | None: ...
     def is_state(self, entity_id: str, state: str) -> bool: ...
     def remove(self, entity_id: str) -> bool: ...
+    @callback
     def async_remove(self, entity_id: str, context: Context | None = None) -> bool: ...
     def set(self, entity_id: str, new_state: str, attributes: Mapping[str, Any] | None = None, force_update: bool = False, context: Context | None = None) -> None: ...
+    @callback
     def async_reserve(self, entity_id: str) -> None: ...
+    @callback
     def async_available(self, entity_id: str) -> bool: ...
+    @callback
     def async_set(self, entity_id: str, new_state: str, attributes: Mapping[str, Any] | None = None, force_update: bool = False, context: Context | None = None, state_info: StateInfo | None = None, timestamp: float | None = None) -> None: ...
+    @callback
     def async_set_internal(self, entity_id: str, new_state: str, attributes: Mapping[str, Any] | None, force_update: bool, context: Context | None, state_info: StateInfo | None, timestamp: float) -> None: ...
 
 class SupportsResponse(enum.StrEnum):
@@ -397,16 +437,23 @@ class ServiceRegistry:
     def __init__(self, hass: HomeAssistant) -> None: ...
     @property
     def services(self) -> dict[str, dict[str, Service]]: ...
+    @callback
     def async_services(self) -> dict[str, dict[str, Service]]: ...
+    @callback
     def async_services_for_domain(self, domain: str) -> dict[str, Service]: ...
+    @callback
     def async_services_internal(self) -> dict[str, dict[str, Service]]: ...
     def has_service(self, domain: str, service: str) -> bool: ...
     def supports_response(self, domain: str, service: str) -> SupportsResponse: ...
     def register(self, domain: str, service: str, service_func: Callable[[ServiceCall], Coroutine[Any, Any, ServiceResponse] | ServiceResponse | None], schema: vol.Schema | None = None, supports_response: SupportsResponse = ...) -> None: ...
+    @callback
     def async_register(self, domain: str, service: str, service_func: Callable[[ServiceCall], Coroutine[Any, Any, ServiceResponse | EntityServiceResponse] | ServiceResponse | EntityServiceResponse | None], schema: VolSchemaType | None = None, supports_response: SupportsResponse = ..., job_type: HassJobType | None = None) -> None: ...
+    @callback
     def _async_register(self, domain: str, service: str, service_func: Callable[[ServiceCall], Coroutine[Any, Any, ServiceResponse | EntityServiceResponse] | ServiceResponse | EntityServiceResponse | None], schema: VolSchemaType | None = None, supports_response: SupportsResponse = ..., job_type: HassJobType | None = None) -> None: ...
     def remove(self, domain: str, service: str) -> None: ...
+    @callback
     def async_remove(self, domain: str, service: str) -> None: ...
+    @callback
     def _async_remove(self, domain: str, service: str) -> None: ...
     def call(self, domain: str, service: str, service_data: dict[str, Any] | None = None, blocking: bool = False, context: Context | None = None, target: dict[str, Any] | None = None, return_response: bool = False) -> ServiceResponse: ...
     async def async_call(self, domain: str, service: str, service_data: dict[str, Any] | None = None, blocking: bool = False, context: Context | None = None, target: dict[str, Any] | None = None, return_response: bool = False) -> ServiceResponse: ...

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/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

@@ -68,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

@@ -51,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

@@ -63,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: ...
 
@@ -89,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
@@ -102,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: ...
 
@@ -112,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):
@@ -129,13 +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: ...
 
+@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]:
@@ -149,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: ...