Add deprecation warning for siren supported features when using magic numbers (#106621)
This commit is contained in:
parent
e4a25825d3
commit
a47587e3cd
2 changed files with 23 additions and 1 deletions
|
@ -212,4 +212,9 @@ class SirenEntity(ToggleEntity, cached_properties=CACHED_PROPERTIES_WITH_ATTR_):
|
|||
@cached_property
|
||||
def supported_features(self) -> SirenEntityFeature:
|
||||
"""Return the list of supported features."""
|
||||
return self._attr_supported_features
|
||||
features = self._attr_supported_features
|
||||
if type(features) is int: # noqa: E721
|
||||
new_features = SirenEntityFeature(features)
|
||||
self._report_deprecated_supported_features_values(new_features)
|
||||
return new_features
|
||||
return features
|
||||
|
|
|
@ -119,3 +119,20 @@ def test_deprecated_constants(
|
|||
) -> None:
|
||||
"""Test deprecated constants."""
|
||||
import_and_test_deprecated_constant_enum(caplog, module, enum, "SUPPORT_", "2025.1")
|
||||
|
||||
|
||||
def test_deprecated_supported_features_ints(caplog: pytest.LogCaptureFixture) -> None:
|
||||
"""Test deprecated supported features ints."""
|
||||
|
||||
class MockSirenEntity(siren.SirenEntity):
|
||||
_attr_supported_features = 1
|
||||
|
||||
entity = MockSirenEntity()
|
||||
assert entity.supported_features is siren.SirenEntityFeature(1)
|
||||
assert "MockSirenEntity" in caplog.text
|
||||
assert "is using deprecated supported features values" in caplog.text
|
||||
assert "Instead it should use" in caplog.text
|
||||
assert "SirenEntityFeature.TURN_ON" in caplog.text
|
||||
caplog.clear()
|
||||
assert entity.supported_features is siren.SirenEntityFeature(1)
|
||||
assert "is using deprecated supported features values" not in caplog.text
|
||||
|
|
Loading…
Add table
Reference in a new issue