Add deprecation warning for statistics integration default buffer_size (#69700)
* Add deprecation warning for buffer size * Attend to comments * Clarify deprecation info * Move warnings to repairs issue_registry * Apply slight wording changes, add compiled en strings file * Format jsonpull/80970/head
Thomas Dietrich
GitHub
parent
403f0c16af
commit
a98c304db6
|
|
@ -34,10 +34,11 @@ from homeassistant.core import (
|
|||
Event,
|
||||
HomeAssistant,
|
||||
State,
|
||||
async_get_hass,
|
||||
callback,
|
||||
split_entity_id,
|
||||
)
|
||||
from homeassistant.helpers import config_validation as cv
|
||||
from homeassistant.helpers import config_validation as cv, issue_registry
|
||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||
from homeassistant.helpers.event import (
|
||||
async_track_point_in_utc_time,
|
||||
|
|
@ -87,15 +88,6 @@ STAT_VALUE_MAX = "value_max"
|
|||
STAT_VALUE_MIN = "value_min"
|
||||
STAT_VARIANCE = "variance"
|
||||
|
||||
DEPRECATION_WARNING_CHARACTERISTIC = (
|
||||
"The configuration parameter 'state_characteristic' will become "
|
||||
"mandatory in a future release of the statistics integration. "
|
||||
"Please add 'state_characteristic: %s' to the configuration of "
|
||||
"sensor '%s' to keep the current behavior. Read the documentation "
|
||||
"for further details: "
|
||||
"https://www.home-assistant.io/integrations/statistics/"
|
||||
)
|
||||
|
||||
# Statistics supported by a sensor source (numeric)
|
||||
STATS_NUMERIC_SUPPORT = {
|
||||
STAT_AVERAGE_LINEAR,
|
||||
|
|
@ -189,7 +181,6 @@ CONF_QUANTILE_INTERVALS = "quantile_intervals"
|
|||
CONF_QUANTILE_METHOD = "quantile_method"
|
||||
|
||||
DEFAULT_NAME = "Stats"
|
||||
DEFAULT_BUFFER_SIZE = 20
|
||||
DEFAULT_PRECISION = 2
|
||||
DEFAULT_QUANTILE_INTERVALS = 4
|
||||
DEFAULT_QUANTILE_METHOD = "exclusive"
|
||||
|
|
@ -202,10 +193,19 @@ def valid_state_characteristic_configuration(config: dict[str, Any]) -> dict[str
|
|||
|
||||
if config.get(CONF_STATE_CHARACTERISTIC) is None:
|
||||
config[CONF_STATE_CHARACTERISTIC] = STAT_COUNT if is_binary else STAT_MEAN
|
||||
_LOGGER.warning(
|
||||
DEPRECATION_WARNING_CHARACTERISTIC,
|
||||
config[CONF_STATE_CHARACTERISTIC],
|
||||
config[CONF_NAME],
|
||||
issue_registry.async_create_issue(
|
||||
hass=async_get_hass(),
|
||||
domain=DOMAIN,
|
||||
issue_id=f"{config[CONF_ENTITY_ID]}_default_characteristic",
|
||||
breaks_in_ha_version="2022.12.0",
|
||||
is_fixable=False,
|
||||
severity=issue_registry.IssueSeverity.WARNING,
|
||||
translation_key="deprecation_warning_characteristic",
|
||||
translation_placeholders={
|
||||
"entity": config[CONF_NAME],
|
||||
"characteristic": config[CONF_STATE_CHARACTERISTIC],
|
||||
},
|
||||
learn_more_url="https://github.com/home-assistant/core/pull/60402",
|
||||
)
|
||||
|
||||
characteristic = cast(str, config[CONF_STATE_CHARACTERISTIC])
|
||||
|
|
@ -220,15 +220,32 @@ def valid_state_characteristic_configuration(config: dict[str, Any]) -> dict[str
|
|||
return config
|
||||
|
||||
|
||||
def valid_boundary_configuration(config: dict[str, Any]) -> dict[str, Any]:
|
||||
"""Validate that sampling_size, max_age, or both are provided."""
|
||||
|
||||
if config.get(CONF_SAMPLES_MAX_BUFFER_SIZE) is None:
|
||||
config[CONF_SAMPLES_MAX_BUFFER_SIZE] = 20
|
||||
issue_registry.async_create_issue(
|
||||
hass=async_get_hass(),
|
||||
domain=DOMAIN,
|
||||
issue_id=f"{config[CONF_ENTITY_ID]}_invalid_boundary_config",
|
||||
breaks_in_ha_version="2022.12.0",
|
||||
is_fixable=False,
|
||||
severity=issue_registry.IssueSeverity.WARNING,
|
||||
translation_key="deprecation_warning_size",
|
||||
translation_placeholders={"entity": config[CONF_NAME]},
|
||||
learn_more_url="https://github.com/home-assistant/core/pull/69700",
|
||||
)
|
||||
return config
|
||||
|
||||
|
||||
_PLATFORM_SCHEMA_BASE = PLATFORM_SCHEMA.extend(
|
||||
{
|
||||
vol.Required(CONF_ENTITY_ID): cv.entity_id,
|
||||
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
||||
vol.Optional(CONF_UNIQUE_ID): cv.string,
|
||||
vol.Optional(CONF_STATE_CHARACTERISTIC): cv.string,
|
||||
vol.Optional(
|
||||
CONF_SAMPLES_MAX_BUFFER_SIZE, default=DEFAULT_BUFFER_SIZE
|
||||
): vol.All(vol.Coerce(int), vol.Range(min=1)),
|
||||
vol.Optional(CONF_SAMPLES_MAX_BUFFER_SIZE): vol.Coerce(int),
|
||||
vol.Optional(CONF_MAX_AGE): cv.time_period,
|
||||
vol.Optional(CONF_PRECISION, default=DEFAULT_PRECISION): vol.Coerce(int),
|
||||
vol.Optional(
|
||||
|
|
@ -242,6 +259,7 @@ _PLATFORM_SCHEMA_BASE = PLATFORM_SCHEMA.extend(
|
|||
PLATFORM_SCHEMA = vol.All(
|
||||
_PLATFORM_SCHEMA_BASE,
|
||||
valid_state_characteristic_configuration,
|
||||
valid_boundary_configuration,
|
||||
)
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,12 @@
|
|||
{
|
||||
"issues": {
|
||||
"deprecation_warning_characteristic": {
|
||||
"description": "The configuration parameter `state_characteristic` of the statistics integration will become mandatory.\n\nPlease add `state_characteristic: {characteristic}` to the configuration of sensor `{entity}` to keep the current behavior.\n\nRead the documentation of the statistics integration for further details: https://www.home-assistant.io/integrations/statistics/",
|
||||
"title": "Mandatory 'state_characteristic' assumed for a Statistics entity"
|
||||
},
|
||||
"deprecation_warning_size": {
|
||||
"description": "The configuration parameter `sampling_size` of the statistics integration defaulted to the value 20 so far, which will change.\n\nPlease check the configuration for sensor `{entity}` and add suited boundaries, e.g., `sampling_size: 20` to keep the current behavior. The configuration of the statistics integration will become more flexible with version 2022.12.0 and accept either `sampling_size` or `max_age`, or both settings. The request above prepares your configuration for this otherwise breaking change.\n\nRead the documentation of the statistics integration for further details: https://www.home-assistant.io/integrations/statistics/",
|
||||
"title": "Implicit 'sampling_size' assumed for a Statistics entity"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
{
|
||||
"issues": {
|
||||
"deprecation_warning_characteristic": {
|
||||
"description": "The configuration parameter `state_characteristic` of the statistics integration will become mandatory.\n\nPlease add `state_characteristic: {characteristic}` to the configuration of sensor `{entity}` to keep the current behavior.\n\nRead the documentation of the statistics integration for further details: https://www.home-assistant.io/integrations/statistics/",
|
||||
"title": "Mandatory 'state_characteristic' assumed for a Statistics entity"
|
||||
},
|
||||
"deprecation_warning_size": {
|
||||
"description": "The configuration parameter `sampling_size` of the statistics integration defaulted to the value 20 so far, which will change.\n\nPlease check the configuration for sensor `{entity}` and add suited boundaries, e.g., `sampling_size: 20` to keep the current behavior. The configuration of the statistics integration will become more flexible with version 2022.12.0 and accept either `sampling_size` or `max_age`, or both settings. The request above prepares your configuration for this otherwise breaking change.\n\nRead the documentation of the statistics integration for further details: https://www.home-assistant.io/integrations/statistics/",
|
||||
"title": "Implicit 'sampling_size' assumed for a Statistics entity"
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue