schema_config_entry_flow.py

Go to the documentation of this file.

"""Helpers for creating schema based data entry flows."""
 
from __future__ import annotations
 
from abc import ABC, abstractmethod
from collections.abc import Callable, Container, Coroutine, Mapping
import copy
from dataclasses import dataclass
import types
from typing import Any, cast
 
import voluptuous as vol
 
from homeassistant.config_entries import (
    ConfigEntry,
    ConfigFlow,
    ConfigFlowResult,
    OptionsFlow,
)
from homeassistant.core import HomeAssistant, callback, split_entity_id
from homeassistant.data_entry_flow import UnknownHandler
 
from . import entity_registry as er, selector
from .typing import UNDEFINED, UndefinedType
 
 
class SchemaFlowError(Exception):
    """Validation failed."""
 
 
@dataclass
class SchemaFlowStep:
    """Define a config or options flow step."""
 
 
@dataclass(slots=True)
class SchemaFlowFormStep(SchemaFlowStep):
    """Define a config or options flow form step."""
 
    schema: (
        vol.Schema
        | Callable[[SchemaCommonFlowHandler], Coroutine[Any, Any, vol.Schema | None]]
        | None
    ) = None
    """Optional voluptuous schema, or function which returns a schema or None, for
    requesting and validating user input.
 
    - If a function is specified, the function will be passed the current
    `SchemaCommonFlowHandler`.
    - If schema validation fails, the step will be retried. If the schema is None, no
    user input is requested.
    """
 
    validate_user_input: (
        Callable[
            [SchemaCommonFlowHandler, dict[str, Any]],
            Coroutine[Any, Any, dict[str, Any]],
        ]
        | None
    ) = None
    """Optional function to validate user input.
 
    - The `validate_user_input` function is called if the schema validates successfully.
    - The first argument is a reference to the current `SchemaCommonFlowHandler`.
    - The second argument is the user input from the current step.
    - The `validate_user_input` should raise `SchemaFlowError` if user input is invalid.
    """
 
    next_step: (
        Callable[[dict[str, Any]], Coroutine[Any, Any, str | None]] | str | None
    ) = None
    """Optional property to identify next step.
 
    - If `next_step` is a function, it is called if the schema validates successfully or
      if no schema is defined. The `next_step` function is passed the union of
      config entry options and user input from previous steps. If the function returns
      None, the flow is ended with `FlowResultType.CREATE_ENTRY`.
    - If `next_step` is None, the flow is ended with `FlowResultType.CREATE_ENTRY`.
    """
 
    suggested_values: (
        Callable[[SchemaCommonFlowHandler], Coroutine[Any, Any, dict[str, Any]]]
        | None
        | UndefinedType
    ) = UNDEFINED
    """Optional property to populate suggested values.
 
    - If `suggested_values` is UNDEFINED, each key in the schema will get a suggested
      value from an option with the same key.
 
    Note: if a step is retried due to a validation failure, then the user input will
    have priority over the suggested values.
    """
 
    preview: str | None = None
    """Optional preview component."""
 
 
@dataclass(slots=True)
class SchemaFlowMenuStep(SchemaFlowStep):
    """Define a config or options flow menu step."""
 
    # Menu options
    options: Container[str]
 
 
class SchemaCommonFlowHandler:
    """Handle a schema based config or options flow."""
 
    def __init__(
        self,
        handler: SchemaConfigFlowHandler | SchemaOptionsFlowHandler,
        flow: Mapping[str, SchemaFlowStep],
        options: dict[str, Any] | None,
    ) -> None:
        """Initialize a common handler."""
        self._flow_flow = flow
        self._handler_handler = handler
        self._options_options = options if options is not None else {}
        self._flow_state: dict[str, Any] = {}
 
    @property
    def parent_handler(self) -> SchemaConfigFlowHandler | SchemaOptionsFlowHandler:
        """Return parent handler."""
        return self._handler_handler
 
    @property
    def options(self) -> dict[str, Any]:
        """Return the options linked to the current flow handler."""
        return self._options_options
 
    @property
    def flow_state(self) -> dict[str, Any]:
        """Return the flow state, used to store temporary data.
 
        It can be used for example to store the key or the index of a sub-item
        that will be edited in the next step.
        """
        return self._flow_state
 
    async def async_step(
        self, step_id: str, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Handle a step."""
        if isinstance(self._flow_flow[step_id], SchemaFlowFormStep):
            return await self._async_form_step_async_form_step(step_id, user_input)
        return await self._async_menu_step_async_menu_step(step_id, user_input)
 
    async def _get_schema(self, form_step: SchemaFlowFormStep) -> vol.Schema | None:
        if form_step.schema is None:
            return None
        if isinstance(form_step.schema, vol.Schema):
            return form_step.schema
        return await form_step.schema(self)
 
    async def _async_form_step(
        self, step_id: str, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Handle a form step."""
        form_step: SchemaFlowFormStep = cast(SchemaFlowFormStep, self._flow_flow[step_id])
 
        if (
            user_input is not None
            and (data_schema := await self._get_schema_get_schema(form_step))
            and data_schema.schema
            and not self._handler_handler.show_advanced_options
        ):
            # Add advanced field default if not set
            for key in data_schema.schema:
                if isinstance(key, (vol.Optional, vol.Required)):
                    if (
                        key.description
                        and key.description.get("advanced")
                        and key.default is not vol.UNDEFINED
                        and key not in self._options_options
                    ):
                        user_input[str(key.schema)] = cast(
                            Callable[[], Any], key.default
                        )()
 
        if user_input is not None and form_step.validate_user_input is not None:
            # Do extra validation of user input
            try:
                user_input = await form_step.validate_user_input(self, user_input)
            except SchemaFlowError as exc:
                return await self._show_next_step_show_next_step(step_id, exc, user_input)
 
        if user_input is not None:
            # User input was validated successfully, update options
            self._update_and_remove_omitted_optional_keys_update_and_remove_omitted_optional_keys(
                self._options_options, user_input, data_schema
            )
 
        if user_input is not None or form_step.schema is None:
            return await self._show_next_step_or_create_entry_show_next_step_or_create_entry(form_step)
 
        return await self._show_next_step_show_next_step(step_id)
 
    def _update_and_remove_omitted_optional_keys(
        self,
        values: dict[str, Any],
        user_input: dict[str, Any],
        data_schema: vol.Schema | None,
    ) -> None:
        values.update(user_input)
        if data_schema and data_schema.schema:
            for key in data_schema.schema:
                if (
                    isinstance(key, vol.Optional)
                    and key not in user_input
                    and not (
                        # don't remove advanced keys, if they are hidden
                        key.description
                        and key.description.get("advanced")
                        and not self._handler_handler.show_advanced_options
                    )
                ):
                    # Key not present, delete keys old value (if present) too
                    values.pop(key.schema, None)
 
    async def _show_next_step_or_create_entry(
        self, form_step: SchemaFlowFormStep
    ) -> ConfigFlowResult:
        next_step_id_or_end_flow: str | None
 
        if callable(form_step.next_step):
            next_step_id_or_end_flow = await form_step.next_step(self._options_options)
        else:
            next_step_id_or_end_flow = form_step.next_step
 
        if next_step_id_or_end_flow is None:
            # Flow done, create entry or update config entry options
            return self._handler_handler.async_create_entry(data=self._options_options)
        return await self._show_next_step_show_next_step(next_step_id_or_end_flow)
 
    async def _show_next_step(
        self,
        next_step_id: str,
        error: SchemaFlowError | None = None,
        user_input: dict[str, Any] | None = None,
    ) -> ConfigFlowResult:
        """Show form for next step."""
        if isinstance(self._flow_flow[next_step_id], SchemaFlowMenuStep):
            menu_step = cast(SchemaFlowMenuStep, self._flow_flow[next_step_id])
            return self._handler_handler.async_show_menu(
                step_id=next_step_id,
                menu_options=menu_step.options,
            )
 
        form_step = cast(SchemaFlowFormStep, self._flow_flow[next_step_id])
 
        if (data_schema := await self._get_schema_get_schema(form_step)) is None:
            return await self._show_next_step_or_create_entry_show_next_step_or_create_entry(form_step)
 
        suggested_values: dict[str, Any] = {}
        if form_step.suggested_values is UNDEFINED:
            suggested_values = self._options_options
        elif form_step.suggested_values:
            suggested_values = await form_step.suggested_values(self)
 
        if user_input:
            # We don't want to mutate the existing options
            suggested_values = copy.deepcopy(suggested_values)
            self._update_and_remove_omitted_optional_keys_update_and_remove_omitted_optional_keys(
                suggested_values, user_input, await self._get_schema_get_schema(form_step)
            )
 
        if data_schema.schema:
            # Make a copy of the schema with suggested values set to saved options
            data_schema = self._handler_handler.add_suggested_values_to_schema(
                data_schema, suggested_values
            )
 
        errors = {"base": str(error)} if error else None
 
        # Show form for next step
        last_step = None
        if not callable(form_step.next_step):
            last_step = form_step.next_step is None
        return self._handler_handler.async_show_form(
            step_id=next_step_id,
            data_schema=data_schema,
            errors=errors,
            last_step=last_step,
            preview=form_step.preview,
        )
 
    async def _async_menu_step(
        self, step_id: str, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Handle a menu step."""
        menu_step: SchemaFlowMenuStep = cast(SchemaFlowMenuStep, self._flow_flow[step_id])
        return self._handler_handler.async_show_menu(
            step_id=step_id,
            menu_options=menu_step.options,
        )
 
 
class SchemaConfigFlowHandler(ConfigFlow, ABC):
    """Handle a schema based config flow."""
 
    config_flow: Mapping[str, SchemaFlowStep]
    options_flow: Mapping[str, SchemaFlowStep] | None = None
 
    VERSION = 1
 
    def __init_subclass__(cls, **kwargs: Any) -> None:
        """Initialize a subclass."""
        super().__init_subclass__(**kwargs)
 
        @callback
        def _async_get_options_flow(
            config_entry: ConfigEntry,
        ) -> OptionsFlow:
            """Get the options flow for this handler."""
            if cls.options_flow is None:
                raise UnknownHandler
 
            return SchemaOptionsFlowHandler(
                config_entry,
                cls.options_flow,
                cls.async_options_flow_finishedasync_options_flow_finished,
                cls.async_setup_previewasync_setup_previewasync_setup_preview,
            )
 
        # Create an async_get_options_flow method
        cls.async_get_options_flowasync_get_options_flowasync_get_options_flow = _async_get_options_flow  # type: ignore[method-assign]
 
        # Create flow step methods for each step defined in the flow schema
        for step in cls.config_flow:
            setattr(cls, f"async_step_{step}", cls._async_step_async_step(step))
 
    def __init__(self) -> None:
        """Initialize config flow."""
        self._common_handler_common_handler = SchemaCommonFlowHandler(self, self.config_flow, None)
 
    @staticmethod
    async def async_setup_preview(hass: HomeAssistant) -> None:
        """Set up preview."""
 
    @classmethod
    @callback
    def async_supports_options_flow(cls, config_entry: ConfigEntry) -> bool:
        """Return options flow support for this handler."""
        return cls.options_flow is not None
 
    @staticmethod
    def _async_step(
        step_id: str,
    ) -> Callable[
        [SchemaConfigFlowHandler, dict[str, Any] | None],
        Coroutine[Any, Any, ConfigFlowResult],
    ]:
        """Generate a step handler."""
 
        async def _async_step(
            self: SchemaConfigFlowHandler, user_input: dict[str, Any] | None = None
        ) -> ConfigFlowResult:
            """Handle a config flow step."""
            return await self._common_handler_common_handler.async_step(step_id, user_input)
 
        return _async_step
 
    @abstractmethod
    @callback
    def async_config_entry_title(self, options: Mapping[str, Any]) -> str:
        """Return config entry title.
 
        The options parameter contains config entry options, which is the union of user
        input from the config flow steps.
        """
 
    @callback
    def async_config_flow_finished(self, options: Mapping[str, Any]) -> None:
        """Take necessary actions after the config flow is finished, if needed.
 
        The options parameter contains config entry options, which is the union of user
        input from the config flow steps.
        """
 
    @callback
    @staticmethod
    def async_options_flow_finished(
        hass: HomeAssistant, options: Mapping[str, Any]
    ) -> None:
        """Take necessary actions after the options flow is finished, if needed.
 
        The options parameter contains config entry options, which is the union of
        stored options and user input from the options flow steps.
        """
 
    @callback
    def async_create_entry(
        self,
        data: Mapping[str, Any],
        **kwargs: Any,
    ) -> ConfigFlowResult:
        """Finish config flow and create a config entry."""
        self.async_config_flow_finishedasync_config_flow_finished(data)
        return super().async_create_entry(
            data={}, options=data, title=self.async_config_entry_titleasync_config_entry_title(data), **kwargs
        )
 
 
class SchemaOptionsFlowHandler(OptionsFlow):
    """Handle a schema based options flow."""
 
    def __init__(
        self,
        config_entry: ConfigEntry,
        options_flow: Mapping[str, SchemaFlowStep],
        async_options_flow_finished: Callable[[HomeAssistant, Mapping[str, Any]], None]
        | None = None,
        async_setup_preview: Callable[[HomeAssistant], Coroutine[Any, Any, None]]
        | None = None,
    ) -> None:
        """Initialize options flow.
 
        If needed, `async_options_flow_finished` can be set to take necessary actions
        after the options flow is finished. The second parameter contains config entry
        options, which is the union of stored options and user input from the options
        flow steps.
        """
        self._options_options = copy.deepcopy(dict(config_entry.options))
        self._common_handler_common_handler = SchemaCommonFlowHandler(self, options_flow, self.optionsoptions)
        self._async_options_flow_finished_async_options_flow_finished = async_options_flow_finished
 
        for step in options_flow:
            setattr(
                self,
                f"async_step_{step}",
                types.MethodType(self._async_step_async_step(step), self),
            )
 
        if async_setup_preview:
            setattr(self, "async_setup_preview", async_setup_preview)
 
    @property
    def options(self) -> dict[str, Any]:
        """Return a mutable copy of the config entry options."""
        return self._options_options
 
    @staticmethod
    def _async_step(
        step_id: str,
    ) -> Callable[
        [SchemaConfigFlowHandler, dict[str, Any] | None],
        Coroutine[Any, Any, ConfigFlowResult],
    ]:
        """Generate a step handler."""
 
        async def _async_step(
            self: SchemaConfigFlowHandler, user_input: dict[str, Any] | None = None
        ) -> ConfigFlowResult:
            """Handle an options flow step."""
            return await self._common_handler_common_handler.async_step(step_id, user_input)
 
        return _async_step
 
    @callback
    def async_create_entry(
        self,
        data: Mapping[str, Any],
        **kwargs: Any,
    ) -> ConfigFlowResult:
        """Finish config flow and create a config entry."""
        if self._async_options_flow_finished_async_options_flow_finished:
            self._async_options_flow_finished_async_options_flow_finished(self.hass, data)
        return super().async_create_entry(data=data, **kwargs)
 
 
@callback
def wrapped_entity_config_entry_title(
    hass: HomeAssistant, entity_id_or_uuid: str
) -> str:
    """Generate title for a config entry wrapping a single entity.
 
    If the entity is registered, use the registry entry's name.
    If the entity is in the state machine, use the name from the state.
    Otherwise, fall back to the object ID.
    """
    registry = er.async_get(hass)
    entity_id = er.async_validate_entity_id(registry, entity_id_or_uuid)
    object_id = split_entity_id(entity_id)[1]
    entry = registry.async_get(entity_id)
    if entry:
        return entry.name or entry.original_name or object_id
    state = hass.states.get(entity_id)
    if state:
        return state.name or object_id
    return object_id
 
 
@callback
def entity_selector_without_own_entities(
    handler: SchemaOptionsFlowHandler,
    entity_selector_config: selector.EntitySelectorConfig,
) -> selector.EntitySelector:
    """Return an entity selector which excludes own entities."""
    entity_registry = er.async_get(handler.hass)
    entities = er.async_entries_for_config_entry(
        entity_registry,
        handler.config_entry.entry_id,
    )
    entity_ids = [ent.entity_id for ent in entities]
 
    final_selector_config = entity_selector_config.copy()
    final_selector_config["exclude_entities"] = entity_ids
 
    return selector.EntitySelector(final_selector_config)