Updated apps
This commit is contained in:
@@ -0,0 +1,234 @@
|
||||
"""ConfigFlow definition for Watchman."""
|
||||
|
||||
from types import MappingProxyType
|
||||
from typing import Any
|
||||
|
||||
import voluptuous as vol
|
||||
|
||||
from homeassistant import data_entry_flow
|
||||
from homeassistant.config_entries import (
|
||||
ConfigEntry,
|
||||
ConfigFlow,
|
||||
ConfigFlowResult,
|
||||
OptionsFlow,
|
||||
)
|
||||
from homeassistant.core import HomeAssistant, callback
|
||||
from homeassistant.helpers import config_validation as cv, selector
|
||||
|
||||
from .const import (
|
||||
CONF_COLUMNS_WIDTH,
|
||||
CONF_EXCLUDE_DISABLED_AUTOMATION,
|
||||
CONF_FRIENDLY_NAMES,
|
||||
CONF_HEADER,
|
||||
CONF_IGNORED_FILES,
|
||||
CONF_IGNORED_ITEMS,
|
||||
CONF_IGNORED_LABELS,
|
||||
CONF_IGNORED_STATES,
|
||||
CONF_LOG_OBFUSCATE,
|
||||
CONF_REPORT_PATH,
|
||||
CONF_SECTION_APPEARANCE_LOCATION,
|
||||
CONF_STARTUP_DELAY,
|
||||
CONFIG_ENTRY_MINOR_VERSION,
|
||||
CONFIG_ENTRY_VERSION,
|
||||
DEFAULT_OPTIONS,
|
||||
DEFAULT_REPORT_FILENAME,
|
||||
DOMAIN,
|
||||
MONITORED_STATES,
|
||||
)
|
||||
from .utils.logger import _LOGGER
|
||||
from .utils.utils import async_is_valid_path, get_val
|
||||
|
||||
INCLUDED_FOLDERS_SCHEMA = vol.Schema(vol.All(cv.ensure_list, [cv.string]))
|
||||
IGNORED_ITEMS_SCHEMA = vol.Schema(vol.All(cv.ensure_list, [cv.string]))
|
||||
IGNORED_STATES_SCHEMA = vol.Schema(MONITORED_STATES)
|
||||
IGNORED_FILES_SCHEMA = vol.Schema(vol.All(cv.ensure_list, [cv.string]))
|
||||
COLUMNS_WIDTH_SCHEMA = vol.Schema(vol.All(cv.ensure_list, [cv.positive_int]))
|
||||
|
||||
|
||||
def _get_data_schema() -> vol.Schema:
|
||||
select = selector.TextSelector(selector.TextSelectorConfig(multiline=True))
|
||||
return vol.Schema(
|
||||
{
|
||||
vol.Optional(
|
||||
CONF_IGNORED_ITEMS,
|
||||
): select,
|
||||
vol.Optional(
|
||||
CONF_IGNORED_STATES,
|
||||
): cv.multi_select(MONITORED_STATES),
|
||||
vol.Optional(
|
||||
CONF_IGNORED_FILES,
|
||||
): select,
|
||||
vol.Optional(
|
||||
CONF_IGNORED_LABELS,
|
||||
): selector.LabelSelector(
|
||||
selector.LabelSelectorConfig(multiple=True)
|
||||
),
|
||||
vol.Required(
|
||||
CONF_STARTUP_DELAY,
|
||||
): cv.positive_int,
|
||||
vol.Optional(
|
||||
CONF_EXCLUDE_DISABLED_AUTOMATION,
|
||||
): cv.boolean,
|
||||
vol.Optional(
|
||||
CONF_LOG_OBFUSCATE,
|
||||
): cv.boolean,
|
||||
vol.Required(CONF_SECTION_APPEARANCE_LOCATION): data_entry_flow.section(
|
||||
vol.Schema(
|
||||
{
|
||||
vol.Required(
|
||||
CONF_REPORT_PATH,
|
||||
): cv.string,
|
||||
vol.Required(
|
||||
CONF_HEADER,
|
||||
): cv.string,
|
||||
vol.Required(
|
||||
CONF_COLUMNS_WIDTH,
|
||||
): cv.string,
|
||||
vol.Optional(
|
||||
CONF_FRIENDLY_NAMES,
|
||||
): cv.boolean,
|
||||
}
|
||||
),
|
||||
{"collapsed": True},
|
||||
),
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
async def _async_validate_input(
|
||||
hass: HomeAssistant,
|
||||
user_input: dict[str, Any],
|
||||
) -> tuple[MappingProxyType[str, str], MappingProxyType[str, str]]:
|
||||
errors: dict[str, str] = {}
|
||||
placeholders: dict[str, str] = {}
|
||||
|
||||
columns_width = get_val(
|
||||
user_input, CONF_COLUMNS_WIDTH, CONF_SECTION_APPEARANCE_LOCATION
|
||||
)
|
||||
if columns_width:
|
||||
try:
|
||||
columns_width = [int(x) for x in columns_width.split(",") if x.strip()]
|
||||
if len(columns_width) != 3:
|
||||
raise ValueError
|
||||
columns_width = COLUMNS_WIDTH_SCHEMA(columns_width)
|
||||
except (ValueError, vol.Invalid):
|
||||
errors["base"] = "invalid_columns_width"
|
||||
|
||||
if (
|
||||
CONF_SECTION_APPEARANCE_LOCATION in user_input
|
||||
and CONF_REPORT_PATH in user_input[CONF_SECTION_APPEARANCE_LOCATION]
|
||||
):
|
||||
report_path = user_input[CONF_SECTION_APPEARANCE_LOCATION][CONF_REPORT_PATH]
|
||||
if not await async_is_valid_path(report_path):
|
||||
errors["base"] = "invalid_report_path"
|
||||
|
||||
return (
|
||||
MappingProxyType[str, str](errors),
|
||||
MappingProxyType[str, str](placeholders),
|
||||
)
|
||||
|
||||
|
||||
class ConfigFlowHandler(ConfigFlow, domain=DOMAIN):
|
||||
"""Config flow used to set up new instance of integration."""
|
||||
|
||||
VERSION = CONFIG_ENTRY_VERSION
|
||||
MINOR_VERSION = CONFIG_ENTRY_MINOR_VERSION
|
||||
|
||||
async def async_step_user(
|
||||
self, user_input: dict[str, Any] | None = None
|
||||
) -> ConfigFlowResult:
|
||||
"""Create new Watchman entry via UI."""
|
||||
_LOGGER.debug("::async_step_user::")
|
||||
options = DEFAULT_OPTIONS
|
||||
options[CONF_SECTION_APPEARANCE_LOCATION][CONF_REPORT_PATH] = (
|
||||
self.hass.config.path(DEFAULT_REPORT_FILENAME)
|
||||
)
|
||||
options[CONF_IGNORED_FILES] = DEFAULT_OPTIONS[CONF_IGNORED_FILES]
|
||||
return self.async_create_entry(title="Watchman", data=options)
|
||||
|
||||
@staticmethod
|
||||
@callback
|
||||
def async_get_options_flow(config_entry: ConfigEntry) -> OptionsFlow:
|
||||
"""Get the options flow for this handler."""
|
||||
return OptionsFlowHandler()
|
||||
|
||||
|
||||
class OptionsFlowHandler(OptionsFlow):
|
||||
"""Options flow used to change configuration (options) of existing instance of integration."""
|
||||
|
||||
async def async_get_key_in_section(
|
||||
self, data: dict[str, Any], key: str, section: str | None = None
|
||||
) -> Any:
|
||||
"""Return value of a key in ConfigEntry.data."""
|
||||
if section:
|
||||
if section in data:
|
||||
return section[data].get(key, None)
|
||||
else:
|
||||
return data.get(key)
|
||||
return None
|
||||
|
||||
async def async_step_init(
|
||||
self, user_input: dict[str, Any] | None = None
|
||||
) -> ConfigFlowResult:
|
||||
"""Manage the options form.
|
||||
|
||||
This method is invoked twice.
|
||||
1. To populate form with default values (user_input=None)
|
||||
2. To validate values entered by user (user_imput = {user_data})
|
||||
If no errors found, it should return creates_entry
|
||||
"""
|
||||
|
||||
if user_input is not None: # we asked to validate values entered by user
|
||||
_LOGGER.debug("OptionsFlowHandler.async_step_init")
|
||||
_LOGGER.debug(f"user_input= {user_input}")
|
||||
errors, placeholders = await _async_validate_input(self.hass, user_input)
|
||||
if not errors:
|
||||
# if user cleared up `ignored files` or `ignored items` form fields
|
||||
# user_input dict dict will not contain these keys, so we add them explicitly
|
||||
if (
|
||||
CONF_IGNORED_FILES in self.config_entry.data
|
||||
and CONF_IGNORED_FILES not in user_input
|
||||
):
|
||||
user_input[CONF_IGNORED_FILES] = ""
|
||||
|
||||
if (
|
||||
CONF_IGNORED_ITEMS in self.config_entry.data
|
||||
and CONF_IGNORED_ITEMS not in user_input
|
||||
):
|
||||
user_input[CONF_IGNORED_ITEMS] = ""
|
||||
|
||||
# see met.no code, without update_entry the EXISTING entry
|
||||
# will not be updated with user input, but entry.options will do
|
||||
self.hass.config_entries.async_update_entry(
|
||||
self.config_entry, data={**self.config_entry.data, **user_input}
|
||||
)
|
||||
return self.async_create_entry(title="", data={})
|
||||
# in case of errors in user_input, display them in the form
|
||||
# use previous user input as suggested values
|
||||
_LOGGER.debug(
|
||||
"::OptionsFlowHandler.async_step_init:: validation results errors:[%s] placehoders:[%s]",
|
||||
errors,
|
||||
placeholders,
|
||||
)
|
||||
placeholders = dict(placeholders)
|
||||
placeholders["url"] = "https://github.com/dummylabs/thewatchman#configuration"
|
||||
return self.async_show_form(
|
||||
step_id="init",
|
||||
data_schema=self.add_suggested_values_to_schema(
|
||||
_get_data_schema(),
|
||||
user_input,
|
||||
),
|
||||
errors=dict(errors),
|
||||
description_placeholders=dict(placeholders),
|
||||
)
|
||||
# we asked to provide default values for the form
|
||||
return self.async_show_form(
|
||||
step_id="init",
|
||||
data_schema=self.add_suggested_values_to_schema(
|
||||
_get_data_schema(),
|
||||
self.config_entry.data,
|
||||
),
|
||||
description_placeholders={
|
||||
"url": "https://github.com/dummylabs/thewatchman#configuration"
|
||||
},
|
||||
)
|
||||
Reference in New Issue
Block a user