Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Garages Amsterdam integration."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any
7 
8 from aiohttp import ClientResponseError
9 from odp_amsterdam import ODPAmsterdam, VehicleType
10 import voluptuous as vol
11 
12 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
13 from homeassistant.helpers import aiohttp_client
14 
15 from .const import DOMAIN
16 
17 _LOGGER = logging.getLogger(__name__)
18 
19 
20 class GaragesAmsterdamConfigFlow(ConfigFlow, domain=DOMAIN):
21  """Handle a config flow for Garages Amsterdam."""
22 
23  VERSION = 1
24  _options: list[str] | None = None
25 
26  async def async_step_user(
27  self, user_input: dict[str, Any] | None = None
28  ) -> ConfigFlowResult:
29  """Handle the initial step."""
30  if self._options_options is None:
31  self._options_options = []
32  try:
33  api_data = await ODPAmsterdam(
34  session=aiohttp_client.async_get_clientsession(self.hass)
35  ).all_garages(vehicle=VehicleType.CAR)
36  except ClientResponseError:
37  _LOGGER.error("Unexpected response from server")
38  return self.async_abortasync_abortasync_abort(reason="cannot_connect")
39  except Exception:
40  _LOGGER.exception("Unexpected exception")
41  return self.async_abortasync_abortasync_abort(reason="unknown")
42 
43  for garage in sorted(api_data, key=lambda garage: garage.garage_name):
44  self._options_options.append(garage.garage_name)
45 
46  if user_input is not None:
47  await self.async_set_unique_idasync_set_unique_id(user_input["garage_name"])
48  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
49  return self.async_create_entryasync_create_entryasync_create_entry(
50  title=user_input["garage_name"], data=user_input
51  )
52 
53  return self.async_show_formasync_show_formasync_show_form(
54  step_id="user",
55  data_schema=vol.Schema(
56  {vol.Required("garage_name"): vol.In(self._options_options)}
57  ),
58  )
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_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)