Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Adds config flow for 17track.net."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any
7 
8 from pyseventeentrack import Client as SeventeenTrackClient
9 from pyseventeentrack.errors import SeventeenTrackError
10 import voluptuous as vol
11 
12 from homeassistant.config_entries import ConfigEntry, ConfigFlow, ConfigFlowResult
13 from homeassistant.const import CONF_PASSWORD, CONF_USERNAME
14 from homeassistant.core import callback
15 from homeassistant.helpers import aiohttp_client
17  SchemaFlowFormStep,
18  SchemaOptionsFlowHandler,
19 )
20 
21 from .const import (
22  CONF_SHOW_ARCHIVED,
23  CONF_SHOW_DELIVERED,
24  DEFAULT_SHOW_ARCHIVED,
25  DEFAULT_SHOW_DELIVERED,
26  DOMAIN,
27 )
28 
29 CONF_SHOW = {
30  vol.Optional(CONF_SHOW_ARCHIVED, default=DEFAULT_SHOW_ARCHIVED): bool,
31  vol.Optional(CONF_SHOW_DELIVERED, default=DEFAULT_SHOW_DELIVERED): bool,
32 }
33 
34 _LOGGER = logging.getLogger(__name__)
35 
36 OPTIONS_SCHEMA = vol.Schema(CONF_SHOW)
37 OPTIONS_FLOW = {
38  "init": SchemaFlowFormStep(OPTIONS_SCHEMA),
39 }
40 
41 USER_SCHEMA = vol.Schema(
42  {
43  vol.Required(CONF_USERNAME): str,
44  vol.Required(CONF_PASSWORD): str,
45  }
46 )
47 
48 
49 class SeventeenTrackConfigFlow(ConfigFlow, domain=DOMAIN):
50  """17track config flow."""
51 
52  VERSION = 1
53 
54  @staticmethod
55  @callback
57  config_entry: ConfigEntry,
58  ) -> SchemaOptionsFlowHandler:
59  """Get options flow for this handler."""
60  return SchemaOptionsFlowHandler(config_entry, OPTIONS_FLOW)
61 
62  async def async_step_user(
63  self, user_input: dict[str, Any] | None = None
64  ) -> ConfigFlowResult:
65  """Handle a flow initialized by the user."""
66 
67  errors = {}
68  if user_input:
69  client = self._get_client_get_client()
70 
71  try:
72  if not await client.profile.login(
73  user_input[CONF_USERNAME], user_input[CONF_PASSWORD]
74  ):
75  errors["base"] = "invalid_auth"
76  except SeventeenTrackError as err:
77  _LOGGER.error("There was an error while logging in: %s", err)
78  errors["base"] = "cannot_connect"
79 
80  if not errors:
81  account_id = client.profile.account_id
82  await self.async_set_unique_idasync_set_unique_id(account_id)
83  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
84 
85  return self.async_create_entryasync_create_entryasync_create_entry(
86  title=user_input[CONF_USERNAME],
87  data=user_input,
88  options={
89  CONF_SHOW_ARCHIVED: DEFAULT_SHOW_ARCHIVED,
90  CONF_SHOW_DELIVERED: DEFAULT_SHOW_DELIVERED,
91  },
92  )
93 
94  return self.async_show_formasync_show_formasync_show_form(
95  step_id="user",
96  data_schema=USER_SCHEMA,
97  errors=errors,
98  )
99 
100  @callback
101  def _get_client(self):
102  session = aiohttp_client.async_get_clientsession(self.hass)
103  return SeventeenTrackClient(session=session)
SchemaOptionsFlowHandler async_get_options_flow(ConfigEntry config_entry)
Definition: config_flow.py:58
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:64
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)
_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)