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

homeassistant-stubs/helpers/script.pyi

@@ -12,6 +12,7 @@ from .trigger import async_initialize_triggers as async_initialize_triggers, asy
 from .typing import ConfigType as ConfigType, TemplateVarsType as TemplateVarsType, UNDEFINED as UNDEFINED, UndefinedType as UndefinedType
 from _typeshed import Incomplete
 from collections.abc import AsyncGenerator, Callable as Callable, Mapping, Sequence
+from contextlib import asynccontextmanager
 from contextvars import ContextVar
 from dataclasses import dataclass
 from datetime import datetime, timedelta
@@ -65,6 +66,7 @@ class ScriptStoppedError(Exception): ...
 
 def _set_result_unless_done(future: asyncio.Future[None]) -> None: ...
 def action_trace_append(variables: dict[str, Any], path: str) -> TraceElement: ...
+@asynccontextmanager
 async def trace_action(hass: HomeAssistant, script_run: _ScriptRun, stop: asyncio.Future[None], variables: dict[str, Any]) -> AsyncGenerator[TraceElement]: ...
 def make_script_schema(schema: Mapping[Any, Any], default_script_mode: str, extra: int = ...) -> vol.Schema: ...
 
@@ -140,6 +142,7 @@ class _QueuedScriptRun(_ScriptRun):
     async def async_run(self) -> None: ...
     def _finish(self) -> None: ...
 
+@callback
 def _schedule_stop_scripts_after_shutdown(hass: HomeAssistant) -> None: ...
 async def _async_stop_scripts_after_shutdown(hass: HomeAssistant, point_in_time: datetime) -> None: ...
 async def _async_stop_scripts_at_shutdown(hass: HomeAssistant, event: Event) -> None: ...
@@ -197,6 +200,7 @@ class Script:
     def _set_logger(self, logger: logging.Logger | None = None) -> None: ...
     def update_logger(self, logger: logging.Logger | None = None) -> None: ...
     def _changed(self) -> None: ...
+    @callback
     def _chain_change_listener(self, sub_script: Script) -> None: ...
     @property
     def is_running(self) -> bool: ...
@@ -237,10 +241,17 @@ class Script:
     async def _async_get_sequence_script(self, step: int) -> Script: ...
     def _log(self, msg: str, *args: Any, level: int = ..., **kwargs: Any) -> None: ...
 
+@callback
 def breakpoint_clear(hass: HomeAssistant, key: str, run_id: str | None, node: str) -> None: ...
+@callback
 def breakpoint_clear_all(hass: HomeAssistant) -> None: ...
+@callback
 def breakpoint_set(hass: HomeAssistant, key: str, run_id: str | None, node: str) -> None: ...
+@callback
 def breakpoint_list(hass: HomeAssistant) -> list[dict[str, Any]]: ...
+@callback
 def debug_continue(hass: HomeAssistant, key: str, run_id: str) -> None: ...
+@callback
 def debug_step(hass: HomeAssistant, key: str, run_id: str) -> None: ...
+@callback
 def debug_stop(hass: HomeAssistant, key: str, run_id: str) -> None: ...

homeassistant-stubs/helpers/script_variables.pyi

@@ -8,5 +8,6 @@ class ScriptVariables:
     variables: Incomplete
     _has_template: bool | None
     def __init__(self, variables: dict[str, Any]) -> None: ...
+    @callback
     def async_render(self, hass: HomeAssistant, run_variables: Mapping[str, Any] | None, *, render_as_defaults: bool = True, limited: bool = False) -> dict[str, Any]: ...
     def as_dict(self) -> dict[str, Any]: ...

homeassistant-stubs/helpers/selector.pyi

@@ -1,6 +1,7 @@
 from _typeshed import Incomplete
 from collections.abc import Callable as Callable, Mapping, Sequence
 from enum import StrEnum
+from functools import cache
 from homeassistant.const import CONF_MODE as CONF_MODE, CONF_UNIT_OF_MEASUREMENT as CONF_UNIT_OF_MEASUREMENT
 from homeassistant.core import split_entity_id as split_entity_id, valid_entity_id as valid_entity_id
 from homeassistant.generated.countries import COUNTRIES as COUNTRIES
@@ -22,6 +23,7 @@ class Selector[_T: Mapping[str, Any]]:
     def __eq__(self, other: object) -> bool: ...
     def serialize(self) -> dict[str, dict[str, _T]]: ...
 
+@cache
 def _entity_feature_flag(domain: str, enum_name: str, feature_name: str) -> int: ...
 def _validate_supported_feature(supported_feature: str) -> int: ...
 def _validate_supported_features(supported_features: int | list[str]) -> int: ...

homeassistant-stubs/helpers/service.pyi

@@ -6,6 +6,7 @@ from .selector import TargetSelector as TargetSelector
 from .typing import ConfigType as ConfigType, TemplateVarsType as TemplateVarsType, VolDictType as VolDictType, VolSchemaType as VolSchemaType
 from _typeshed import Incomplete
 from collections.abc import Awaitable, Callable as Callable, Coroutine, Iterable
+from functools import cache
 from homeassistant.auth.permissions.const import CAT_ENTITIES as CAT_ENTITIES, POLICY_CONTROL as POLICY_CONTROL
 from homeassistant.const import ATTR_AREA_ID as ATTR_AREA_ID, ATTR_DEVICE_ID as ATTR_DEVICE_ID, ATTR_ENTITY_ID as ATTR_ENTITY_ID, ATTR_FLOOR_ID as ATTR_FLOOR_ID, ATTR_LABEL_ID as ATTR_LABEL_ID, CONF_ACTION as CONF_ACTION, CONF_ENTITY_ID as CONF_ENTITY_ID, CONF_SERVICE_DATA as CONF_SERVICE_DATA, CONF_SERVICE_DATA_TEMPLATE as CONF_SERVICE_DATA_TEMPLATE, CONF_SERVICE_TEMPLATE as CONF_SERVICE_TEMPLATE, CONF_TARGET as CONF_TARGET, ENTITY_MATCH_ALL as ENTITY_MATCH_ALL, ENTITY_MATCH_NONE as ENTITY_MATCH_NONE
 from homeassistant.core import Context as Context, EntityServiceResponse as EntityServiceResponse, HassJob as HassJob, HassJobType as HassJobType, HomeAssistant as HomeAssistant, ServiceCall as ServiceCall, ServiceResponse as ServiceResponse, SupportsResponse as SupportsResponse, callback as callback
@@ -23,6 +24,7 @@ _LOGGER: Incomplete
 SERVICE_DESCRIPTION_CACHE: HassKey[dict[tuple[str, str], dict[str, Any] | None]]
 ALL_SERVICE_DESCRIPTIONS_CACHE: HassKey[tuple[set[tuple[str, str]], dict[str, dict[str, Any]]]]
 
+@cache
 def _base_components() -> dict[str, ModuleType]: ...
 def _validate_option_or_feature(option_or_feature: str, label: str) -> Any: ...
 def validate_attribute_option(attribute_option: str) -> Any: ...
@@ -65,26 +67,45 @@ class SelectedEntities:
     referenced_areas: set[str] = dataclasses.field(default_factory=set)
     def log_missing(self, missing_entities: set[str]) -> None: ...
 
+@bind_hass
 def call_from_config(hass: HomeAssistant, config: ConfigType, blocking: bool = False, variables: TemplateVarsType = None, validate_config: bool = True) -> None: ...
+@bind_hass
 async def async_call_from_config(hass: HomeAssistant, config: ConfigType, blocking: bool = False, variables: TemplateVarsType = None, validate_config: bool = True, context: Context | None = None) -> None: ...
+@callback
+@bind_hass
 def async_prepare_call_from_config(hass: HomeAssistant, config: ConfigType, variables: TemplateVarsType = None, validate_config: bool = False) -> ServiceParams: ...
+@bind_hass
 def extract_entity_ids(hass: HomeAssistant, service_call: ServiceCall, expand_group: bool = True) -> set[str]: ...
+@bind_hass
 async def async_extract_entities[_EntityT: Entity](hass: HomeAssistant, entities: Iterable[_EntityT], service_call: ServiceCall, expand_group: bool = True) -> list[_EntityT]: ...
+@bind_hass
 async def async_extract_entity_ids(hass: HomeAssistant, service_call: ServiceCall, expand_group: bool = True) -> set[str]: ...
 def _has_match(ids: str | list[str] | None) -> TypeGuard[str | list[str]]: ...
+@bind_hass
 def async_extract_referenced_entity_ids(hass: HomeAssistant, service_call: ServiceCall, expand_group: bool = True) -> SelectedEntities: ...
+@bind_hass
 async def async_extract_config_entry_ids(hass: HomeAssistant, service_call: ServiceCall, expand_group: bool = True) -> set[str]: ...
 def _load_services_file(hass: HomeAssistant, integration: Integration) -> JSON_TYPE: ...
 def _load_services_files(hass: HomeAssistant, integrations: Iterable[Integration]) -> list[JSON_TYPE]: ...
+@callback
 def async_get_cached_service_description(hass: HomeAssistant, domain: str, service: str) -> dict[str, Any] | None: ...
+@bind_hass
 async def async_get_all_descriptions(hass: HomeAssistant) -> dict[str, dict[str, Any]]: ...
+@callback
 def remove_entity_service_fields(call: ServiceCall) -> dict[Any, Any]: ...
+@callback
+@bind_hass
 def async_set_service_schema(hass: HomeAssistant, domain: str, service: str, schema: dict[str, Any]) -> None: ...
 def _get_permissible_entity_candidates(call: ServiceCall, entities: dict[str, Entity], entity_perms: Callable[[str, str], bool] | None, target_all_entities: bool, all_referenced: set[str] | None) -> list[Entity]: ...
+@bind_hass
 async def entity_service_call(hass: HomeAssistant, registered_entities: dict[str, Entity], func: str | HassJob, call: ServiceCall, required_features: Iterable[int] | None = None) -> EntityServiceResponse | None: ...
 async def _handle_entity_call(hass: HomeAssistant, entity: Entity, func: str | HassJob, data: dict | ServiceCall, context: Context) -> ServiceResponse: ...
 async def _async_admin_handler(hass: HomeAssistant, service_job: HassJob[[ServiceCall], Awaitable[None] | None], call: ServiceCall) -> None: ...
+@bind_hass
+@callback
 def async_register_admin_service(hass: HomeAssistant, domain: str, service: str, service_func: Callable[[ServiceCall], Awaitable[None] | None], schema: VolSchemaType = ...) -> None: ...
+@bind_hass
+@callback
 def verify_domain_control(hass: HomeAssistant, domain: str) -> Callable[[Callable[[ServiceCall], Any]], Callable[[ServiceCall], Any]]: ...
 
 class ReloadServiceHelper[_T]:
@@ -96,4 +117,5 @@ class ReloadServiceHelper[_T]:
     def __init__(self, service_func: Callable[[ServiceCall], Coroutine[Any, Any, Any]], reload_targets_func: Callable[[ServiceCall], set[_T]]) -> None: ...
     async def execute_service(self, service_call: ServiceCall) -> None: ...
 
+@callback
 def async_register_entity_service(hass: HomeAssistant, domain: str, name: str, *, entities: dict[str, Entity], func: str | Callable[..., Any], job_type: HassJobType | None, required_features: Iterable[int] | None = None, schema: VolDictType | VolSchemaType | None, supports_response: SupportsResponse = ...) -> None: ...

homeassistant-stubs/helpers/signal.pyi

@@ -8,4 +8,6 @@ from homeassistant.util.hass_dict import HassKey as HassKey
 _LOGGER: Incomplete
 KEY_HA_STOP: HassKey[asyncio.Task[None]]
 
+@callback
+@bind_hass
 def async_register_signal_handling(hass: HomeAssistant) -> None: ...

homeassistant-stubs/helpers/significant_change.pyi

@@ -28,4 +28,5 @@ class SignificantlyChangedChecker:
     last_approved_entities: dict[str, tuple[State, Any]]
     extra_significant_check: Incomplete
     def __init__(self, hass: HomeAssistant, extra_significant_check: ExtraCheckTypeFunc | None = None) -> None: ...
+    @callback
     def async_is_significant_change(self, new_state: State, *, extra_arg: Any | None = None) -> bool: ...

homeassistant-stubs/helpers/start.pyi

@@ -5,6 +5,9 @@ from homeassistant.core import CALLBACK_TYPE as CALLBACK_TYPE, CoreState as Core
 from homeassistant.util.event_type import EventType as EventType
 from typing import Any
 
+@callback
 def _async_at_core_state(hass: HomeAssistant, at_start_cb: Callable[[HomeAssistant], Coroutine[Any, Any, None] | None], event_type: EventType[NoEventData], check_state: Callable[[HomeAssistant], bool]) -> CALLBACK_TYPE: ...
+@callback
 def async_at_start(hass: HomeAssistant, at_start_cb: Callable[[HomeAssistant], Coroutine[Any, Any, None] | None]) -> CALLBACK_TYPE: ...
+@callback
 def async_at_started(hass: HomeAssistant, at_start_cb: Callable[[HomeAssistant], Coroutine[Any, Any, None] | None]) -> CALLBACK_TYPE: ...

homeassistant-stubs/helpers/state.pyi

@@ -9,5 +9,6 @@ from typing import Any
 
 _LOGGER: Incomplete
 
+@bind_hass
 async def async_reproduce_state(hass: HomeAssistant, states: State | Iterable[State], *, context: Context | None = None, reproduce_options: dict[str, Any] | None = None) -> None: ...
 def state_as_number(state: State) -> float: ...

homeassistant-stubs/helpers/storage.pyi

@@ -20,6 +20,7 @@ STORAGE_SEMAPHORE: HassKey[asyncio.Semaphore]
 STORAGE_MANAGER: HassKey[_StoreManager]
 MANAGER_CLEANUP_DELAY: int
 
+@bind_hass
 async def async_migrator[_T: Mapping[str, Any] | Sequence[Any]](hass: HomeAssistant, old_path: str, store: Store[_T], *, old_conf_load_func: Callable | None = None, old_conf_migrate_func: Callable | None = None) -> _T | None: ...
 def get_internal_store_manager(hass: HomeAssistant) -> _StoreManager: ...
 
@@ -32,10 +33,15 @@ class _StoreManager:
     _cancel_cleanup: asyncio.TimerHandle | None
     def __init__(self, hass: HomeAssistant) -> None: ...
     async def async_initialize(self) -> None: ...
+    @callback
     def async_invalidate(self, key: str) -> None: ...
+    @callback
     def async_fetch(self, key: str) -> tuple[bool, json_util.JsonValueType | None] | None: ...
+    @callback
     def _async_schedule_cleanup(self, _event: Event) -> None: ...
+    @callback
     def _async_cancel_and_cleanup(self, _event: Event) -> None: ...
+    @callback
     def _async_cleanup(self) -> None: ...
     async def async_preload(self, keys: Iterable[str]) -> None: ...
     def _preload(self, keys: Iterable[str]) -> None: ...
@@ -65,11 +71,17 @@ class Store[_T: Mapping[str, Any] | Sequence[Any]]:
     async def _async_load(self) -> _T | None: ...
     async def _async_load_data(self): ...
     async def async_save(self, data: _T) -> None: ...
+    @callback
     def async_delay_save(self, data_func: Callable[[], _T], delay: float = 0) -> None: ...
+    @callback
     def _async_reschedule_delayed_write(self, when: float) -> None: ...
+    @callback
     def _async_schedule_callback_delayed_write(self) -> None: ...
+    @callback
     def _async_ensure_final_write_listener(self) -> None: ...
+    @callback
     def _async_cleanup_final_write_listener(self) -> None: ...
+    @callback
     def _async_cleanup_delay_listener(self) -> None: ...
     async def _async_callback_delayed_write(self) -> None: ...
     async def _async_callback_final_write(self, _event: Event) -> None: ...

homeassistant-stubs/helpers/sun.pyi

@@ -12,8 +12,17 @@ DATA_LOCATION_CACHE: HassKey[dict[tuple[str, str, str, float, float], astral.loc
 ELEVATION_AGNOSTIC_EVENTS: Incomplete
 type _AstralSunEventCallable = Callable[..., datetime.datetime]
 
+@callback
+@bind_hass
 def get_astral_location(hass: HomeAssistant) -> tuple[astral.location.Location, astral.Elevation]: ...
+@callback
+@bind_hass
 def get_astral_event_next(hass: HomeAssistant, event: str, utc_point_in_time: datetime.datetime | None = None, offset: datetime.timedelta | None = None) -> datetime.datetime: ...
+@callback
 def get_location_astral_event_next(location: astral.location.Location, elevation: astral.Elevation, event: str, utc_point_in_time: datetime.datetime | None = None, offset: datetime.timedelta | None = None) -> datetime.datetime: ...
+@callback
+@bind_hass
 def get_astral_event_date(hass: HomeAssistant, event: str, date: datetime.date | datetime.datetime | None = None) -> datetime.datetime | None: ...
+@callback
+@bind_hass
 def is_up(hass: HomeAssistant, utc_point_in_time: datetime.datetime | None = None) -> bool: ...

homeassistant-stubs/helpers/system_info.pyi

@@ -15,4 +15,5 @@ async def async_get_mac_ver(hass: HomeAssistant) -> str: ...
 
 cached_get_user: Incomplete
 
+@bind_hass
 async def async_get_system_info(hass: HomeAssistant) -> dict[str, Any]: ...

homeassistant-stubs/helpers/template.pyi

@@ -11,6 +11,7 @@ from collections.abc import Callable as Callable, Generator, Iterable
 from contextlib import AbstractContextManager
 from contextvars import ContextVar
 from datetime import datetime, timedelta
+from functools import cache
 from homeassistant.const import ATTR_ENTITY_ID as ATTR_ENTITY_ID, ATTR_LATITUDE as ATTR_LATITUDE, ATTR_LONGITUDE as ATTR_LONGITUDE, ATTR_PERSONS as ATTR_PERSONS, ATTR_UNIT_OF_MEASUREMENT as ATTR_UNIT_OF_MEASUREMENT, EVENT_HOMEASSISTANT_START as EVENT_HOMEASSISTANT_START, EVENT_HOMEASSISTANT_STOP as EVENT_HOMEASSISTANT_STOP, STATE_UNAVAILABLE as STATE_UNAVAILABLE, STATE_UNKNOWN as STATE_UNKNOWN, UnitOfLength as UnitOfLength
 from homeassistant.core import Context as Context, HomeAssistant as HomeAssistant, ServiceResponse as ServiceResponse, State as State, callback as callback, split_entity_id as split_entity_id, valid_domain as valid_domain, valid_entity_id as valid_entity_id
 from homeassistant.exceptions import TemplateError as TemplateError
@@ -21,6 +22,7 @@ from homeassistant.util.hass_dict import HassKey as HassKey
 from homeassistant.util.json import JSON_DECODE_EXCEPTIONS as JSON_DECODE_EXCEPTIONS, json_loads as json_loads
 from homeassistant.util.read_only_dict import ReadOnlyDict as ReadOnlyDict
 from homeassistant.util.thread import ThreadWithException as ThreadWithException
+from jinja2 import pass_context
 from jinja2.sandbox import ImmutableSandboxedEnvironment
 from lru import LRU
 from propcache import under_cached_property
@@ -53,6 +55,7 @@ ORJSON_PASSTHROUGH_OPTIONS: Incomplete
 def _template_state_no_collect(hass: HomeAssistant, state: State) -> TemplateState: ...
 def _template_state(hass: HomeAssistant, state: State) -> TemplateState: ...
 def async_setup(hass: HomeAssistant) -> bool: ...
+@bind_hass
 def attach(hass: HomeAssistant, obj: Any) -> None: ...
 def _attach(hass: HomeAssistant, obj: Any) -> None: ...
 def render_complex(value: Any, variables: TemplateVarsType = None, limited: bool = False, parse_result: bool = True) -> Any: ...
@@ -121,17 +124,21 @@ class Template:
     def _env(self) -> TemplateEnvironment: ...
     def ensure_valid(self) -> None: ...
     def render(self, variables: TemplateVarsType = None, parse_result: bool = True, limited: bool = False, **kwargs: Any) -> Any: ...
+    @callback
     def async_render(self, variables: TemplateVarsType = None, parse_result: bool = True, limited: bool = False, strict: bool = False, log_fn: Callable[[int, str], None] | None = None, **kwargs: Any) -> Any: ...
     def _parse_result(self, render_result: str) -> Any: ...
     async def async_render_will_timeout(self, timeout: float, variables: TemplateVarsType = None, strict: bool = False, log_fn: Callable[[int, str], None] | None = None, **kwargs: Any) -> bool: ...
+    @callback
     def async_render_to_info(self, variables: TemplateVarsType = None, strict: bool = False, log_fn: Callable[[int, str], None] | None = None, **kwargs: Any) -> RenderInfo: ...
     def render_with_possible_json_value(self, value, error_value=...): ...
+    @callback
     def async_render_with_possible_json_value(self, value: Any, error_value: Any = ..., variables: dict[str, Any] | None = None, parse_result: bool = False) -> Any: ...
     def _ensure_compiled(self, limited: bool = False, strict: bool = False, log_fn: Callable[[int, str], None] | None = None) -> jinja2.Template: ...
     def __eq__(self, other): ...
     def __hash__(self) -> int: ...
     def __repr__(self) -> str: ...
 
+@cache
 def _domain_states(hass: HomeAssistant, name: str) -> DomainStates: ...
 def _readonly(*args: Any, **kwargs: Any) -> Any: ...
 
@@ -329,6 +336,7 @@ def ordinal(value): ...
 def from_json(value): ...
 def _to_json_default(obj: Any) -> None: ...
 def to_json(value: Any, ensure_ascii: bool = False, pretty_print: bool = False, sort_keys: bool = False) -> str: ...
+@pass_context
 def random_every_time(context, values): ...
 def today_at(hass: HomeAssistant, time_str: str = '') -> datetime: ...
 def relative_time(hass: HomeAssistant, value: Any) -> Any: ...

homeassistant-stubs/helpers/trace.pyi

@@ -2,6 +2,7 @@ from .typing import TemplateVarsType as TemplateVarsType
 from _typeshed import Incomplete
 from collections import deque
 from collections.abc import Callable as Callable, Coroutine, Generator
+from contextlib import contextmanager
 from contextvars import ContextVar
 from homeassistant.core import ServiceResponse as ServiceResponse
 from typing import Any
@@ -54,5 +55,6 @@ class StopReason:
 
 def script_execution_set(reason: str, response: ServiceResponse = None) -> None: ...
 def script_execution_get() -> str | None: ...
+@contextmanager
 def trace_path(suffix: str | list[str]) -> Generator[None]: ...
 def async_trace_path[*_Ts](suffix: str | list[str]) -> Callable[[Callable[[*_Ts], Coroutine[Any, Any, None]]], Callable[[*_Ts], Coroutine[Any, Any, None]]]: ...

homeassistant-stubs/helpers/translation.pyi

@@ -29,19 +29,27 @@ class _TranslationCache:
     cache_data: Incomplete
     lock: Incomplete
     def __init__(self, hass: HomeAssistant) -> None: ...
+    @callback
     def async_is_loaded(self, language: str, components: set[str]) -> bool: ...
     async def async_load(self, language: str, components: set[str]) -> None: ...
     async def async_fetch(self, language: str, category: str, components: set[str]) -> dict[str, str]: ...
     def get_cached(self, language: str, category: str, components: set[str]) -> dict[str, str]: ...
     async def _async_load(self, language: str, components: set[str]) -> None: ...
     def _validate_placeholders(self, language: str, updated_resources: dict[str, str], cached_resources: dict[str, str] | None = None) -> dict[str, str]: ...
+    @callback
     def _build_category_cache(self, language: str, components: set[str], translation_strings: dict[str, dict[str, Any]]) -> None: ...
 
+@bind_hass
 async def async_get_translations(hass: HomeAssistant, language: str, category: str, integrations: Iterable[str] | None = None, config_flow: bool | None = None) -> dict[str, str]: ...
+@callback
 def async_get_cached_translations(hass: HomeAssistant, language: str, category: str, integration: str | None = None) -> dict[str, str]: ...
 def _async_get_translations_cache(hass: HomeAssistant) -> _TranslationCache: ...
+@callback
 def async_setup(hass: HomeAssistant) -> None: ...
 async def async_load_integrations(hass: HomeAssistant, integrations: set[str]) -> None: ...
+@callback
 def async_translations_loaded(hass: HomeAssistant, components: set[str]) -> bool: ...
+@callback
 def async_get_exception_message(translation_domain: str, translation_key: str, translation_placeholders: dict[str, str] | None = None) -> str: ...
+@callback
 def async_translate_state(hass: HomeAssistant, state: str, domain: str, platform: str | None, translation_key: str | None, device_class: str | None) -> str: ...

homeassistant-stubs/helpers/trigger.pyi

@@ -46,11 +46,15 @@ class PluggableAction:
     _update: Incomplete
     def __init__(self, update: CALLBACK_TYPE | None = None) -> None: ...
     def __bool__(self) -> bool: ...
+    @callback
     def async_run_update(self) -> None: ...
     @staticmethod
+    @callback
     def async_get_registry(hass: HomeAssistant) -> dict[tuple, PluggableActionsEntry]: ...
     @staticmethod
+    @callback
     def async_attach_trigger(hass: HomeAssistant, trigger: dict[str, str], action: TriggerActionType, variables: dict[str, Any]) -> CALLBACK_TYPE: ...
+    @callback
     def async_register(self, hass: HomeAssistant, trigger: dict[str, str]) -> CALLBACK_TYPE: ...
     async def async_run(self, hass: HomeAssistant, context: Context | None = None) -> None: ...
 

homeassistant-stubs/helpers/trigger_template_entity.pyi

@@ -52,6 +52,7 @@ class TriggerBaseEntity(Entity):
 
 class ManualTriggerEntity(TriggerBaseEntity):
     def __init__(self, hass: HomeAssistant, config: ConfigType) -> None: ...
+    @callback
     def _process_manual_data(self, value: Any | None = None) -> None: ...
 
 class ManualTriggerSensorEntity(ManualTriggerEntity, SensorEntity):

homeassistant-stubs/helpers/update_coordinator.pyi

@@ -26,6 +26,7 @@ _DataUpdateCoordinatorT = TypeVar('_DataUpdateCoordinatorT', bound='DataUpdateCo
 class UpdateFailed(HomeAssistantError): ...
 
 class BaseDataUpdateCoordinatorProtocol(Protocol):
+    @callback
     def async_add_listener(self, update_callback: CALLBACK_TYPE, context: Any = None) -> Callable[[], None]: ...
 
 class DataUpdateCoordinator(BaseDataUpdateCoordinatorProtocol, Generic[_DataT]):
@@ -49,9 +50,12 @@ class DataUpdateCoordinator(BaseDataUpdateCoordinatorProtocol, Generic[_DataT]):
     _debounced_refresh: Incomplete
     def __init__(self, hass: HomeAssistant, logger: logging.Logger, *, config_entry: config_entries.ConfigEntry | None | UndefinedType = ..., name: str, update_interval: timedelta | None = None, update_method: Callable[[], Awaitable[_DataT]] | None = None, setup_method: Callable[[], Awaitable[None]] | None = None, request_refresh_debouncer: Debouncer[Coroutine[Any, Any, None]] | None = None, always_update: bool = True) -> None: ...
     async def async_register_shutdown(self) -> None: ...
+    @callback
     def async_add_listener(self, update_callback: CALLBACK_TYPE, context: Any = None) -> Callable[[], None]: ...
+    @callback
     def async_update_listeners(self) -> None: ...
     async def async_shutdown(self) -> None: ...
+    @callback
     def _unschedule_refresh(self) -> None: ...
     def async_contexts(self) -> Generator[Any]: ...
     def _async_unsub_refresh(self) -> None: ...
@@ -61,7 +65,9 @@ class DataUpdateCoordinator(BaseDataUpdateCoordinatorProtocol, Generic[_DataT]):
     _update_interval: Incomplete
     @update_interval.setter
     def update_interval(self, value: timedelta | None) -> None: ...
+    @callback
     def _schedule_refresh(self) -> None: ...
+    @callback
     def __wrap_handle_refresh_interval(self) -> None: ...
     async def _handle_refresh_interval(self, _now: datetime | None = None) -> None: ...
     async def async_request_refresh(self) -> None: ...
@@ -71,12 +77,16 @@ class DataUpdateCoordinator(BaseDataUpdateCoordinatorProtocol, Generic[_DataT]):
     async def _async_setup(self) -> None: ...
     async def async_refresh(self) -> None: ...
     async def _async_refresh(self, log_failures: bool = True, raise_on_auth_failed: bool = False, scheduled: bool = False, raise_on_entry_error: bool = False) -> None: ...
+    @callback
     def _async_refresh_finished(self) -> None: ...
+    @callback
     def async_set_update_error(self, err: Exception) -> None: ...
+    @callback
     def async_set_updated_data(self, data: _DataT) -> None: ...
 
 class TimestampDataUpdateCoordinator(DataUpdateCoordinator[_DataT]):
     last_update_success_time: datetime | None
+    @callback
     def _async_refresh_finished(self) -> None: ...
 
 class BaseCoordinatorEntity[_BaseDataUpdateCoordinatorT: BaseDataUpdateCoordinatorProtocol](entity.Entity, metaclass=abc.ABCMeta):
@@ -86,6 +96,7 @@ class BaseCoordinatorEntity[_BaseDataUpdateCoordinatorT: BaseDataUpdateCoordinat
     @cached_property
     def should_poll(self) -> bool: ...
     async def async_added_to_hass(self) -> None: ...
+    @callback
     def _handle_coordinator_update(self) -> None: ...
     @abstractmethod
     async def async_update(self) -> None: ...

homeassistant-stubs/loader.pyi

@@ -148,6 +148,7 @@ def homekit_always_discover(iot_class: str | None) -> bool: ...
 async def async_get_homekit(hass: HomeAssistant) -> dict[str, HomeKitDiscoveredIntegration]: ...
 async def async_get_ssdp(hass: HomeAssistant) -> dict[str, list[dict[str, str]]]: ...
 async def async_get_mqtt(hass: HomeAssistant) -> dict[str, list[str]]: ...
+@callback
 def async_register_preload_platform(hass: HomeAssistant, platform_name: str) -> None: ...
 
 class Integration:
@@ -244,6 +245,7 @@ class Integration:
 
 def _version_blocked(integration_version: AwesomeVersion, blocked_integration: BlockedIntegration) -> bool: ...
 def _resolve_integrations_from_root(hass: HomeAssistant, root_module: ModuleType, domains: Iterable[str]) -> dict[str, Integration]: ...
+@callback
 def async_get_loaded_integration(hass: HomeAssistant, domain: str) -> Integration: ...
 async def async_get_integration(hass: HomeAssistant, domain: str) -> Integration: ...
 async def async_get_integrations(hass: HomeAssistant, domains: Iterable[str]) -> dict[str, Integration | Exception]: ...
@@ -286,6 +288,9 @@ async def _async_component_dependencies(hass: HomeAssistant, integration: Integr
 def _async_mount_config_dir(hass: HomeAssistant) -> None: ...
 def _lookup_path(hass: HomeAssistant) -> list[str]: ...
 def is_component_module_loaded(hass: HomeAssistant, module: str) -> bool: ...
+@callback
 def async_get_issue_integration(hass: HomeAssistant | None, integration_domain: str | None) -> Integration | None: ...
+@callback
 def async_get_issue_tracker(hass: HomeAssistant | None, *, integration: Integration | None = None, integration_domain: str | None = None, module: str | None = None) -> str | None: ...
+@callback
 def async_suggest_report_issue(hass: HomeAssistant | None, *, integration: Integration | None = None, integration_domain: str | None = None, module: str | None = None) -> str: ...

homeassistant-stubs/requirements.pyi

@@ -22,7 +22,9 @@ class RequirementsNotFound(HomeAssistantError):
 async def async_get_integration_with_requirements(hass: HomeAssistant, domain: str) -> Integration: ...
 async def async_process_requirements(hass: HomeAssistant, name: str, requirements: list[str]) -> None: ...
 async def async_load_installed_versions(hass: HomeAssistant, requirements: set[str]) -> None: ...
+@callback
 def _async_get_manager(hass: HomeAssistant) -> RequirementsManager: ...
+@callback
 def async_clear_install_history(hass: HomeAssistant) -> None: ...
 def pip_kwargs(config_dir: str | None) -> dict[str, Any]: ...
 def _install_with_retry(requirement: str, kwargs: dict[str, Any]) -> bool: ...

homeassistant-stubs/runner.pyi

@@ -33,6 +33,7 @@ class HassEventLoopPolicy(asyncio.DefaultEventLoopPolicy):
     def loop_name(self) -> str: ...
     def new_event_loop(self) -> asyncio.AbstractEventLoop: ...
 
+@callback
 def _async_loop_exception_handler(_: Any, context: dict[str, Any]) -> None: ...
 async def setup_and_run_hass(runtime_config: RuntimeConfig) -> int: ...
 def _enable_posix_spawn() -> None: ...

homeassistant-stubs/scripts/benchmark/__init__.pyi

@@ -10,11 +10,19 @@ BENCHMARKS: dict[str, Callable]
 def run(args) -> None: ...
 async def run_benchmark(bench) -> None: ...
 def benchmark[_CallableT: Callable](func: _CallableT) -> _CallableT: ...
+@benchmark
 async def fire_events(hass): ...
+@benchmark
 async def fire_events_with_filter(hass): ...
+@benchmark
 async def state_changed_helper(hass): ...
+@benchmark
 async def state_changed_event_helper(hass): ...
+@benchmark
 async def state_changed_event_filter_helper(hass): ...
+@benchmark
 async def filtering_entity_id(hass): ...
+@benchmark
 async def valid_entity_id(hass): ...
+@benchmark
 async def json_serialize_states(hass): ...

homeassistant-stubs/setup.pyi

@@ -1,4 +1,5 @@
 import asyncio
+import contextlib
 import contextvars
 from . import core as core, loader as loader, requirements as requirements
 from .const import BASE_PLATFORMS as BASE_PLATFORMS, EVENT_COMPONENT_LOADED as EVENT_COMPONENT_LOADED, EVENT_HOMEASSISTANT_START as EVENT_HOMEASSISTANT_START, PLATFORM_FORMAT as PLATFORM_FORMAT
@@ -32,7 +33,9 @@ SLOW_SETUP_MAX_WAIT: int
 class EventComponentLoaded(TypedDict):
     component: str
 
+@callback
 def async_notify_setup_error(hass: HomeAssistant, component: str, display_link: str | None = None) -> None: ...
+@core.callback
 def async_set_domains_to_be_loaded(hass: core.HomeAssistant, domains: set[str]) -> None: ...
 def setup_component(hass: core.HomeAssistant, domain: str, config: ConfigType) -> bool: ...
 async def async_setup_component(hass: core.HomeAssistant, domain: str, config: ConfigType) -> bool: ...
@@ -41,9 +44,13 @@ def _log_error_setup_error(hass: HomeAssistant, domain: str, integration: loader
 async def _async_setup_component(hass: core.HomeAssistant, domain: str, config: ConfigType) -> bool: ...
 async def async_prepare_setup_platform(hass: core.HomeAssistant, hass_config: ConfigType, domain: str, platform_name: str) -> ModuleType | None: ...
 async def async_process_deps_reqs(hass: core.HomeAssistant, config: ConfigType, integration: loader.Integration) -> None: ...
+@core.callback
 def async_when_setup(hass: core.HomeAssistant, component: str, when_setup_cb: Callable[[core.HomeAssistant, str], Awaitable[None]]) -> None: ...
+@core.callback
 def async_when_setup_or_start(hass: core.HomeAssistant, component: str, when_setup_cb: Callable[[core.HomeAssistant, str], Awaitable[None]]) -> None: ...
+@core.callback
 def _async_when_setup(hass: core.HomeAssistant, component: str, when_setup_cb: Callable[[core.HomeAssistant, str], Awaitable[None]], start_event: bool) -> None: ...
+@core.callback
 def async_get_loaded_integrations(hass: core.HomeAssistant) -> set[str]: ...
 
 class SetupPhases(StrEnum):
@@ -56,8 +63,12 @@ class SetupPhases(StrEnum):
     WAIT_IMPORT_PACKAGES = 'wait_import_packages'
 
 def _setup_started(hass: core.HomeAssistant) -> dict[tuple[str, str | None], float]: ...
+@contextlib.contextmanager
 def async_pause_setup(hass: core.HomeAssistant, phase: SetupPhases) -> Generator[None]: ...
 def _setup_times(hass: core.HomeAssistant) -> defaultdict[str, defaultdict[str | None, defaultdict[SetupPhases, float]]]: ...
+@contextlib.contextmanager
 def async_start_setup(hass: core.HomeAssistant, integration: str, phase: SetupPhases, group: str | None = None) -> Generator[None]: ...
+@callback
 def async_get_setup_timings(hass: core.HomeAssistant) -> dict[str, float]: ...
+@callback
 def async_get_domain_setup_times(hass: core.HomeAssistant, domain: str) -> Mapping[str | None, dict[SetupPhases, float]]: ...

homeassistant-stubs/util/enum.pyi

@@ -3,4 +3,5 @@ from enum import Enum as Enum
 from typing import Any
 
 def lru_cache[_T: Callable[..., Any]](func: _T) -> _T: ...
+@lru_cache
 def try_parse_enum[_EnumT: Enum](cls, value: Any) -> _EnumT | None: ...

homeassistant-stubs/util/location.pyi

@@ -1,5 +1,6 @@
 import aiohttp
 from _typeshed import Incomplete
+from functools import lru_cache
 from typing import Any, NamedTuple
 
 WHOAMI_URL: str
@@ -25,6 +26,7 @@ class LocationInfo(NamedTuple):
     use_metric: bool
 
 async def async_detect_location_info(session: aiohttp.ClientSession) -> LocationInfo | None: ...
+@lru_cache
 def distance(lat1: float | None, lon1: float | None, lat2: float, lon2: float) -> float | None: ...
 def vincenty(point1: tuple[float, float], point2: tuple[float, float], miles: bool = False) -> float | None: ...
 async def _get_whoami(session: aiohttp.ClientSession) -> dict[str, Any] | None: ...

homeassistant-stubs/util/logging.pyi

@@ -9,10 +9,12 @@ class HomeAssistantQueueHandler(logging.handlers.QueueHandler):
     def handle(self, record: logging.LogRecord) -> Any: ...
     def close(self) -> None: ...
 
+@callback
 def async_activate_log_queue_handler(hass: HomeAssistant) -> None: ...
 def log_exception[*_Ts](format_err: Callable[[*_Ts], Any], *args: *_Ts) -> None: ...
 async def _async_wrapper[*_Ts](async_func: Callable[[*_Ts], Coroutine[Any, Any, None]], format_err: Callable[[*_Ts], Any], *args: *_Ts) -> None: ...
 def _sync_wrapper[*_Ts](func: Callable[[*_Ts], Any], format_err: Callable[[*_Ts], Any], *args: *_Ts) -> None: ...
+@callback
 def _callback_wrapper[*_Ts](func: Callable[[*_Ts], Any], format_err: Callable[[*_Ts], Any], *args: *_Ts) -> None: ...
 @overload
 def catch_log_exception[*_Ts](func: Callable[[*_Ts], Coroutine[Any, Any, Any]], format_err: Callable[[*_Ts], Any], job_type: HassJobType | None = None) -> Callable[[*_Ts], Coroutine[Any, Any, None]]: ...

homeassistant-stubs/util/loop.pyi

@@ -1,5 +1,6 @@
 from _typeshed import Incomplete
 from collections.abc import Callable as Callable
+from functools import cache
 from homeassistant.core import async_get_hass_or_none as async_get_hass_or_none
 from homeassistant.helpers.frame import MissingIntegrationFrame as MissingIntegrationFrame, get_current_frame as get_current_frame, get_integration_frame as get_integration_frame
 from homeassistant.loader import async_suggest_report_issue as async_suggest_report_issue
@@ -12,5 +13,6 @@ def _get_line_from_cache(filename: str, lineno: int) -> str: ...
 _PREVIOUSLY_REPORTED: set[tuple[str | None, str, int | Any]]
 
 def raise_for_blocking_call(func: Callable[..., Any], check_allowed: Callable[[dict[str, Any]], bool] | None = None, strict: bool = True, strict_core: bool = True, **mapped_args: Any) -> None: ...
+@cache
 def _dev_help_message(what: str) -> str: ...
 def protect_loop[**_P, _R](func: Callable[_P, _R], loop_thread_id: int, strict: bool = True, strict_core: bool = True, check_allowed: Callable[[dict[str, Any]], bool] | None = None) -> Callable[_P, _R]: ...

homeassistant-stubs/util/package.pyi

@@ -1,9 +1,11 @@
 from .system_info import is_official_image as is_official_image
 from _typeshed import Incomplete
+from functools import cache
 
 _LOGGER: Incomplete
 
 def is_virtual_env() -> bool: ...
+@cache
 def is_docker_env() -> bool: ...
 def get_installed_versions(specifiers: set[str]) -> set[str]: ...
 def is_installed(requirement_str: str) -> bool: ...

homeassistant-stubs/util/ssl.pyi

@@ -1,6 +1,7 @@
 import ssl
 from _typeshed import Incomplete
 from enum import StrEnum
+from functools import cache
 
 class SSLCipherList(StrEnum):
     PYTHON_DEFAULT = 'python_default'
@@ -10,7 +11,9 @@ class SSLCipherList(StrEnum):
 
 SSL_CIPHER_LISTS: Incomplete
 
+@cache
 def _client_context_no_verify(ssl_cipher_list: SSLCipherList) -> ssl.SSLContext: ...
+@cache
 def _client_context(ssl_cipher_list: SSLCipherList = ...) -> ssl.SSLContext: ...
 
 _DEFAULT_SSL_CONTEXT: Incomplete

homeassistant-stubs/util/system_info.pyi

@@ -1 +1,4 @@
+from functools import cache
+
+@cache
 def is_official_image() -> bool: ...