Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for pushbullet integration."""
2 
3 from __future__ import annotations
4 
5 from typing import Any
6 
7 from pushbullet import InvalidKeyError, PushBullet, PushbulletError
8 import voluptuous as vol
9 
10 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
11 from homeassistant.const import CONF_API_KEY, CONF_NAME
12 from homeassistant.helpers import selector
13 
14 from .const import DEFAULT_NAME, DOMAIN
15 
16 CONFIG_SCHEMA = vol.Schema(
17  {
18  vol.Optional(CONF_NAME, default=DEFAULT_NAME): selector.TextSelector(),
19  vol.Required(CONF_API_KEY): selector.TextSelector(),
20  }
21 )
22 
23 
24 class PushBulletConfigFlow(ConfigFlow, domain=DOMAIN):
25  """Handle a config flow for pushbullet integration."""
26 
27  async def async_step_user(
28  self, user_input: dict[str, Any] | None = None
29  ) -> ConfigFlowResult:
30  """Handle the initial step."""
31  errors = {}
32 
33  if user_input is not None:
34  self._async_abort_entries_match_async_abort_entries_match({CONF_NAME: user_input[CONF_NAME]})
35 
36  try:
37  pushbullet = await self.hass.async_add_executor_job(
38  PushBullet, user_input[CONF_API_KEY]
39  )
40  except InvalidKeyError:
41  errors[CONF_API_KEY] = "invalid_api_key"
42  except PushbulletError:
43  errors["base"] = "cannot_connect"
44 
45  if not errors:
46  await self.async_set_unique_idasync_set_unique_id(pushbullet.user_info["iden"])
47  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
48  return self.async_create_entryasync_create_entryasync_create_entry(
49  title=user_input[CONF_NAME],
50  data=user_input,
51  )
52 
53  return self.async_show_formasync_show_formasync_show_form(
54  step_id="user",
55  data_schema=CONFIG_SCHEMA,
56  errors=errors,
57  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:29
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)
None _async_abort_entries_match(self, dict[str, Any]|None match_dict=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)