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

Small cleanups to climate entity feature compat (#116361)

Browse Source 
* Small cleanups to climate entity feature compat

Fix some duplicate property fetches, avoid generating a new
enum every time supported_features was fetched if there was
no modifier

* param

* param
This commit is contained in:
J. Nick Koston 2024-04-29 08:43:55 -05:00 committed by GitHub
parent d1f88ffd1e
commit 81d2f5b791
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 33 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
homeassistant/components/climate/__init__.py
View File

@ -325,16 +325,24 @@ class ClimateEntity(Entity, cached_properties=CACHED_PROPERTIES_WITH_ATTR_):
# Convert the supported features to ClimateEntityFeature. # Convert the supported features to ClimateEntityFeature.
# Remove this compatibility shim in 2025.1 or later. # Remove this compatibility shim in 2025.1 or later.
_supported_features = super().__getattribute__(__name) _supported_features: ClimateEntityFeature = super().__getattribute__(
"supported_features"
)
_mod_supported_features: ClimateEntityFeature = super().__getattribute__(
"_ClimateEntity__mod_supported_features"
)
if type(_supported_features) is int: # noqa: E721 if type(_supported_features) is int: # noqa: E721
new_features = ClimateEntityFeature(_supported_features) _features = ClimateEntityFeature(_supported_features)
self._report_deprecated_supported_features_values(new_features) self._report_deprecated_supported_features_values(_features)
else:
_features = _supported_features
if not _mod_supported_features:
return _features
# Add automatically calculated ClimateEntityFeature.TURN_OFF/TURN_ON to # Add automatically calculated ClimateEntityFeature.TURN_OFF/TURN_ON to
# supported features and return it # supported features and return it
return _supported_features | super().__getattribute__( return _features | _mod_supported_features
"_ClimateEntity__mod_supported_features"
)
@callback @callback
def add_to_platform_start( def add_to_platform_start(
@ -375,7 +383,8 @@ class ClimateEntity(Entity, cached_properties=CACHED_PROPERTIES_WITH_ATTR_):
# Return if integration has migrated already # Return if integration has migrated already
return return
if not self.supported_features & ClimateEntityFeature.TURN_OFF and ( supported_features = self.supported_features
if not supported_features & ClimateEntityFeature.TURN_OFF and (
type(self).async_turn_off is not ClimateEntity.async_turn_off type(self).async_turn_off is not ClimateEntity.async_turn_off
or type(self).turn_off is not ClimateEntity.turn_off or type(self).turn_off is not ClimateEntity.turn_off
): ):
@ -385,7 +394,7 @@ class ClimateEntity(Entity, cached_properties=CACHED_PROPERTIES_WITH_ATTR_):
ClimateEntityFeature.TURN_OFF ClimateEntityFeature.TURN_OFF
) )
if not self.supported_features & ClimateEntityFeature.TURN_ON and ( if not supported_features & ClimateEntityFeature.TURN_ON and (
type(self).async_turn_on is not ClimateEntity.async_turn_on type(self).async_turn_on is not ClimateEntity.async_turn_on
or type(self).turn_on is not ClimateEntity.turn_on or type(self).turn_on is not ClimateEntity.turn_on
): ):
@ -398,7 +407,7 @@ class ClimateEntity(Entity, cached_properties=CACHED_PROPERTIES_WITH_ATTR_):
if (modes := self.hvac_modes) and len(modes) >= 2 and HVACMode.OFF in modes: if (modes := self.hvac_modes) and len(modes) >= 2 and HVACMode.OFF in modes:
# turn_on/off implicitly supported by including more modes than 1 and one of these # turn_on/off implicitly supported by including more modes than 1 and one of these
# are HVACMode.OFF # are HVACMode.OFF
_modes = [_mode for _mode in self.hvac_modes if _mode is not None] _modes = [_mode for _mode in modes if _mode is not None]
_report_turn_on_off(", ".join(_modes or []), "turn_on/turn_off") _report_turn_on_off(", ".join(_modes or []), "turn_on/turn_off")
self.__mod_supported_features |= ( # pylint: disable=unused-private-member self.__mod_supported_features |= ( # pylint: disable=unused-private-member
ClimateEntityFeature.TURN_ON | ClimateEntityFeature.TURN_OFF ClimateEntityFeature.TURN_ON | ClimateEntityFeature.TURN_OFF

19
tests/components/climate/test_init.py
View File

@ -358,23 +358,34 @@ async def test_preset_mode_validation(
assert exc.value.translation_key == "not_valid_fan_mode" assert exc.value.translation_key == "not_valid_fan_mode"
def test_deprecated_supported_features_ints(caplog: pytest.LogCaptureFixture) -> None: @pytest.mark.parametrize(
"supported_features_at_int",
[
ClimateEntityFeature.TARGET_TEMPERATURE.value,
ClimateEntityFeature.TARGET_TEMPERATURE.value
| ClimateEntityFeature.TURN_ON.value
| ClimateEntityFeature.TURN_OFF.value,
],
)
def test_deprecated_supported_features_ints(
caplog: pytest.LogCaptureFixture, supported_features_at_int: int
) -> None:
"""Test deprecated supported features ints.""" """Test deprecated supported features ints."""
class MockClimateEntity(ClimateEntity): class MockClimateEntity(ClimateEntity):
@property @property
def supported_features(self) -> int: def supported_features(self) -> int:
"""Return supported features.""" """Return supported features."""
return 1 return supported_features_at_int
entity = MockClimateEntity() entity = MockClimateEntity()
assert entity.supported_features is ClimateEntityFeature(1) assert entity.supported_features is ClimateEntityFeature(supported_features_at_int)
assert "MockClimateEntity" in caplog.text assert "MockClimateEntity" in caplog.text
assert "is using deprecated supported features values" in caplog.text assert "is using deprecated supported features values" in caplog.text
assert "Instead it should use" in caplog.text assert "Instead it should use" in caplog.text
assert "ClimateEntityFeature.TARGET_TEMPERATURE" in caplog.text assert "ClimateEntityFeature.TARGET_TEMPERATURE" in caplog.text
caplog.clear() caplog.clear()
assert entity.supported_features is ClimateEntityFeature(1) assert entity.supported_features is ClimateEntityFeature(supported_features_at_int)
assert "is using deprecated supported features values" not in caplog.text assert "is using deprecated supported features values" not in caplog.text