homeassistant-stubs 2025.3.3__tar.gz → 2025.4.0__tar.gz

homeassistant_stubs-2025.4.0/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.4
+Name: homeassistant-stubs
+Version: 2025.4.0
+Summary: PEP 484 typing stubs for Home Assistant Core
+Project-URL: Homepage, https://github.com/KapJI/homeassistant-stubs
+Project-URL: Bug Tracker, https://github.com/KapJI/homeassistant-stubs/issues
+Project-URL: Release Notes, https://github.com/KapJI/homeassistant-stubs/releases
+Author-email: Ruslan Sayfutdinov <ruslan@sayfutdinov.com>
+License: MIT
+License-File: LICENSE
+Keywords: homeassistant,pep484,typing
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Home Automation
+Classifier: Topic :: Software Development
+Classifier: Typing :: Typed
+Requires-Python: <3.14,>=3.13
+Requires-Dist: homeassistant==2025.4.0
+Description-Content-Type: text/markdown
+
+[![CI](https://github.com/KapJI/homeassistant-stubs/actions/workflows/ci.yaml/badge.svg)](https://github.com/KapJI/homeassistant-stubs/actions/workflows/ci.yaml)
+[![PyPI version](https://img.shields.io/pypi/v/homeassistant-stubs)](https://pypi.org/project/homeassistant-stubs/)
+
+# PEP 484 stubs for Home Assistant Core
+
+This is unofficial stub-only package generated from [Home Assistant Core](https://github.com/home-assistant/core) sources.
+You can use it to enable type checks against Home Assistant code in your custom component or AppDaemon app.
+
+## How to use
+
+Add it to dev dependencies of your project.
+I recommend to use [uv](https://docs.astral.sh/uv/) for managing dependencies:
+
+```shell
+uv add --dev homeassistant-stubs
+```
+
+Please note that only stubs from strictly typed modules are added in this package.
+This includes all core modules and some components.
+Generic components like `sensor`, `light` or `media_player` are already typed.
+
+If your project imports not yet typed components, `mypy` will be unable to find that module.
+The best thing you can do to fix this is to submit PR to HA Core which adds type hints for these components.
+After that stubs for these components will become available in this package.
+
+## Motivation
+
+Home Assistant maintainers don't want to distribute typing information with `homeassistant` package
+([[1]](https://github.com/home-assistant/core/pull/28866),
+[[2]](https://github.com/home-assistant/core/pull/47796)).
+The reason is that [PEP 561](https://www.python.org/dev/peps/pep-0561/#packaging-type-information)
+says that `py.typed` marker is applied recursively and the whole package must support type checking.
+But many of the Home Assistant components are currently not type checked.
+
+## How it works
+
+- `update_stubs.py` script extracts list of strictly typed modules from Home Assistant configs.
+- Then it runs `stubgen` which is shipped with `mypy` to generate typing stubs.
+- New versions are generated and published automatically every 12 hours.

homeassistant_stubs-2025.4.0/homeassistant-stubs/bootstrap.pyi

@@ -0,0 +1,79 @@
+import asyncio
+import logging
+from . import block_async_io as block_async_io, config_entries as config_entries, core as core, loader as loader, requirements as requirements
+from .components import http as http
+from .const import BASE_PLATFORMS as BASE_PLATFORMS, FORMAT_DATETIME as FORMAT_DATETIME, REQUIRED_NEXT_PYTHON_HA_RELEASE as REQUIRED_NEXT_PYTHON_HA_RELEASE, REQUIRED_NEXT_PYTHON_VER as REQUIRED_NEXT_PYTHON_VER, SIGNAL_BOOTSTRAP_INTEGRATIONS as SIGNAL_BOOTSTRAP_INTEGRATIONS
+from .core_config import async_process_ha_core_config as async_process_ha_core_config
+from .exceptions import HomeAssistantError as HomeAssistantError
+from .helpers import area_registry as area_registry, backup as backup, category_registry as category_registry, device_registry as device_registry, entity as entity, entity_registry as entity_registry, floor_registry as floor_registry, frame as frame, issue_registry as issue_registry, label_registry as label_registry, recorder as recorder, restore_state as restore_state, template as template, translation as translation
+from .helpers.dispatcher import async_dispatcher_send_internal as async_dispatcher_send_internal
+from .helpers.storage import get_internal_store_manager as get_internal_store_manager
+from .helpers.system_info import async_get_system_info as async_get_system_info
+from .helpers.typing import ConfigType as ConfigType
+from .loader import Integration as Integration
+from .runner import RuntimeConfig as RuntimeConfig
+from .setup import _setup_started as _setup_started, async_get_setup_timings as async_get_setup_timings, async_notify_setup_error as async_notify_setup_error, async_set_domains_to_be_loaded as async_set_domains_to_be_loaded, async_setup_component as async_setup_component
+from .util.async_ import create_eager_task as create_eager_task
+from .util.hass_dict import HassKey as HassKey
+from .util.logging import async_activate_log_queue_handler as async_activate_log_queue_handler
+from .util.package import async_get_user_site as async_get_user_site, is_docker_env as is_docker_env, is_virtual_env as is_virtual_env
+from .util.system_info import is_official_image as is_official_image
+from _typeshed import Incomplete
+from anyio._backends import _asyncio as _asyncio
+from logging.handlers import RotatingFileHandler, TimedRotatingFileHandler
+from typing import Any
+
+_LOGGER: Incomplete
+SETUP_ORDER_SORT_KEY: Incomplete
+ERROR_LOG_FILENAME: str
+DATA_REGISTRIES_LOADED: HassKey[None]
+LOG_SLOW_STARTUP_INTERVAL: int
+SLOW_STARTUP_CHECK_INTERVAL: int
+STAGE_0_SUBSTAGE_TIMEOUT: int
+STAGE_1_TIMEOUT: int
+STAGE_2_TIMEOUT: int
+WRAP_UP_TIMEOUT: int
+COOLDOWN_TIME: int
+CORE_INTEGRATIONS: Incomplete
+LOGGING_AND_HTTP_DEPS_INTEGRATIONS: Incomplete
+FRONTEND_INTEGRATIONS: Incomplete
+STAGE_0_INTEGRATIONS: Incomplete
+DISCOVERY_INTEGRATIONS: Incomplete
+STAGE_1_INTEGRATIONS: Incomplete
+DEFAULT_INTEGRATIONS: Incomplete
+DEFAULT_INTEGRATIONS_RECOVERY_MODE: Incomplete
+DEFAULT_INTEGRATIONS_SUPERVISOR: Incomplete
+CRITICAL_INTEGRATIONS: Incomplete
+PRELOAD_STORAGE: Incomplete
+
+async def async_setup_hass(runtime_config: RuntimeConfig) -> core.HomeAssistant | None: ...
+def open_hass_ui(hass: core.HomeAssistant) -> None: ...
+def _init_blocking_io_modules_in_executor() -> None: ...
+async def async_load_base_functionality(hass: core.HomeAssistant) -> None: ...
+async def async_from_config_dict(config: ConfigType, hass: core.HomeAssistant) -> core.HomeAssistant | None: ...
+async def async_enable_logging(hass: core.HomeAssistant, verbose: bool = False, log_rotate_days: int | None = None, log_file: str | None = None, log_no_color: bool = False) -> None: ...
+def _create_log_file(err_log_path: str, log_rotate_days: int | None) -> RotatingFileHandler | TimedRotatingFileHandler: ...
+
+class _RotatingFileHandlerWithoutShouldRollOver(RotatingFileHandler):
+    def shouldRollover(self, record: logging.LogRecord) -> bool: ...
+
+async def async_mount_local_lib_path(config_dir: str) -> str: ...
+def _get_domains(hass: core.HomeAssistant, config: dict[str, Any]) -> set[str]: ...
+async def _async_resolve_domains_and_preload(hass: core.HomeAssistant, config: dict[str, Any]) -> tuple[dict[str, Integration], dict[str, Integration]]: ...
+async def _async_set_up_integrations(hass: core.HomeAssistant, config: dict[str, Any]) -> None: ...
+
+class _WatchPendingSetups:
+    _hass: Incomplete
+    _setup_started: Incomplete
+    _duration_count: int
+    _handle: asyncio.TimerHandle | None
+    _previous_was_empty: bool
+    _loop: Incomplete
+    def __init__(self, hass: core.HomeAssistant, setup_started: dict[tuple[str, str | None], float]) -> None: ...
+    def _async_watch(self) -> None: ...
+    def _async_dispatch(self, remaining_with_setup_started: dict[str, float]) -> None: ...
+    def _async_schedule_next(self) -> None: ...
+    def async_start(self) -> None: ...
+    def async_stop(self) -> None: ...
+
+async def _async_setup_multi_components(hass: core.HomeAssistant, domains: set[str], config: dict[str, Any]) -> None: ...

homeassistant_stubs-2025.4.0/homeassistant-stubs/components/accuweather/const.pyi

@@ -0,0 +1,21 @@
+from _typeshed import Incomplete
+from homeassistant.components.weather import ATTR_CONDITION_CLEAR_NIGHT as ATTR_CONDITION_CLEAR_NIGHT, ATTR_CONDITION_CLOUDY as ATTR_CONDITION_CLOUDY, ATTR_CONDITION_EXCEPTIONAL as ATTR_CONDITION_EXCEPTIONAL, ATTR_CONDITION_FOG as ATTR_CONDITION_FOG, ATTR_CONDITION_HAIL as ATTR_CONDITION_HAIL, ATTR_CONDITION_LIGHTNING as ATTR_CONDITION_LIGHTNING, ATTR_CONDITION_LIGHTNING_RAINY as ATTR_CONDITION_LIGHTNING_RAINY, ATTR_CONDITION_PARTLYCLOUDY as ATTR_CONDITION_PARTLYCLOUDY, ATTR_CONDITION_POURING as ATTR_CONDITION_POURING, ATTR_CONDITION_RAINY as ATTR_CONDITION_RAINY, ATTR_CONDITION_SNOWY as ATTR_CONDITION_SNOWY, ATTR_CONDITION_SNOWY_RAINY as ATTR_CONDITION_SNOWY_RAINY, ATTR_CONDITION_SUNNY as ATTR_CONDITION_SUNNY, ATTR_CONDITION_WINDY as ATTR_CONDITION_WINDY
+from typing import Final
+
+API_METRIC: Final[str]
+ATTRIBUTION: Final[str]
+ATTR_CATEGORY_VALUE: str
+ATTR_DIRECTION: Final[str]
+ATTR_ENGLISH: Final[str]
+ATTR_LEVEL: Final[str]
+ATTR_SPEED: Final[str]
+ATTR_VALUE: Final[str]
+DOMAIN: Final[str]
+MANUFACTURER: Final[str]
+MAX_FORECAST_DAYS: Final[int]
+CONDITION_CLASSES: Final[dict[str, list[int]]]
+CONDITION_MAP: Incomplete
+AIR_QUALITY_CATEGORY_MAP: Incomplete
+POLLEN_CATEGORY_MAP: Incomplete
+UPDATE_INTERVAL_OBSERVATION: Incomplete
+UPDATE_INTERVAL_DAILY_FORECAST: Incomplete

homeassistant_stubs-2025.4.0/homeassistant-stubs/components/accuweather/sensor.pyi

@@ -0,0 +1,59 @@
+from .const import AIR_QUALITY_CATEGORY_MAP as AIR_QUALITY_CATEGORY_MAP, API_METRIC as API_METRIC, ATTRIBUTION as ATTRIBUTION, ATTR_CATEGORY_VALUE as ATTR_CATEGORY_VALUE, ATTR_DIRECTION as ATTR_DIRECTION, ATTR_ENGLISH as ATTR_ENGLISH, ATTR_LEVEL as ATTR_LEVEL, ATTR_SPEED as ATTR_SPEED, ATTR_VALUE as ATTR_VALUE, MAX_FORECAST_DAYS as MAX_FORECAST_DAYS, POLLEN_CATEGORY_MAP as POLLEN_CATEGORY_MAP
+from .coordinator import AccuWeatherConfigEntry as AccuWeatherConfigEntry, AccuWeatherDailyForecastDataUpdateCoordinator as AccuWeatherDailyForecastDataUpdateCoordinator, AccuWeatherObservationDataUpdateCoordinator as AccuWeatherObservationDataUpdateCoordinator
+from _typeshed import Incomplete
+from collections.abc import Callable as Callable
+from dataclasses import dataclass
+from homeassistant.components.sensor import SensorDeviceClass as SensorDeviceClass, SensorEntity as SensorEntity, SensorEntityDescription as SensorEntityDescription, SensorStateClass as SensorStateClass
+from homeassistant.const import CONCENTRATION_PARTS_PER_CUBIC_METER as CONCENTRATION_PARTS_PER_CUBIC_METER, PERCENTAGE as PERCENTAGE, UV_INDEX as UV_INDEX, UnitOfIrradiance as UnitOfIrradiance, UnitOfLength as UnitOfLength, UnitOfPressure as UnitOfPressure, UnitOfSpeed as UnitOfSpeed, UnitOfTemperature as UnitOfTemperature, UnitOfTime as UnitOfTime, UnitOfVolumetricFlux as UnitOfVolumetricFlux
+from homeassistant.core import HomeAssistant as HomeAssistant, callback as callback
+from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback as AddConfigEntryEntitiesCallback
+from homeassistant.helpers.update_coordinator import CoordinatorEntity as CoordinatorEntity
+from typing import Any
+
+PARALLEL_UPDATES: int
+
+@dataclass(frozen=True, kw_only=True)
+class AccuWeatherSensorDescription(SensorEntityDescription):
+    value_fn: Callable[[dict[str, Any]], str | int | float | None]
+    attr_fn: Callable[[dict[str, Any]], dict[str, Any]] = ...
+
+FORECAST_SENSOR_TYPES: tuple[AccuWeatherSensorDescription, ...]
+SENSOR_TYPES: tuple[AccuWeatherSensorDescription, ...]
+
+async def async_setup_entry(hass: HomeAssistant, entry: AccuWeatherConfigEntry, async_add_entities: AddConfigEntryEntitiesCallback) -> None: ...
+
+class AccuWeatherSensor(CoordinatorEntity[AccuWeatherObservationDataUpdateCoordinator], SensorEntity):
+    _attr_attribution = ATTRIBUTION
+    _attr_has_entity_name: bool
+    entity_description: AccuWeatherSensorDescription
+    _sensor_data: Incomplete
+    _attr_unique_id: Incomplete
+    _attr_device_info: Incomplete
+    def __init__(self, coordinator: AccuWeatherObservationDataUpdateCoordinator, description: AccuWeatherSensorDescription) -> None: ...
+    @property
+    def native_value(self) -> str | int | float | None: ...
+    @property
+    def extra_state_attributes(self) -> dict[str, Any]: ...
+    @callback
+    def _handle_coordinator_update(self) -> None: ...
+    @staticmethod
+    def _get_sensor_data(sensors: dict[str, Any], kind: str) -> Any: ...
+
+class AccuWeatherForecastSensor(CoordinatorEntity[AccuWeatherDailyForecastDataUpdateCoordinator], SensorEntity):
+    _attr_attribution = ATTRIBUTION
+    _attr_has_entity_name: bool
+    entity_description: AccuWeatherSensorDescription
+    _sensor_data: Incomplete
+    _attr_unique_id: Incomplete
+    _attr_device_info: Incomplete
+    _attr_translation_placeholders: Incomplete
+    forecast_day: Incomplete
+    def __init__(self, coordinator: AccuWeatherDailyForecastDataUpdateCoordinator, description: AccuWeatherSensorDescription, forecast_day: int) -> None: ...
+    @property
+    def native_value(self) -> str | int | float | None: ...
+    @property
+    def extra_state_attributes(self) -> dict[str, Any]: ...
+    @callback
+    def _handle_coordinator_update(self) -> None: ...
+    @staticmethod
+    def _get_sensor_data(sensors: list[dict[str, Any]], kind: str, forecast_day: int) -> Any: ...

homeassistant_stubs-2025.4.0/homeassistant-stubs/components/anova/config_flow.pyi

@@ -0,0 +1,12 @@
+from .const import DOMAIN as DOMAIN
+from _typeshed import Incomplete
+from homeassistant.config_entries import ConfigFlow as ConfigFlow, ConfigFlowResult as ConfigFlowResult
+from homeassistant.const import CONF_PASSWORD as CONF_PASSWORD, CONF_USERNAME as CONF_USERNAME
+from homeassistant.helpers.aiohttp_client import async_get_clientsession as async_get_clientsession
+
+_LOGGER: Incomplete
+
+class AnovaConfigFlow(ConfigFlow, domain=DOMAIN):
+    VERSION: int
+    MINOR_VERSION: int
+    async def async_step_user(self, user_input: dict[str, str] | None = None) -> ConfigFlowResult: ...

homeassistant_stubs-2025.4.0/homeassistant-stubs/components/anthemav/media_player.pyi

@@ -0,0 +1,46 @@
+from . import AnthemavConfigEntry as AnthemavConfigEntry
+from .const import ANTHEMAV_UPDATE_SIGNAL as ANTHEMAV_UPDATE_SIGNAL, DOMAIN as DOMAIN, MANUFACTURER as MANUFACTURER
+from _typeshed import Incomplete
+from anthemav.protocol import AVR as AVR
+from homeassistant.components.media_player import MediaPlayerDeviceClass as MediaPlayerDeviceClass, MediaPlayerEntity as MediaPlayerEntity, MediaPlayerEntityFeature as MediaPlayerEntityFeature, MediaPlayerState as MediaPlayerState
+from homeassistant.const import CONF_MAC as CONF_MAC, CONF_MODEL as CONF_MODEL
+from homeassistant.core import HomeAssistant as HomeAssistant, callback as callback
+from homeassistant.helpers.device_registry import DeviceInfo as DeviceInfo
+from homeassistant.helpers.dispatcher import async_dispatcher_connect as async_dispatcher_connect
+from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback as AddConfigEntryEntitiesCallback
+
+_LOGGER: Incomplete
+VOLUME_STEP: float
+
+async def async_setup_entry(hass: HomeAssistant, config_entry: AnthemavConfigEntry, async_add_entities: AddConfigEntryEntitiesCallback) -> None: ...
+
+class AnthemAVR(MediaPlayerEntity):
+    _attr_has_entity_name: bool
+    _attr_name: Incomplete
+    _attr_should_poll: bool
+    _attr_device_class: Incomplete
+    _attr_supported_features: Incomplete
+    _attr_volume_step = VOLUME_STEP
+    avr: Incomplete
+    _entry_id: Incomplete
+    _zone_number: Incomplete
+    _zone: Incomplete
+    _attr_unique_id: Incomplete
+    _attr_device_info: Incomplete
+    def __init__(self, avr: AVR, name: str, mac_address: str, model: str, zone_number: int, entry_id: str) -> None: ...
+    async def async_added_to_hass(self) -> None: ...
+    @callback
+    def update_states(self) -> None: ...
+    _attr_state: Incomplete
+    _attr_is_volume_muted: Incomplete
+    _attr_volume_level: Incomplete
+    _attr_media_title: Incomplete
+    _attr_app_name: Incomplete
+    _attr_source: Incomplete
+    _attr_source_list: Incomplete
+    def set_states(self) -> None: ...
+    async def async_select_source(self, source: str) -> None: ...
+    async def async_turn_off(self) -> None: ...
+    async def async_turn_on(self) -> None: ...
+    async def async_set_volume_level(self, volume: float) -> None: ...
+    async def async_mute_volume(self, mute: bool) -> None: ...

homeassistant_stubs-2025.4.0/homeassistant-stubs/components/arwn/sensor.pyi

@@ -0,0 +1,34 @@
+from _typeshed import Incomplete
+from homeassistant.components import mqtt as mqtt
+from homeassistant.components.sensor import SensorDeviceClass as SensorDeviceClass, SensorEntity as SensorEntity, SensorStateClass as SensorStateClass
+from homeassistant.const import DEGREE as DEGREE, UnitOfPrecipitationDepth as UnitOfPrecipitationDepth, UnitOfTemperature as UnitOfTemperature
+from homeassistant.core import HomeAssistant as HomeAssistant, callback as callback
+from homeassistant.helpers.entity_platform import AddEntitiesCallback as AddEntitiesCallback
+from homeassistant.helpers.typing import ConfigType as ConfigType, DiscoveryInfoType as DiscoveryInfoType
+from homeassistant.util import slugify as slugify
+from homeassistant.util.json import json_loads_object as json_loads_object
+from typing import Any
+
+_LOGGER: Incomplete
+DOMAIN: str
+DATA_ARWN: str
+TOPIC: str
+
+def discover_sensors(topic: str, payload: dict[str, Any]) -> list[ArwnSensor] | None: ...
+def _slug(name: str) -> str: ...
+async def async_setup_platform(hass: HomeAssistant, config: ConfigType, async_add_entities: AddEntitiesCallback, discovery_info: DiscoveryInfoType | None = None) -> None: ...
+
+class ArwnSensor(SensorEntity):
+    _attr_should_poll: bool
+    entity_id: Incomplete
+    _attr_name: Incomplete
+    _attr_unique_id: Incomplete
+    _state_key: Incomplete
+    _attr_native_unit_of_measurement: Incomplete
+    _attr_icon: Incomplete
+    _attr_device_class: Incomplete
+    _attr_state_class: Incomplete
+    def __init__(self, topic: str, name: str, state_key: str, units: str, icon: str | None = None, device_class: SensorDeviceClass | None = None, state_class: SensorStateClass | None = None) -> None: ...
+    _attr_extra_state_attributes: Incomplete
+    _attr_native_value: Incomplete
+    def set_event(self, event: dict[str, Any]) -> None: ...

homeassistant_stubs-2025.4.0/homeassistant-stubs/components/assist_pipeline/pipeline.pyi

@@ -0,0 +1,275 @@
+import asyncio
+from .audio_enhancer import AudioEnhancer as AudioEnhancer, EnhancedAudioChunk as EnhancedAudioChunk, MicroVadSpeexEnhancer as MicroVadSpeexEnhancer
+from .const import BYTES_PER_CHUNK as BYTES_PER_CHUNK, CONF_DEBUG_RECORDING_DIR as CONF_DEBUG_RECORDING_DIR, DATA_CONFIG as DATA_CONFIG, DATA_LAST_WAKE_UP as DATA_LAST_WAKE_UP, DATA_MIGRATIONS as DATA_MIGRATIONS, DOMAIN as DOMAIN, MS_PER_CHUNK as MS_PER_CHUNK, SAMPLES_PER_CHUNK as SAMPLES_PER_CHUNK, SAMPLE_CHANNELS as SAMPLE_CHANNELS, SAMPLE_RATE as SAMPLE_RATE, SAMPLE_WIDTH as SAMPLE_WIDTH, WAKE_WORD_COOLDOWN as WAKE_WORD_COOLDOWN
+from .error import DuplicateWakeUpDetectedError as DuplicateWakeUpDetectedError, IntentRecognitionError as IntentRecognitionError, PipelineError as PipelineError, PipelineNotFound as PipelineNotFound, SpeechToTextError as SpeechToTextError, TextToSpeechError as TextToSpeechError, WakeWordDetectionAborted as WakeWordDetectionAborted, WakeWordDetectionError as WakeWordDetectionError, WakeWordTimeoutError as WakeWordTimeoutError
+from .vad import AudioBuffer as AudioBuffer, VoiceActivityTimeout as VoiceActivityTimeout, VoiceCommandSegmenter as VoiceCommandSegmenter, chunk_samples as chunk_samples
+from _typeshed import Incomplete
+from collections import deque
+from collections.abc import AsyncGenerator, AsyncIterable, Callable
+from dataclasses import dataclass, field
+from enum import StrEnum
+from hassil.recognize import RecognizeResult as RecognizeResult
+from homeassistant.components import conversation as conversation, stt as stt, tts as tts, wake_word as wake_word, websocket_api as websocket_api
+from homeassistant.const import ATTR_SUPPORTED_FEATURES as ATTR_SUPPORTED_FEATURES, MATCH_ALL as MATCH_ALL
+from homeassistant.core import Context as Context, HomeAssistant as HomeAssistant, callback as callback
+from homeassistant.exceptions import HomeAssistantError as HomeAssistantError
+from homeassistant.helpers import chat_session as chat_session, intent as intent
+from homeassistant.helpers.collection import CHANGE_UPDATED as CHANGE_UPDATED, CollectionError as CollectionError, ItemNotFound as ItemNotFound, SerializedStorageCollection as SerializedStorageCollection, StorageCollection as StorageCollection, StorageCollectionWebsocket as StorageCollectionWebsocket
+from homeassistant.helpers.singleton import singleton as singleton
+from homeassistant.helpers.storage import Store as Store
+from homeassistant.helpers.typing import UNDEFINED as UNDEFINED, UndefinedType as UndefinedType, VolDictType as VolDictType
+from homeassistant.util import ulid as ulid_util
+from homeassistant.util.hass_dict import HassKey as HassKey
+from homeassistant.util.limited_size_dict import LimitedSizeDict as LimitedSizeDict
+from pathlib import Path
+from queue import Queue
+from threading import Thread
+from typing import Any, Literal
+
+_LOGGER: Incomplete
+STORAGE_KEY: Incomplete
+STORAGE_VERSION: int
+STORAGE_VERSION_MINOR: int
+ENGINE_LANGUAGE_PAIRS: Incomplete
+KEY_ASSIST_PIPELINE: HassKey[PipelineData]
+KEY_PIPELINE_CONVERSATION_DATA: HassKey[dict[str, PipelineConversationData]]
+
+def validate_language(data: dict[str, Any]) -> Any: ...
+
+PIPELINE_FIELDS: VolDictType
+STORED_PIPELINE_RUNS: int
+SAVE_DELAY: int
+
+@callback
+def _async_local_fallback_intent_filter(result: RecognizeResult) -> bool: ...
+@callback
+def _async_resolve_default_pipeline_settings(hass: HomeAssistant, *, conversation_engine_id: str | None = None, stt_engine_id: str | None = None, tts_engine_id: str | None = None, pipeline_name: str) -> dict[str, str | None]: ...
+async def _async_create_default_pipeline(hass: HomeAssistant, pipeline_store: PipelineStorageCollection) -> Pipeline: ...
+async def async_create_default_pipeline(hass: HomeAssistant, stt_engine_id: str, tts_engine_id: str, pipeline_name: str) -> Pipeline | None: ...
+@callback
+def _async_get_pipeline_from_conversation_entity(hass: HomeAssistant, entity_id: str) -> Pipeline: ...
+@callback
+def async_get_pipeline(hass: HomeAssistant, pipeline_id: str | None = None) -> Pipeline: ...
+@callback
+def async_get_pipelines(hass: HomeAssistant) -> list[Pipeline]: ...
+async def async_update_pipeline(hass: HomeAssistant, pipeline: Pipeline, *, conversation_engine: str | UndefinedType = ..., conversation_language: str | UndefinedType = ..., language: str | UndefinedType = ..., name: str | UndefinedType = ..., stt_engine: str | None | UndefinedType = ..., stt_language: str | None | UndefinedType = ..., tts_engine: str | None | UndefinedType = ..., tts_language: str | None | UndefinedType = ..., tts_voice: str | None | UndefinedType = ..., wake_word_entity: str | None | UndefinedType = ..., wake_word_id: str | None | UndefinedType = ..., prefer_local_intents: bool | UndefinedType = ...) -> None: ...
+
+class PipelineEventType(StrEnum):
+    RUN_START = 'run-start'
+    RUN_END = 'run-end'
+    WAKE_WORD_START = 'wake_word-start'
+    WAKE_WORD_END = 'wake_word-end'
+    STT_START = 'stt-start'
+    STT_VAD_START = 'stt-vad-start'
+    STT_VAD_END = 'stt-vad-end'
+    STT_END = 'stt-end'
+    INTENT_START = 'intent-start'
+    INTENT_PROGRESS = 'intent-progress'
+    INTENT_END = 'intent-end'
+    TTS_START = 'tts-start'
+    TTS_END = 'tts-end'
+    ERROR = 'error'
+
+@dataclass(frozen=True)
+class PipelineEvent:
+    type: PipelineEventType
+    data: dict[str, Any] | None = ...
+    timestamp: str = field(default_factory=Incomplete)
+type PipelineEventCallback = Callable[[PipelineEvent], None]
+
+@dataclass(frozen=True)
+class Pipeline:
+    conversation_engine: str
+    conversation_language: str
+    language: str
+    name: str
+    stt_engine: str | None
+    stt_language: str | None
+    tts_engine: str | None
+    tts_language: str | None
+    tts_voice: str | None
+    wake_word_entity: str | None
+    wake_word_id: str | None
+    prefer_local_intents: bool = ...
+    id: str = field(default_factory=ulid_util.ulid_now)
+    @classmethod
+    def from_json(cls, data: dict[str, Any]) -> Pipeline: ...
+    def to_json(self) -> dict[str, Any]: ...
+
+class PipelineStage(StrEnum):
+    WAKE_WORD = 'wake_word'
+    STT = 'stt'
+    INTENT = 'intent'
+    TTS = 'tts'
+    END = 'end'
+
+PIPELINE_STAGE_ORDER: Incomplete
+
+class PipelineRunValidationError(Exception): ...
+
+class InvalidPipelineStagesError(PipelineRunValidationError):
+    def __init__(self, start_stage: PipelineStage, end_stage: PipelineStage) -> None: ...
+
+@dataclass(frozen=True)
+class WakeWordSettings:
+    timeout: float | None = ...
+    audio_seconds_to_buffer: float = ...
+
+@dataclass(frozen=True)
+class AudioSettings:
+    noise_suppression_level: int = ...
+    auto_gain_dbfs: int = ...
+    volume_multiplier: float = ...
+    is_vad_enabled: bool = ...
+    silence_seconds: float = ...
+    def __post_init__(self) -> None: ...
+    @property
+    def needs_processor(self) -> bool: ...
+
+@dataclass
+class PipelineRun:
+    hass: HomeAssistant
+    context: Context
+    pipeline: Pipeline
+    start_stage: PipelineStage
+    end_stage: PipelineStage
+    event_callback: PipelineEventCallback
+    language: str = ...
+    runner_data: Any | None = ...
+    intent_agent: str | None = ...
+    tts_audio_output: str | dict[str, Any] | None = ...
+    wake_word_settings: WakeWordSettings | None = ...
+    audio_settings: AudioSettings = field(default_factory=AudioSettings)
+    id: str = field(default_factory=ulid_util.ulid_now)
+    stt_provider: stt.SpeechToTextEntity | stt.Provider = field(init=False, repr=False)
+    tts_stream: tts.ResultStream | None = field(init=False, default=None)
+    wake_word_entity_id: str | None = field(init=False, default=None, repr=False)
+    wake_word_entity: wake_word.WakeWordDetectionEntity = field(init=False, repr=False)
+    abort_wake_word_detection: bool = field(init=False, default=False)
+    debug_recording_thread: Thread | None = ...
+    debug_recording_queue: Queue[str | bytes | None] | None = ...
+    audio_enhancer: AudioEnhancer | None = ...
+    audio_chunking_buffer: AudioBuffer = field(default_factory=Incomplete)
+    _device_id: str | None = ...
+    _conversation_data: PipelineConversationData | None = ...
+    _intent_agent_only = ...
+    def __post_init__(self) -> None: ...
+    def __eq__(self, other: object) -> bool: ...
+    @callback
+    def process_event(self, event: PipelineEvent) -> None: ...
+    def start(self, conversation_id: str, device_id: str | None) -> None: ...
+    async def end(self) -> None: ...
+    async def prepare_wake_word_detection(self) -> None: ...
+    async def wake_word_detection(self, stream: AsyncIterable[EnhancedAudioChunk], audio_chunks_for_stt: list[EnhancedAudioChunk]) -> wake_word.DetectionResult | None: ...
+    async def _wake_word_audio_stream(self, audio_stream: AsyncIterable[EnhancedAudioChunk], stt_audio_buffer: deque[EnhancedAudioChunk] | None, wake_word_vad: VoiceActivityTimeout | None, sample_rate: int = ..., sample_width: int = ...) -> AsyncIterable[tuple[bytes, int]]: ...
+    async def prepare_speech_to_text(self, metadata: stt.SpeechMetadata) -> None: ...
+    async def speech_to_text(self, metadata: stt.SpeechMetadata, stream: AsyncIterable[EnhancedAudioChunk]) -> str: ...
+    async def _speech_to_text_stream(self, audio_stream: AsyncIterable[EnhancedAudioChunk], stt_vad: VoiceCommandSegmenter | None, sample_rate: int = ..., sample_width: int = ...) -> AsyncGenerator[bytes]: ...
+    async def prepare_recognize_intent(self, session: chat_session.ChatSession) -> None: ...
+    async def recognize_intent(self, intent_input: str, conversation_id: str, device_id: str | None, conversation_extra_system_prompt: str | None) -> str: ...
+    async def prepare_text_to_speech(self) -> None: ...
+    async def text_to_speech(self, tts_input: str) -> None: ...
+    def _capture_chunk(self, audio_bytes: bytes | None) -> None: ...
+    def _start_debug_recording_thread(self) -> None: ...
+    async def _stop_debug_recording_thread(self) -> None: ...
+    async def process_volume_only(self, audio_stream: AsyncIterable[bytes]) -> AsyncGenerator[EnhancedAudioChunk]: ...
+    async def process_enhance_audio(self, audio_stream: AsyncIterable[bytes]) -> AsyncGenerator[EnhancedAudioChunk]: ...
+
+def _multiply_volume(chunk: bytes, volume_multiplier: float) -> bytes: ...
+def _pipeline_debug_recording_thread_proc(run_recording_dir: Path, queue: Queue[str | bytes | None], message_timeout: float = 5) -> None: ...
+
+@dataclass(kw_only=True)
+class PipelineInput:
+    run: PipelineRun
+    session: chat_session.ChatSession
+    stt_metadata: stt.SpeechMetadata | None = ...
+    stt_stream: AsyncIterable[bytes] | None = ...
+    wake_word_phrase: str | None = ...
+    intent_input: str | None = ...
+    tts_input: str | None = ...
+    conversation_extra_system_prompt: str | None = ...
+    device_id: str | None = ...
+    async def execute(self) -> None: ...
+    async def validate(self) -> None: ...
+
+class PipelinePreferred(CollectionError):
+    item_id: Incomplete
+    def __init__(self, item_id: str) -> None: ...
+
+class SerializedPipelineStorageCollection(SerializedStorageCollection):
+    preferred_item: str
+
+class PipelineStorageCollection(StorageCollection[Pipeline, SerializedPipelineStorageCollection]):
+    _preferred_item: str
+    async def _async_load_data(self) -> SerializedPipelineStorageCollection | None: ...
+    async def _process_create_data(self, data: dict) -> dict: ...
+    @callback
+    def _get_suggested_id(self, info: dict) -> str: ...
+    async def _update_data(self, item: Pipeline, update_data: dict) -> Pipeline: ...
+    def _create_item(self, item_id: str, data: dict) -> Pipeline: ...
+    def _deserialize_item(self, data: dict) -> Pipeline: ...
+    def _serialize_item(self, item_id: str, item: Pipeline) -> dict: ...
+    async def async_delete_item(self, item_id: str) -> None: ...
+    @callback
+    def async_get_preferred_item(self) -> str: ...
+    @callback
+    def async_set_preferred_item(self, item_id: str) -> None: ...
+    @callback
+    def _data_to_save(self) -> SerializedPipelineStorageCollection: ...
+
+class PipelineStorageCollectionWebsocket(StorageCollectionWebsocket[PipelineStorageCollection]):
+    @callback
+    def async_setup(self, hass: HomeAssistant) -> None: ...
+    async def ws_delete_item(self, hass: HomeAssistant, connection: websocket_api.ActiveConnection, msg: dict) -> None: ...
+    @callback
+    def ws_get_item(self, hass: HomeAssistant, connection: websocket_api.ActiveConnection, msg: dict) -> None: ...
+    @callback
+    def ws_list_item(self, hass: HomeAssistant, connection: websocket_api.ActiveConnection, msg: dict) -> None: ...
+    async def ws_set_preferred_item(self, hass: HomeAssistant, connection: websocket_api.ActiveConnection, msg: dict[str, Any]) -> None: ...
+
+class PipelineRuns:
+    _pipeline_runs: dict[str, dict[str, PipelineRun]]
+    _pipeline_store: Incomplete
+    def __init__(self, pipeline_store: PipelineStorageCollection) -> None: ...
+    def add_run(self, pipeline_run: PipelineRun) -> None: ...
+    def remove_run(self, pipeline_run: PipelineRun) -> None: ...
+    async def _change_listener(self, change_type: str, item_id: str, change: dict) -> None: ...
+
+@dataclass(slots=True)
+class DeviceAudioQueue:
+    queue: asyncio.Queue[bytes | None]
+    id: str = field(default_factory=ulid_util.ulid_now)
+    overflow: bool = ...
+
+@dataclass(slots=True)
+class AssistDevice:
+    domain: str
+    unique_id_prefix: str
+
+class PipelineData:
+    pipeline_store: Incomplete
+    pipeline_debug: dict[str, LimitedSizeDict[str, PipelineRunDebug]]
+    pipeline_devices: dict[str, AssistDevice]
+    pipeline_runs: Incomplete
+    device_audio_queues: dict[str, DeviceAudioQueue]
+    def __init__(self, pipeline_store: PipelineStorageCollection) -> None: ...
+
+@dataclass(slots=True)
+class PipelineRunDebug:
+    events: list[PipelineEvent] = field(default_factory=list, init=False)
+    timestamp: str = field(default_factory=Incomplete, init=False)
+
+class PipelineStore(Store[SerializedPipelineStorageCollection]):
+    async def _async_migrate_func(self, old_major_version: int, old_minor_version: int, old_data: SerializedPipelineStorageCollection) -> SerializedPipelineStorageCollection: ...
+
+async def async_setup_pipeline_store(hass: HomeAssistant) -> PipelineData: ...
+@callback
+def async_migrate_engine(hass: HomeAssistant, engine_type: Literal['conversation', 'stt', 'tts', 'wake_word'], old_value: str, new_value: str) -> None: ...
+async def async_run_migrations(hass: HomeAssistant) -> None: ...
+
+@dataclass
+class PipelineConversationData:
+    continue_conversation_agent: str | None = ...
+
+@callback
+def async_get_pipeline_conversation_data(hass: HomeAssistant, session: chat_session.ChatSession) -> PipelineConversationData: ...

homeassistant_stubs-2025.4.0/homeassistant-stubs/components/assist_satellite/const.pyi

@@ -0,0 +1,16 @@
+import asyncio
+from .entity import AssistSatelliteEntity as AssistSatelliteEntity
+from _typeshed import Incomplete
+from enum import IntFlag
+from homeassistant.helpers.entity_component import EntityComponent as EntityComponent
+from homeassistant.util.hass_dict import HassKey as HassKey
+
+DOMAIN: str
+DATA_COMPONENT: HassKey[EntityComponent[AssistSatelliteEntity]]
+CONNECTION_TEST_DATA: HassKey[dict[str, asyncio.Event]]
+PREANNOUNCE_FILENAME: str
+PREANNOUNCE_URL: Incomplete
+
+class AssistSatelliteEntityFeature(IntFlag):
+    ANNOUNCE = 1
+    START_CONVERSATION = 2