Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow to configure the Stookalert integration."""
2 
3 from __future__ import annotations
4 
5 from typing import Any
6 
7 import voluptuous as vol
8 
9 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
10 
11 from .const import CONF_PROVINCE, DOMAIN, PROVINCES
12 
13 
14 class StookalertFlowHandler(ConfigFlow, domain=DOMAIN):
15  """Config flow for Stookalert."""
16 
17  VERSION = 1
18 
19  async def async_step_user(
20  self, user_input: dict[str, Any] | None = None
21  ) -> ConfigFlowResult:
22  """Handle a flow initialized by the user."""
23  if user_input is not None:
24  await self.async_set_unique_idasync_set_unique_id(user_input[CONF_PROVINCE])
25  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
26  return self.async_create_entryasync_create_entryasync_create_entry(
27  title=user_input[CONF_PROVINCE], data=user_input
28  )
29 
30  return self.async_show_formasync_show_formasync_show_form(
31  step_id="user",
32  data_schema=vol.Schema({vol.Required(CONF_PROVINCE): vol.In(PROVINCES)}),
33  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:21
None _abort_if_unique_id_configured(self, dict[str, Any]|None updates=None, bool reload_on_update=True, *str error="already_configured")
ConfigEntry|None async_set_unique_id(self, str|None unique_id=None, *bool raise_on_progress=True)
ConfigFlowResult async_create_entry(self, *str title, Mapping[str, Any] data, str|None description=None, Mapping[str, str]|None description_placeholders=None, Mapping[str, Any]|None options=None)
ConfigFlowResult async_show_form(self, *str|None step_id=None, vol.Schema|None data_schema=None, dict[str, str]|None errors=None, Mapping[str, str]|None description_placeholders=None, bool|None last_step=None, str|None preview=None)
_FlowResultT async_show_form(self, *str|None step_id=None, vol.Schema|None data_schema=None, dict[str, str]|None errors=None, Mapping[str, str]|None description_placeholders=None, bool|None last_step=None, str|None preview=None)
_FlowResultT async_create_entry(self, *str|None title=None, Mapping[str, Any] data, str|None description=None, Mapping[str, str]|None description_placeholders=None)