Home Assistant Unofficial Reference 2024.12.1
config_flow.py
Go to the documentation of this file.
1 """Config flow for Islamic Prayer Times integration."""
2 
3 from __future__ import annotations
4 
5 from typing import Any
6 
7 import voluptuous as vol
8 
10  ConfigEntry,
11  ConfigFlow,
12  ConfigFlowResult,
13  OptionsFlow,
14 )
15 from homeassistant.const import CONF_LATITUDE, CONF_LOCATION, CONF_LONGITUDE, CONF_NAME
16 from homeassistant.core import callback
18  LocationSelector,
19  SelectSelector,
20  SelectSelectorConfig,
21  SelectSelectorMode,
22  TextSelector,
23 )
24 
25 from .const import (
26  CALC_METHODS,
27  CONF_CALC_METHOD,
28  CONF_LAT_ADJ_METHOD,
29  CONF_MIDNIGHT_MODE,
30  CONF_SCHOOL,
31  DEFAULT_CALC_METHOD,
32  DEFAULT_LAT_ADJ_METHOD,
33  DEFAULT_MIDNIGHT_MODE,
34  DEFAULT_SCHOOL,
35  DOMAIN,
36  LAT_ADJ_METHODS,
37  MIDNIGHT_MODES,
38  NAME,
39  SCHOOLS,
40 )
41 
42 
43 class IslamicPrayerFlowHandler(ConfigFlow, domain=DOMAIN):
44  """Handle the Islamic Prayer config flow."""
45 
46  VERSION = 1
47  MINOR_VERSION = 2
48 
49  @staticmethod
50  @callback
52  config_entry: ConfigEntry,
53  ) -> IslamicPrayerOptionsFlowHandler:
54  """Get the options flow for this handler."""
56 
57  async def async_step_user(
58  self, user_input: dict[str, Any] | None = None
59  ) -> ConfigFlowResult:
60  """Handle a flow initialized by the user."""
61 
62  if user_input is not None:
63  lat: float = user_input[CONF_LOCATION][CONF_LATITUDE]
64  lon: float = user_input[CONF_LOCATION][CONF_LONGITUDE]
65  await self.async_set_unique_idasync_set_unique_id(f"{lat}-{lon}")
66  self._abort_if_unique_id_configured_abort_if_unique_id_configured()
67 
68  return self.async_create_entryasync_create_entryasync_create_entry(
69  title=user_input[CONF_NAME],
70  data={
71  CONF_LATITUDE: lat,
72  CONF_LONGITUDE: lon,
73  },
74  )
75 
76  home_location = {
77  CONF_LATITUDE: self.hass.config.latitude,
78  CONF_LONGITUDE: self.hass.config.longitude,
79  }
80  return self.async_show_formasync_show_formasync_show_form(
81  step_id="user",
82  data_schema=vol.Schema(
83  {
84  vol.Optional(CONF_NAME, default=NAME): TextSelector(),
85  vol.Required(
86  CONF_LOCATION, default=home_location
87  ): LocationSelector(),
88  }
89  ),
90  )
91 
92 
94  """Handle Islamic Prayer client options."""
95 
96  async def async_step_init(
97  self, user_input: dict[str, Any] | None = None
98  ) -> ConfigFlowResult:
99  """Manage options."""
100  if user_input is not None:
101  return self.async_create_entryasync_create_entry(title="", data=user_input)
102 
103  options = {
104  vol.Optional(
105  CONF_CALC_METHOD,
106  default=self.config_entryconfig_entryconfig_entry.options.get(
107  CONF_CALC_METHOD, DEFAULT_CALC_METHOD
108  ),
109  ): SelectSelector(
111  options=CALC_METHODS,
112  mode=SelectSelectorMode.DROPDOWN,
113  translation_key=CONF_CALC_METHOD,
114  )
115  ),
116  vol.Optional(
117  CONF_LAT_ADJ_METHOD,
118  default=self.config_entryconfig_entryconfig_entry.options.get(
119  CONF_LAT_ADJ_METHOD, DEFAULT_LAT_ADJ_METHOD
120  ),
121  ): SelectSelector(
123  options=LAT_ADJ_METHODS,
124  mode=SelectSelectorMode.DROPDOWN,
125  translation_key=CONF_LAT_ADJ_METHOD,
126  )
127  ),
128  vol.Optional(
129  CONF_MIDNIGHT_MODE,
130  default=self.config_entryconfig_entryconfig_entry.options.get(
131  CONF_MIDNIGHT_MODE, DEFAULT_MIDNIGHT_MODE
132  ),
133  ): SelectSelector(
135  options=MIDNIGHT_MODES,
136  mode=SelectSelectorMode.DROPDOWN,
137  translation_key=CONF_MIDNIGHT_MODE,
138  )
139  ),
140  vol.Optional(
141  CONF_SCHOOL,
142  default=self.config_entryconfig_entryconfig_entry.options.get(CONF_SCHOOL, DEFAULT_SCHOOL),
143  ): SelectSelector(
145  options=SCHOOLS,
146  mode=SelectSelectorMode.DROPDOWN,
147  translation_key=CONF_SCHOOL,
148  )
149  ),
150  }
151 
152  return self.async_show_formasync_show_form(step_id="init", data_schema=vol.Schema(options))
ConfigFlowResult async_step_user(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:59
IslamicPrayerOptionsFlowHandler async_get_options_flow(ConfigEntry config_entry)
Definition: config_flow.py:53
ConfigFlowResult async_step_init(self, dict[str, Any]|None user_input=None)
Definition: config_flow.py:98
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)
None config_entry(self, ConfigEntry value)
_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)