Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow to configure the Toon component."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any
7 
8 from toonapi import Agreement, Toon, ToonError
9 import voluptuous as vol
10 
11 from homeassistant.config_entries import ConfigFlowResult
12 from homeassistant.helpers.aiohttp_client import async_get_clientsession
13 from homeassistant.helpers.config_entry_oauth2_flow import AbstractOAuth2FlowHandler
14 
15 from .const import CONF_AGREEMENT, CONF_AGREEMENT_ID, CONF_MIGRATE, DOMAIN
16 
17 
19  """Handle a Toon config flow."""
20 
21  DOMAIN = DOMAIN
22  VERSION = 2
23 
24  agreements: list[Agreement]
25  data: dict[str, Any]
26  migrate_entry: str | None = None
27 
28  @property
29  def logger(self) -> logging.Logger:
30  """Return logger."""
31  return logging.getLogger(__name__)
32 
33  async def async_oauth_create_entry(self, data: dict[str, Any]) -> ConfigFlowResult:
34  """Test connection and load up agreements."""
35  self.datadata = data
36 
37  toon = Toon(
38  token=self.datadata["token"]["access_token"],
39  session=async_get_clientsession(self.hass),
40  )
41  try:
42  self.agreementsagreements = await toon.agreements()
43  except ToonError:
44  return self.async_abortasync_abortasync_abort(reason="connection_error")
45 
46  if not self.agreementsagreements:
47  return self.async_abortasync_abortasync_abort(reason="no_agreements")
48 
49  return await self.async_step_agreementasync_step_agreement()
50 
51  async def async_step_import(
52  self, import_data: dict[str, Any] | None
53  ) -> ConfigFlowResult:
54  """Start a configuration flow based on imported data.
55 
56  This step is merely here to trigger "discovery" when the `toon`
57  integration is listed in the user configuration, or when migrating from
58  the version 1 schema.
59  """
60 
61  if import_data is not None and CONF_MIGRATE in import_data:
62  self.migrate_entrymigrate_entry = import_data[CONF_MIGRATE]
63  else:
64  await self._async_handle_discovery_without_unique_id_async_handle_discovery_without_unique_id()
65 
66  return await self.async_step_userasync_step_userasync_step_user()
67 
69  self, user_input: dict[str, Any] | None = None
70  ) -> ConfigFlowResult:
71  """Select Toon agreement to add."""
72  if len(self.agreementsagreements) == 1:
73  return await self._create_entry_create_entry(self.agreementsagreements[0])
74 
75  agreements_list = [
76  f"{agreement.street} {agreement.house_number}, {agreement.city}"
77  for agreement in self.agreementsagreements
78  ]
79 
80  if user_input is None:
81  return self.async_show_formasync_show_formasync_show_form(
82  step_id="agreement",
83  data_schema=vol.Schema(
84  {vol.Required(CONF_AGREEMENT): vol.In(agreements_list)}
85  ),
86  )
87 
88  agreement_index = agreements_list.index(user_input[CONF_AGREEMENT])
89  return await self._create_entry_create_entry(self.agreementsagreements[agreement_index])
90 
91  async def _create_entry(self, agreement: Agreement) -> ConfigFlowResult:
92  if self.migrate_entrymigrate_entry:
93  await self.hass.config_entries.async_remove(self.migrate_entrymigrate_entry)
94 
95  await self.async_set_unique_idasync_set_unique_id(agreement.agreement_id)
96  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
97 
98  self.datadata[CONF_AGREEMENT_ID] = agreement.agreement_id
99  return self.async_create_entryasync_create_entryasync_create_entry(
100  title=f"{agreement.street} {agreement.house_number}, {agreement.city}",
101  data=self.datadata,
102  )
ConfigFlowResult _create_entry(self, Agreement agreement)
Definition: config_flow.py:91
ConfigFlowResult async_step_agreement(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:70
ConfigFlowResult async_step_import(self, dict[str, Any]|None import_data)
Definition: config_flow.py:53
ConfigFlowResult async_oauth_create_entry(self, dict[str, Any] data)
Definition: config_flow.py:33
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_step_user(self, dict[str, Any]|None user_input=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)
config_entries.ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=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)