jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-17 18:27:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove deprecated non-native number support (#95178)

Browse Source 
* Remove deprecated non-native number support

These were scheduled to be removed in 2022.10 but were left
in to give custom component authors a bit more time.

Its been a year since they were deprecated so its time
to remove the old code

https://developers.home-assistant.io/blog/2022/06/14/number_entity_refactoring/

* strip unneeded change from testing
This commit is contained in:
J. Nick Koston 2023-06-24 22:01:44 -05:00 committed by GitHub
parent fa334cf2bd
commit c6b3d538de
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 0 additions and 249 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
homeassistant/components/number/__init__.py
View File

@ -135,39 +135,6 @@ class NumberEntityDescription(EntityDescription):
step: None = None step: None = None
unit_of_measurement: None = None # Type override, use native_unit_of_measurement unit_of_measurement: None = None # Type override, use native_unit_of_measurement
def __post_init__(self) -> None:
"""Post initialisation processing."""
if (
self.max_value is not None
or self.min_value is not None
or self.step is not None
or self.unit_of_measurement is not None
):
if ( # type: ignore[unreachable]
self.__class__.__name__ == "NumberEntityDescription"
):
caller = inspect.stack()[2]
module = inspect.getmodule(caller[0])
else:
module = inspect.getmodule(self)
if module and module.__file__ and "custom_components" in module.__file__:
report_issue = "report it to the custom integration author."
else:
report_issue = (
"create a bug report at "
"https://github.com/home-assistant/core/issues?q=is%3Aopen+is%3Aissue"
)
_LOGGER.warning(
(
"%s is setting deprecated attributes on an instance of"
" NumberEntityDescription, this is not valid and will be"
" unsupported from Home Assistant 2022.10. Please %s"
),
module.__name__ if module else self.__class__.__name__,
report_issue,
)
self.native_unit_of_measurement = self.unit_of_measurement
def ceil_decimal(value: float, precision: float = 0) -> float: def ceil_decimal(value: float, precision: float = 0) -> float:
"""Return the ceiling of f with d decimals. """Return the ceiling of f with d decimals.
@ -290,15 +257,6 @@ class NumberEntity(Entity):
@final @final
def min_value(self) -> float: def min_value(self) -> float:
"""Return the minimum value.""" """Return the minimum value."""
if hasattr(self, "_attr_min_value"):
self._report_deprecated_number_entity()
return self._attr_min_value # type: ignore[return-value]
if (
hasattr(self, "entity_description")
and self.entity_description.min_value is not None
):
self._report_deprecated_number_entity() # type: ignore[unreachable]
return self.entity_description.min_value
return self._convert_to_state_value(self.native_min_value, floor_decimal) return self._convert_to_state_value(self.native_min_value, floor_decimal)
@property @property
@ -317,15 +275,6 @@ class NumberEntity(Entity):
@final @final
def max_value(self) -> float: def max_value(self) -> float:
"""Return the maximum value.""" """Return the maximum value."""
if hasattr(self, "_attr_max_value"):
self._report_deprecated_number_entity()
return self._attr_max_value # type: ignore[return-value]
if (
hasattr(self, "entity_description")
and self.entity_description.max_value is not None
):
self._report_deprecated_number_entity() # type: ignore[unreachable]
return self.entity_description.max_value
return self._convert_to_state_value(self.native_max_value, ceil_decimal) return self._convert_to_state_value(self.native_max_value, ceil_decimal)
@property @property
@ -342,15 +291,6 @@ class NumberEntity(Entity):
@final @final
def step(self) -> float: def step(self) -> float:
"""Return the increment/decrement step.""" """Return the increment/decrement step."""
if hasattr(self, "_attr_step"):
self._report_deprecated_number_entity()
return self._attr_step # type: ignore[return-value]
if (
hasattr(self, "entity_description")
and self.entity_description.step is not None
):
self._report_deprecated_number_entity() # type: ignore[unreachable]
return self.entity_description.step
if hasattr(self, "_attr_native_step"): if hasattr(self, "_attr_native_step"):
return self._attr_native_step return self._attr_native_step
if (native_step := self.native_step) is not None: if (native_step := self.native_step) is not None:
@ -396,17 +336,6 @@ class NumberEntity(Entity):
if self._number_option_unit_of_measurement: if self._number_option_unit_of_measurement:
return self._number_option_unit_of_measurement return self._number_option_unit_of_measurement
if hasattr(self, "_attr_unit_of_measurement"):
self._report_deprecated_number_entity()
return self._attr_unit_of_measurement
if (
hasattr(self, "entity_description")
and self.entity_description.unit_of_measurement is not None
):
return ( # type: ignore[unreachable]
self.entity_description.unit_of_measurement
)
native_unit_of_measurement = self.native_unit_of_measurement native_unit_of_measurement = self.native_unit_of_measurement
if ( if (
@ -427,10 +356,6 @@ class NumberEntity(Entity):
@final @final
def value(self) -> float | None: def value(self) -> float | None:
"""Return the entity value to represent the entity state.""" """Return the entity value to represent the entity state."""
if hasattr(self, "_attr_value"):
self._report_deprecated_number_entity()
return self._attr_value
if (native_value := self.native_value) is None: if (native_value := self.native_value) is None:
return native_value return native_value
return self._convert_to_state_value(native_value, round) return self._convert_to_state_value(native_value, round)
@ -457,7 +382,6 @@ class NumberEntity(Entity):
self, value: float, method: Callable[[float, int], float] self, value: float, method: Callable[[float, int], float]
) -> float: ) -> float:
"""Convert a value in the number's native unit to the configured unit.""" """Convert a value in the number's native unit to the configured unit."""
native_unit_of_measurement = self.native_unit_of_measurement native_unit_of_measurement = self.native_unit_of_measurement
unit_of_measurement = self.unit_of_measurement unit_of_measurement = self.unit_of_measurement
device_class = self.device_class device_class = self.device_class
@ -487,7 +411,6 @@ class NumberEntity(Entity):
def convert_to_native_value(self, value: float) -> float: def convert_to_native_value(self, value: float) -> float:
"""Convert a value to the number's native unit.""" """Convert a value to the number's native unit."""
native_unit_of_measurement = self.native_unit_of_measurement native_unit_of_measurement = self.native_unit_of_measurement
unit_of_measurement = self.unit_of_measurement unit_of_measurement = self.unit_of_measurement
device_class = self.device_class device_class = self.device_class
@ -508,21 +431,6 @@ class NumberEntity(Entity):
return value return value
def _report_deprecated_number_entity(self) -> None:
"""Report that the number entity has not been upgraded."""
if not self._deprecated_number_entity_reported:
self._deprecated_number_entity_reported = True
report_issue = self._suggest_report_issue()
_LOGGER.warning(
(
"Entity %s (%s) is using deprecated NumberEntity features which"
" will be unsupported from Home Assistant Core 2022.10, please %s"
),
self.entity_id,
type(self),
report_issue,
)
@callback @callback
def async_registry_entry_updated(self) -> None: def async_registry_entry_updated(self) -> None:
"""Run when the entity registry entry has been updated.""" """Run when the entity registry entry has been updated."""

157
tests/components/number/test_init.py
View File

@ -40,7 +40,6 @@ from homeassistant.util.unit_system import METRIC_SYSTEM, US_CUSTOMARY_SYSTEM
from tests.common import ( from tests.common import (
MockConfigEntry, MockConfigEntry,
MockEntityPlatform,
MockModule, MockModule,
MockPlatform, MockPlatform,
async_mock_restore_state_shutdown_restart, async_mock_restore_state_shutdown_restart,
@ -253,64 +252,6 @@ async def test_attributes(hass: HomeAssistant) -> None:
assert number_4.value is None assert number_4.value is None
async def test_deprecation_warnings(
hass: HomeAssistant, caplog: pytest.LogCaptureFixture
) -> None:
"""Test overriding the deprecated attributes is possible and warnings are logged."""
number = MockDefaultNumberEntityDeprecated()
number.hass = hass
number.platform = MockEntityPlatform(hass)
assert number.max_value == 100.0
assert number.min_value == 0.0
assert number.step == 1.0
assert number.unit_of_measurement is None
assert number.value == 0.5
number_2 = MockNumberEntityDeprecated()
number_2.hass = hass
number_2.platform = MockEntityPlatform(hass)
assert number_2.max_value == 0.5
assert number_2.min_value == -0.5
assert number_2.step == 0.1
assert number_2.unit_of_measurement == "cats"
assert number_2.value == 0.5
number_3 = MockNumberEntityAttrDeprecated()
number_3.hass = hass
number_3.platform = MockEntityPlatform(hass)
assert number_3.max_value == 1000.0
assert number_3.min_value == -1000.0
assert number_3.step == 100.0
assert number_3.unit_of_measurement == "dogs"
assert number_3.value == 500.0
number_4 = MockNumberEntityDescrDeprecated()
number_4.hass = hass
number_4.platform = MockEntityPlatform(hass)
assert number_4.max_value == 10.0
assert number_4.min_value == -10.0
assert number_4.step == 2.0
assert number_4.unit_of_measurement == "rabbits"
assert number_4.value == 0.5
assert (
"tests.components.number.test_init::MockNumberEntityDeprecated is overriding "
" deprecated methods on an instance of NumberEntity"
)
assert (
"Entity None (<class 'tests.components.number.test_init.MockNumberEntityAttrDeprecated'>) "
"is using deprecated NumberEntity features" in caplog.text
)
assert (
"Entity None (<class 'tests.components.number.test_init.MockNumberEntityDescrDeprecated'>) "
"is using deprecated NumberEntity features" in caplog.text
)
assert (
"tests.components.number.test_init is setting deprecated attributes on an "
"instance of NumberEntityDescription" in caplog.text
)
async def test_sync_set_value(hass: HomeAssistant) -> None: async def test_sync_set_value(hass: HomeAssistant) -> None:
"""Test if async set_value calls sync set_value.""" """Test if async set_value calls sync set_value."""
number = MockDefaultNumberEntity() number = MockDefaultNumberEntity()
@ -360,104 +301,6 @@ async def test_set_value(hass: HomeAssistant, enable_custom_integrations: None)
assert state.state == "60.0" assert state.state == "60.0"
async def test_deprecated_attributes(
hass: HomeAssistant, enable_custom_integrations: None
) -> None:
"""Test entity using deprecated attributes."""
platform = getattr(hass.components, f"test.{DOMAIN}")
platform.init(empty=True)
platform.ENTITIES.append(platform.LegacyMockNumberEntity())
entity = platform.ENTITIES[0]
entity._attr_name = "Test"
entity._attr_max_value = 25
entity._attr_min_value = -25
entity._attr_step = 2.5
entity._attr_value = 51.0
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {CONF_PLATFORM: "test"}})
await hass.async_block_till_done()
state = hass.states.get("number.test")
assert state.state == "51.0"
assert state.attributes.get(ATTR_MAX) == 25.0
assert state.attributes.get(ATTR_MIN) == -25.0
assert state.attributes.get(ATTR_STEP) == 2.5
await hass.services.async_call(
DOMAIN,
SERVICE_SET_VALUE,
{ATTR_VALUE: 0.0, ATTR_ENTITY_ID: "number.test"},
blocking=True,
)
await hass.async_block_till_done()
state = hass.states.get("number.test")
assert state.state == "0.0"
# test ValueError trigger
with pytest.raises(ValueError):
await hass.services.async_call(
DOMAIN,
SERVICE_SET_VALUE,
{ATTR_VALUE: 110.0, ATTR_ENTITY_ID: "number.test"},
blocking=True,
)
await hass.async_block_till_done()
state = hass.states.get("number.test")
assert state.state == "0.0"
async def test_deprecated_methods(
hass: HomeAssistant, enable_custom_integrations: None
) -> None:
"""Test entity using deprecated methods."""
platform = getattr(hass.components, f"test.{DOMAIN}")
platform.init(empty=True)
platform.ENTITIES.append(
platform.LegacyMockNumberEntity(
name="Test",
max_value=25.0,
min_value=-25.0,
step=2.5,
value=51.0,
)
)
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {CONF_PLATFORM: "test"}})
await hass.async_block_till_done()
state = hass.states.get("number.test")
assert state.state == "51.0"
assert state.attributes.get(ATTR_MAX) == 25.0
assert state.attributes.get(ATTR_MIN) == -25.0
assert state.attributes.get(ATTR_STEP) == 2.5
await hass.services.async_call(
DOMAIN,
SERVICE_SET_VALUE,
{ATTR_VALUE: 0.0, ATTR_ENTITY_ID: "number.test"},
blocking=True,
)
await hass.async_block_till_done()
state = hass.states.get("number.test")
assert state.state == "0.0"
# test ValueError trigger
with pytest.raises(ValueError):
await hass.services.async_call(
DOMAIN,
SERVICE_SET_VALUE,
{ATTR_VALUE: 110.0, ATTR_ENTITY_ID: "number.test"},
blocking=True,
)
await hass.async_block_till_done()
state = hass.states.get("number.test")
assert state.state == "0.0"
@pytest.mark.parametrize( @pytest.mark.parametrize(
( (
"unit_system", "unit_system",