Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Sure Petcare integration."""
2 
3 from __future__ import annotations
4 
5 from collections.abc import Mapping
6 import logging
7 from typing import Any
8 
9 import surepy
10 from surepy.exceptions import SurePetcareAuthenticationError, SurePetcareError
11 import voluptuous as vol
12 
13 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
14 from homeassistant.const import CONF_PASSWORD, CONF_TOKEN, CONF_USERNAME
15 from homeassistant.helpers.aiohttp_client import async_get_clientsession
16 
17 from .const import DOMAIN, SURE_API_TIMEOUT
18 
19 _LOGGER = logging.getLogger(__name__)
20 
21 USER_DATA_SCHEMA = vol.Schema(
22  {
23  vol.Required(CONF_USERNAME): str,
24  vol.Required(CONF_PASSWORD): str,
25  }
26 )
27 
28 
29 class SurePetCareConfigFlow(ConfigFlow, domain=DOMAIN):
30  """Handle a config flow for Sure Petcare."""
31 
32  VERSION = 1
33 
34  async def async_step_user(
35  self, user_input: dict[str, Any] | None = None
36  ) -> ConfigFlowResult:
37  """Handle the initial step."""
38  errors = {}
39  if user_input is not None:
40  client = surepy.Surepy(
41  user_input[CONF_USERNAME],
42  user_input[CONF_PASSWORD],
43  auth_token=None,
44  api_timeout=SURE_API_TIMEOUT,
45  session=async_get_clientsession(self.hass),
46  )
47  try:
48  token = await client.sac.get_token()
49  except SurePetcareAuthenticationError:
50  errors["base"] = "invalid_auth"
51  except SurePetcareError:
52  errors["base"] = "cannot_connect"
53  except Exception:
54  _LOGGER.exception("Unexpected exception")
55  errors["base"] = "unknown"
56  else:
57  await self.async_set_unique_idasync_set_unique_id(user_input[CONF_USERNAME].lower())
58  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
59 
60  return self.async_create_entryasync_create_entryasync_create_entry(
61  title="Sure Petcare",
62  data={**user_input, CONF_TOKEN: token},
63  )
64 
65  return self.async_show_formasync_show_formasync_show_form(
66  step_id="user", data_schema=USER_DATA_SCHEMA, errors=errors
67  )
68 
69  async def async_step_reauth(
70  self, entry_data: Mapping[str, Any]
71  ) -> ConfigFlowResult:
72  """Handle configuration by re-auth."""
73  return await self.async_step_reauth_confirmasync_step_reauth_confirm()
74 
76  self, user_input: dict[str, Any] | None = None
77  ) -> ConfigFlowResult:
78  """Dialog that informs the user that reauth is required."""
79  errors = {}
80  reauth_entry = self._get_reauth_entry_get_reauth_entry()
81  if user_input is not None:
82  client = surepy.Surepy(
83  reauth_entry.data[CONF_USERNAME],
84  user_input[CONF_PASSWORD],
85  auth_token=None,
86  api_timeout=SURE_API_TIMEOUT,
87  session=async_get_clientsession(self.hass),
88  )
89  try:
90  token = await client.sac.get_token()
91  except SurePetcareAuthenticationError:
92  errors["base"] = "invalid_auth"
93  except SurePetcareError:
94  errors["base"] = "cannot_connect"
95  except Exception:
96  _LOGGER.exception("Unexpected exception")
97  errors["base"] = "unknown"
98  else:
99  return self.async_update_reload_and_abortasync_update_reload_and_abort(
100  reauth_entry,
101  data_updates={
102  CONF_PASSWORD: user_input[CONF_PASSWORD],
103  CONF_TOKEN: token,
104  },
105  )
106 
107  return self.async_show_formasync_show_formasync_show_form(
108  step_id="reauth_confirm",
109  description_placeholders={"username": reauth_entry.data[CONF_USERNAME]},
110  data_schema=vol.Schema({vol.Required(CONF_PASSWORD): str}),
111  errors=errors,
112  )
ConfigFlowResult async_step_reauth(self, Mapping[str, Any] entry_data)
Definition: config_flow.py:71
ConfigFlowResult async_step_reauth_confirm(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:77
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:36
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_update_reload_and_abort(self, ConfigEntry entry, *str|None|UndefinedType unique_id=UNDEFINED, str|UndefinedType title=UNDEFINED, Mapping[str, Any]|UndefinedType data=UNDEFINED, Mapping[str, Any]|UndefinedType data_updates=UNDEFINED, Mapping[str, Any]|UndefinedType options=UNDEFINED, str|UndefinedType reason=UNDEFINED, bool reload_even_if_entry_is_unchanged=True)
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)