Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for NYT Games."""
2 
3 from typing import Any
4 
5 from nyt_games import NYTGamesAuthenticationError, NYTGamesClient, NYTGamesError
6 import voluptuous as vol
7 
8 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
9 from homeassistant.const import CONF_TOKEN
10 from homeassistant.helpers.aiohttp_client import async_create_clientsession
11 
12 from .const import DOMAIN, LOGGER
13 
14 
15 class NYTGamesConfigFlow(ConfigFlow, domain=DOMAIN):
16  """NYT Games config flow."""
17 
18  async def async_step_user(
19  self, user_input: dict[str, Any] | None = None
20  ) -> ConfigFlowResult:
21  """Handle a flow initialized by the user."""
22  errors: dict[str, str] = {}
23  if user_input:
24  session = async_create_clientsession(self.hass)
25  token = user_input[CONF_TOKEN].strip()
26  client = NYTGamesClient(token, session=session)
27  try:
28  user_id = await client.get_user_id()
29  except NYTGamesAuthenticationError:
30  errors["base"] = "invalid_auth"
31  except NYTGamesError:
32  errors["base"] = "cannot_connect"
33  except Exception: # noqa: BLE001
34  LOGGER.exception("Unexpected error")
35  errors["base"] = "unknown"
36  else:
37  await self.async_set_unique_idasync_set_unique_id(str(user_id))
38  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
39  return self.async_create_entryasync_create_entryasync_create_entry(
40  title="NYT Games", data={CONF_TOKEN: token}
41  )
42  return self.async_show_formasync_show_formasync_show_form(
43  step_id="user",
44  data_schema=vol.Schema({vol.Required(CONF_TOKEN): str}),
45  errors=errors,
46  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:20
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)
str
_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_create_clientsession()
Definition: coordinator.py:51