Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Tautulli."""
2 
3 from __future__ import annotations
4 
5 from collections.abc import Mapping
6 from typing import Any
7 
8 from pytautulli import PyTautulli, PyTautulliException, exceptions
9 import voluptuous as vol
10 
11 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
12 from homeassistant.const import CONF_API_KEY, CONF_URL, CONF_VERIFY_SSL
13 from homeassistant.helpers.aiohttp_client import async_get_clientsession
14 
15 from .const import DEFAULT_NAME, DOMAIN
16 
17 
18 class TautulliConfigFlow(ConfigFlow, domain=DOMAIN):
19  """Handle a config flow for Tautulli."""
20 
21  VERSION = 1
22 
23  async def async_step_user(
24  self, user_input: dict[str, Any] | None = None
25  ) -> ConfigFlowResult:
26  """Handle a flow initiated by the user."""
27  errors = {}
28  if user_input is not None:
29  self._async_abort_entries_match_async_abort_entries_match({CONF_URL: user_input[CONF_URL]})
30  if (error := await self.validate_inputvalidate_input(user_input)) is None:
31  return self.async_create_entryasync_create_entryasync_create_entry(
32  title=DEFAULT_NAME,
33  data=user_input,
34  )
35  errors["base"] = error
36 
37  user_input = user_input or {}
38  data_schema = {
39  vol.Required(CONF_API_KEY, default=user_input.get(CONF_API_KEY, "")): str,
40  vol.Required(CONF_URL, default=user_input.get(CONF_URL, "")): str,
41  vol.Optional(
42  CONF_VERIFY_SSL, default=user_input.get(CONF_VERIFY_SSL, True)
43  ): bool,
44  }
45 
46  return self.async_show_formasync_show_formasync_show_form(
47  step_id="user",
48  data_schema=vol.Schema(data_schema),
49  errors=errors or {},
50  )
51 
52  async def async_step_reauth(
53  self, entry_data: Mapping[str, Any]
54  ) -> ConfigFlowResult:
55  """Handle a reauthorization flow request."""
56  return await self.async_step_reauth_confirmasync_step_reauth_confirm()
57 
59  self, user_input: dict[str, str] | None = None
60  ) -> ConfigFlowResult:
61  """Confirm reauth dialog."""
62  errors = {}
63  if user_input is not None:
64  reauth_entry = self._get_reauth_entry_get_reauth_entry()
65  _input = {**reauth_entry.data, CONF_API_KEY: user_input[CONF_API_KEY]}
66  if (error := await self.validate_inputvalidate_input(_input)) is None:
67  return self.async_update_reload_and_abortasync_update_reload_and_abort(reauth_entry, data=_input)
68  errors["base"] = error
69  return self.async_show_formasync_show_formasync_show_form(
70  step_id="reauth_confirm",
71  data_schema=vol.Schema({vol.Required(CONF_API_KEY): str}),
72  errors=errors,
73  )
74 
75  async def validate_input(self, user_input: dict[str, Any]) -> str | None:
76  """Try connecting to Tautulli."""
77  try:
78  api_client = PyTautulli(
79  api_token=user_input[CONF_API_KEY],
80  url=user_input[CONF_URL],
82  self.hass, user_input.get(CONF_VERIFY_SSL, True)
83  ),
84  verify_ssl=user_input.get(CONF_VERIFY_SSL, True),
85  )
86  await api_client.async_get_server_info()
87  except exceptions.PyTautulliConnectionException:
88  return "cannot_connect"
89  except exceptions.PyTautulliAuthenticationException:
90  return "invalid_auth"
91  except PyTautulliException:
92  return "unknown"
93  return None
ConfigFlowResult async_step_reauth_confirm(self, dict[str, str]|None user_input=None)
Definition: config_flow.py:60
str|None validate_input(self, dict[str, Any] user_input)
Definition: config_flow.py:75
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:25
ConfigFlowResult async_step_reauth(self, Mapping[str, Any] entry_data)
Definition: config_flow.py:54
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)
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)
aiohttp.ClientSession async_get_clientsession(HomeAssistant hass, bool verify_ssl=True, socket.AddressFamily family=socket.AF_UNSPEC, ssl_util.SSLCipherList ssl_cipher=ssl_util.SSLCipherList.PYTHON_DEFAULT)