Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for AfterShip integration."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any
7 
8 from pyaftership import AfterShip, AfterShipException
9 import voluptuous as vol
10 
11 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
12 from homeassistant.const import CONF_API_KEY
13 from homeassistant.helpers.aiohttp_client import async_get_clientsession
14 
15 from .const import DOMAIN
16 
17 _LOGGER = logging.getLogger(__name__)
18 
19 
20 class AfterShipConfigFlow(ConfigFlow, domain=DOMAIN):
21  """Handle a config flow for AfterShip."""
22 
23  VERSION = 1
24 
25  async def async_step_user(
26  self, user_input: dict[str, Any] | None = None
27  ) -> ConfigFlowResult:
28  """Handle the initial step."""
29  errors: dict[str, str] = {}
30  if user_input is not None:
31  self._async_abort_entries_match_async_abort_entries_match({CONF_API_KEY: user_input[CONF_API_KEY]})
32  try:
33  aftership = AfterShip(
34  api_key=user_input[CONF_API_KEY],
35  session=async_get_clientsession(self.hass),
36  )
37  await aftership.trackings.list()
38  except AfterShipException:
39  _LOGGER.exception("Aftership raised exception")
40  errors["base"] = "cannot_connect"
41  else:
42  return self.async_create_entryasync_create_entryasync_create_entry(title="AfterShip", data=user_input)
43 
44  return self.async_show_formasync_show_formasync_show_form(
45  step_id="user",
46  data_schema=vol.Schema({vol.Required(CONF_API_KEY): str}),
47  errors=errors,
48  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:27
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)
None _async_abort_entries_match(self, dict[str, Any]|None match_dict=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)