Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Weheat."""
2 
3 from collections.abc import Mapping
4 import logging
5 from typing import Any
6 
7 from weheat.abstractions.user import get_user_id_from_token
8 
9 from homeassistant.config_entries import SOURCE_REAUTH, ConfigFlowResult
10 from homeassistant.const import CONF_ACCESS_TOKEN, CONF_TOKEN
11 from homeassistant.helpers.config_entry_oauth2_flow import AbstractOAuth2FlowHandler
12 
13 from .const import API_URL, DOMAIN, ENTRY_TITLE, OAUTH2_SCOPES
14 
15 
17  """Config flow to handle Weheat OAuth2 authentication."""
18 
19  DOMAIN = DOMAIN
20 
21  @property
22  def logger(self) -> logging.Logger:
23  """Return logger."""
24  return logging.getLogger(__name__)
25 
26  @property
27  def extra_authorize_data(self) -> dict[str, str]:
28  """Extra data that needs to be appended to the authorize url."""
29  return {
30  "scope": " ".join(OAUTH2_SCOPES),
31  }
32 
33  async def async_oauth_create_entry(self, data: dict) -> ConfigFlowResult:
34  """Override the create entry method to change to the step to find the heat pumps."""
35  # get the user id and use that as unique id for this entry
36  user_id = await get_user_id_from_token(
37  API_URL, data[CONF_TOKEN][CONF_ACCESS_TOKEN]
38  )
39  await self.async_set_unique_idasync_set_unique_id(user_id)
40  if self.sourcesourcesource != SOURCE_REAUTH:
41  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
42 
43  return self.async_create_entryasync_create_entryasync_create_entry(title=ENTRY_TITLE, data=data)
44 
45  self._abort_if_unique_id_mismatch_abort_if_unique_id_mismatch(reason="wrong_account")
46  return self.async_update_reload_and_abortasync_update_reload_and_abort(
47  self._get_reauth_entry_get_reauth_entry(), data_updates=data
48  )
49 
50  async def async_step_reauth(
51  self, entry_data: Mapping[str, Any]
52  ) -> ConfigFlowResult:
53  """Perform reauth upon an API authentication error."""
54  return await self.async_step_reauth_confirmasync_step_reauth_confirm()
55 
57  self, user_input: dict[str, Any] | None = None
58  ) -> ConfigFlowResult:
59  """Confirm reauth dialog."""
60  if user_input is None:
61  return self.async_show_formasync_show_formasync_show_form(step_id="reauth_confirm")
62  return await self.async_step_userasync_step_userasync_step_user()
ConfigFlowResult async_step_reauth_confirm(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:58
ConfigFlowResult async_oauth_create_entry(self, dict data)
Definition: config_flow.py:33
ConfigFlowResult async_step_reauth(self, Mapping[str, Any] entry_data)
Definition: config_flow.py:52
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_step_user(self, dict[str, Any]|None user_input=None)
None _abort_if_unique_id_mismatch(self, *str reason="unique_id_mismatch", 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)
str|None source(self)
config_entries.ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)