Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow to configure the IQVIA component."""
2 
3 from __future__ import annotations
4 
5 from typing import Any
6 
7 from pyiqvia import Client
8 from pyiqvia.errors import InvalidZipError
9 import voluptuous as vol
10 
11 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
12 from homeassistant.helpers import aiohttp_client
13 
14 from .const import CONF_ZIP_CODE, DOMAIN
15 
16 
17 class IqviaConfigFlow(ConfigFlow, domain=DOMAIN):
18  """Handle an IQVIA config flow."""
19 
20  VERSION = 1
21 
22  def __init__(self) -> None:
23  """Initialize the config flow."""
24  self.data_schemadata_schema = vol.Schema({vol.Required(CONF_ZIP_CODE): str})
25 
26  async def async_step_user(
27  self, user_input: dict[str, Any] | None = None
28  ) -> ConfigFlowResult:
29  """Handle the start of the config flow."""
30  if not user_input:
31  return self.async_show_formasync_show_formasync_show_form(step_id="user", data_schema=self.data_schemadata_schema)
32 
33  await self.async_set_unique_idasync_set_unique_id(user_input[CONF_ZIP_CODE])
34  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
35 
36  websession = aiohttp_client.async_get_clientsession(self.hass)
37 
38  try:
39  Client(user_input[CONF_ZIP_CODE], session=websession)
40  except InvalidZipError:
41  return self.async_show_formasync_show_formasync_show_form(
42  step_id="user",
43  data_schema=self.data_schemadata_schema,
44  errors={CONF_ZIP_CODE: "invalid_zip_code"},
45  )
46 
47  return self.async_create_entryasync_create_entryasync_create_entry(title=user_input[CONF_ZIP_CODE], data=user_input)
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)