Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Adds config flow for Nord Pool integration."""
2 
3 from __future__ import annotations
4 
5 from typing import Any
6 
7 from pynordpool import (
8  Currency,
9  NordPoolClient,
10  NordPoolEmptyResponseError,
11  NordPoolError,
12 )
13 from pynordpool.const import AREAS
14 import voluptuous as vol
15 
16 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
17 from homeassistant.const import CONF_CURRENCY
18 from homeassistant.core import HomeAssistant
19 from homeassistant.helpers.aiohttp_client import async_get_clientsession
21  SelectOptionDict,
22  SelectSelector,
23  SelectSelectorConfig,
24  SelectSelectorMode,
25 )
26 from homeassistant.util import dt as dt_util
27 
28 from .const import CONF_AREAS, DEFAULT_NAME, DOMAIN
29 
30 SELECT_AREAS = [
31  SelectOptionDict(value=area, label=name) for area, name in AREAS.items()
32 ]
33 SELECT_CURRENCY = [currency.value for currency in Currency]
34 
35 DATA_SCHEMA = vol.Schema(
36  {
37  vol.Required(CONF_AREAS, default=[]): SelectSelector(
39  options=SELECT_AREAS,
40  multiple=True,
41  mode=SelectSelectorMode.DROPDOWN,
42  sort=True,
43  )
44  ),
45  vol.Required(CONF_CURRENCY, default="SEK"): SelectSelector(
47  options=SELECT_CURRENCY,
48  multiple=False,
49  mode=SelectSelectorMode.DROPDOWN,
50  sort=True,
51  )
52  ),
53  }
54 )
55 
56 
57 async def test_api(hass: HomeAssistant, user_input: dict[str, Any]) -> dict[str, str]:
58  """Test fetch data from Nord Pool."""
59  client = NordPoolClient(async_get_clientsession(hass))
60  try:
61  await client.async_get_delivery_period(
62  dt_util.now(),
63  Currency(user_input[CONF_CURRENCY]),
64  user_input[CONF_AREAS],
65  )
66  except NordPoolEmptyResponseError:
67  return {"base": "no_data"}
68  except NordPoolError:
69  return {"base": "cannot_connect"}
70 
71  return {}
72 
73 
74 class NordpoolConfigFlow(ConfigFlow, domain=DOMAIN):
75  """Handle a config flow for Nord Pool integration."""
76 
77  VERSION = 1
78 
79  async def async_step_user(
80  self, user_input: dict[str, Any] | None = None
81  ) -> ConfigFlowResult:
82  """Handle the initial step."""
83  errors: dict[str, str] = {}
84  if user_input:
85  errors = await test_api(self.hass, user_input)
86  if not errors:
87  return self.async_create_entryasync_create_entryasync_create_entry(
88  title=DEFAULT_NAME,
89  data=user_input,
90  )
91 
92  return self.async_show_formasync_show_formasync_show_form(
93  step_id="user",
94  data_schema=DATA_SCHEMA,
95  errors=errors,
96  )
97 
99  self, user_input: dict[str, Any] | None = None
100  ) -> ConfigFlowResult:
101  """Handle the reconfiguration step."""
102  errors: dict[str, str] = {}
103  if user_input:
104  errors = await test_api(self.hass, user_input)
105  reconfigure_entry = self._get_reconfigure_entry_get_reconfigure_entry()
106  if not errors:
107  return self.async_update_reload_and_abortasync_update_reload_and_abort(
108  reconfigure_entry, data_updates=user_input
109  )
110 
111  return self.async_show_formasync_show_formasync_show_form(
112  step_id="reconfigure",
113  data_schema=DATA_SCHEMA,
114  errors=errors,
115  )
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:81
ConfigFlowResult async_step_reconfigure(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:100
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_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)
dict[str, str] test_api(HomeAssistant hass, dict[str, Any] user_input)
Definition: config_flow.py:57
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)