Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Hong Kong Observatory integration."""
2 
3 from __future__ import annotations
4 
5 from asyncio import timeout
6 from typing import Any
7 
8 from hko import HKO, LOCATIONS, HKOError
9 import voluptuous as vol
10 
11 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
12 from homeassistant.const import CONF_LOCATION
13 from homeassistant.helpers.aiohttp_client import async_get_clientsession
14 from homeassistant.helpers.selector import SelectSelector, SelectSelectorConfig
15 
16 from .const import API_RHRREAD, DEFAULT_LOCATION, DOMAIN, KEY_LOCATION
17 
18 
19 def get_loc_name(item):
20  """Return an array of supported locations."""
21  return item[KEY_LOCATION]
22 
23 
24 STEP_USER_DATA_SCHEMA = vol.Schema(
25  {
26  vol.Required(CONF_LOCATION, default=DEFAULT_LOCATION): SelectSelector(
27  SelectSelectorConfig(options=list(map(get_loc_name, LOCATIONS)), sort=True)
28  )
29  }
30 )
31 
32 
33 class HKOConfigFlow(ConfigFlow, domain=DOMAIN):
34  """Handle a config flow for Hong Kong Observatory."""
35 
36  VERSION = 1
37 
38  async def async_step_user(
39  self, user_input: dict[str, Any] | None = None
40  ) -> ConfigFlowResult:
41  """Handle the initial step."""
42  if user_input is None:
43  return self.async_show_formasync_show_formasync_show_form(
44  step_id="user", data_schema=STEP_USER_DATA_SCHEMA
45  )
46 
47  errors = {}
48 
49  try:
50  websession = async_get_clientsession(self.hass)
51  hko = HKO(websession)
52  async with timeout(60):
53  await hko.weather(API_RHRREAD)
54 
55  except HKOError:
56  errors["base"] = "cannot_connect"
57  except Exception: # noqa: BLE001
58  errors["base"] = "unknown"
59  else:
60  await self.async_set_unique_idasync_set_unique_id(
61  user_input[CONF_LOCATION], raise_on_progress=False
62  )
63  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
64  return self.async_create_entryasync_create_entryasync_create_entry(
65  title=user_input[CONF_LOCATION], data=user_input
66  )
67 
68  return self.async_show_formasync_show_formasync_show_form(
69  step_id="user", data_schema=STEP_USER_DATA_SCHEMA, errors=errors
70  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:40
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)
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)