Add deprecation warning for cover supported features when using magic numbers (#106618)

This commit is contained in:
J. Nick Koston
2023-12-29 11:27:59 +01:00
committed by Franck Nijhof
parent 5d9177d6e6
commit 9f4790902a
2 changed files with 23 additions and 2 deletions
+6 -2
View File
@@ -340,8 +340,12 @@ class CoverEntity(Entity, cached_properties=CACHED_PROPERTIES_WITH_ATTR_):
@property
def supported_features(self) -> CoverEntityFeature:
"""Flag supported features."""
if self._attr_supported_features is not None:
return self._attr_supported_features
if (features := self._attr_supported_features) is not None:
if type(features) is int: # noqa: E721
new_features = CoverEntityFeature(features)
self._report_deprecated_supported_features_values(new_features)
return new_features
return features
supported_features = (
CoverEntityFeature.OPEN | CoverEntityFeature.CLOSE | CoverEntityFeature.STOP
+17
View File
@@ -141,3 +141,20 @@ def test_deprecated_constants(
import_and_test_deprecated_constant_enum(
caplog, cover, enum, constant_prefix, "2025.1"
)
def test_deprecated_supported_features_ints(caplog: pytest.LogCaptureFixture) -> None:
"""Test deprecated supported features ints."""
class MockCoverEntity(cover.CoverEntity):
_attr_supported_features = 1
entity = MockCoverEntity()
assert entity.supported_features is cover.CoverEntityFeature(1)
assert "MockCoverEntity" in caplog.text
assert "is using deprecated supported features values" in caplog.text
assert "Instead it should use" in caplog.text
assert "CoverEntityFeature.OPEN" in caplog.text
caplog.clear()
assert entity.supported_features is cover.CoverEntityFeature(1)
assert "is using deprecated supported features values" not in caplog.text