Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for FAA Delays integration."""
2 
3 import logging
4 from typing import Any
5 
6 from aiohttp import ClientConnectionError
7 import faadelays
8 import voluptuous as vol
9 
10 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
11 from homeassistant.const import CONF_ID
12 from homeassistant.helpers import aiohttp_client
13 
14 from .const import DOMAIN
15 
16 _LOGGER = logging.getLogger(__name__)
17 
18 DATA_SCHEMA = vol.Schema({vol.Required(CONF_ID): str})
19 
20 
21 class FAADelaysConfigFlow(ConfigFlow, domain=DOMAIN):
22  """Handle a config flow for FAA Delays."""
23 
24  VERSION = 1
25 
26  async def async_step_user(
27  self, user_input: dict[str, Any] | None = None
28  ) -> ConfigFlowResult:
29  """Handle the initial step."""
30  errors = {}
31  if user_input is not None:
32  await self.async_set_unique_idasync_set_unique_id(user_input[CONF_ID])
33  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
34 
35  websession = aiohttp_client.async_get_clientsession(self.hass)
36 
37  data = faadelays.Airport(user_input[CONF_ID], websession)
38 
39  try:
40  await data.update()
41 
42  except ClientConnectionError:
43  _LOGGER.error("Error connecting to FAA API")
44  errors["base"] = "cannot_connect"
45 
46  except Exception:
47  _LOGGER.exception("Unexpected exception")
48  errors["base"] = "unknown"
49 
50  if not errors:
51  _LOGGER.debug(
52  "Creating entry with id: %s",
53  user_input[CONF_ID],
54  )
55  return self.async_create_entryasync_create_entryasync_create_entry(title=data.code, data=user_input)
56 
57  return self.async_show_formasync_show_formasync_show_form(
58  step_id="user", data_schema=DATA_SCHEMA, errors=errors
59  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:28
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)