Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for IMGW-PIB integration."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any
7 
8 from aiohttp import ClientError
9 from imgw_pib import ImgwPib
10 from imgw_pib.exceptions import ApiError
11 import voluptuous as vol
12 
13 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
14 from homeassistant.helpers.aiohttp_client import async_get_clientsession
16  SelectOptionDict,
17  SelectSelector,
18  SelectSelectorConfig,
19  SelectSelectorMode,
20 )
21 
22 from .const import CONF_STATION_ID, DOMAIN
23 
24 _LOGGER = logging.getLogger(__name__)
25 
26 
27 class ImgwPibFlowHandler(ConfigFlow, domain=DOMAIN):
28  """Handle a config flow for IMGW-PIB."""
29 
30  VERSION = 1
31 
32  async def async_step_user(
33  self, user_input: dict[str, Any] | None = None
34  ) -> ConfigFlowResult:
35  """Handle the initial step."""
36  errors: dict[str, str] = {}
37 
38  client_session = async_get_clientsession(self.hass)
39 
40  if user_input is not None:
41  station_id = user_input[CONF_STATION_ID]
42 
43  await self.async_set_unique_idasync_set_unique_id(station_id, raise_on_progress=False)
44  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
45 
46  try:
47  imgwpib = await ImgwPib.create(
48  client_session, hydrological_station_id=station_id
49  )
50  hydrological_data = await imgwpib.get_hydrological_data()
51  except (ClientError, TimeoutError, ApiError):
52  errors["base"] = "cannot_connect"
53  except Exception: # pylint: disable=broad-except
54  _LOGGER.exception("Unexpected exception")
55  errors["base"] = "unknown"
56  else:
57  title = f"{hydrological_data.river} ({hydrological_data.station})"
58  return self.async_create_entryasync_create_entryasync_create_entry(title=title, data=user_input)
59 
60  try:
61  imgwpib = await ImgwPib.create(client_session)
62  await imgwpib.update_hydrological_stations()
63  except (ClientError, TimeoutError, ApiError):
64  return self.async_abortasync_abortasync_abort(reason="cannot_connect")
65 
66  options: list[SelectOptionDict] = [
67  SelectOptionDict(value=station_id, label=station_name)
68  for station_id, station_name in imgwpib.hydrological_stations.items()
69  ]
70 
71  schema: vol.Schema = vol.Schema(
72  {
73  vol.Required(CONF_STATION_ID): SelectSelector(
75  options=options,
76  multiple=False,
77  sort=True,
78  mode=SelectSelectorMode.DROPDOWN,
79  ),
80  )
81  }
82  )
83 
84  return self.async_show_formasync_show_formasync_show_form(step_id="user", data_schema=schema, errors=errors)
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:34
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_abort(self, *str reason, Mapping[str, str]|None description_placeholders=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)
_FlowResultT async_abort(self, *str reason, Mapping[str, str]|None description_placeholders=None)
aiohttp.ClientSession async_get_clientsession(HomeAssistant hass, bool verify_ssl=True, socket.AddressFamily family=socket.AF_UNSPEC, ssl_util.SSLCipherList ssl_cipher=ssl_util.SSLCipherList.PYTHON_DEFAULT)