Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Adds config flow for SabNzbd."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any
7 
8 import voluptuous as vol
9 import yarl
10 
11 from homeassistant.config_entries import (
12  SOURCE_RECONFIGURE,
13  ConfigFlow,
14  ConfigFlowResult,
15 )
16 from homeassistant.const import CONF_API_KEY, CONF_URL
18  TextSelector,
19  TextSelectorConfig,
20  TextSelectorType,
21 )
22 from homeassistant.util import slugify
23 
24 from .const import DOMAIN
25 from .helpers import get_client
26 
27 _LOGGER = logging.getLogger(__name__)
28 
29 USER_SCHEMA = vol.Schema(
30  {
31  vol.Required(CONF_URL): TextSelector(
33  type=TextSelectorType.URL,
34  )
35  ),
36  vol.Required(CONF_API_KEY): TextSelector(
38  type=TextSelectorType.PASSWORD,
39  )
40  ),
41  }
42 )
43 
44 
45 class SABnzbdConfigFlow(ConfigFlow, domain=DOMAIN):
46  """Sabnzbd config flow."""
47 
48  VERSION = 1
49 
51  self, user_input: dict[str, Any] | None = None
52  ) -> ConfigFlowResult:
53  """Handle reconfiguration flow."""
54  return await self.async_step_userasync_step_userasync_step_user(user_input)
55 
56  async def async_step_user(
57  self, user_input: dict[str, Any] | None = None
58  ) -> ConfigFlowResult:
59  """Handle a flow initialized by the user."""
60  errors = {}
61 
62  if user_input is not None:
63  sab_api = await get_client(self.hass, user_input)
64  if not sab_api:
65  errors["base"] = "cannot_connect"
66  else:
67  self._async_abort_entries_match_async_abort_entries_match(
68  {
69  CONF_URL: user_input[CONF_URL],
70  CONF_API_KEY: user_input[CONF_API_KEY],
71  }
72  )
73 
74  if self.sourcesourcesourcesource == SOURCE_RECONFIGURE:
75  return self.async_update_reload_and_abortasync_update_reload_and_abort(
76  self._get_reconfigure_entry_get_reconfigure_entry(), data_updates=user_input
77  )
78 
79  parsed_url = yarl.URL(user_input[CONF_URL])
80  return self.async_create_entryasync_create_entryasync_create_entry(
81  title=slugify(parsed_url.host), data=user_input
82  )
83 
84  return self.async_show_formasync_show_formasync_show_form(
85  step_id="user",
86  data_schema=self.add_suggested_values_to_schemaadd_suggested_values_to_schema(
87  USER_SCHEMA,
88  self._get_reconfigure_entry_get_reconfigure_entry().data
89  if self.sourcesourcesourcesource == SOURCE_RECONFIGURE
90  else user_input,
91  ),
92  errors=errors,
93  )
ConfigFlowResult async_step_reconfigure(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:52
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:58
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 _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)
vol.Schema add_suggested_values_to_schema(self, vol.Schema data_schema, Mapping[str, Any]|None suggested_values)
_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)
def get_client(HomeAssistant hass, data)
Definition: helpers.py:10