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

Remove deprecated support feature values in media_player (#146986)

Browse Source
This commit is contained in:
G Johansson 2025-06-17 10:33:41 +02:00 committed by GitHub
parent b0c2a47288
commit 308c89af4a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 22 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
homeassistant/components/media_player/__init__.py
View File

@ -814,19 +814,6 @@ class MediaPlayerEntity(Entity, cached_properties=CACHED_PROPERTIES_WITH_ATTR_):
"""Flag media player features that are supported.""" """Flag media player features that are supported."""
return self._attr_supported_features return self._attr_supported_features
@property
def supported_features_compat(self) -> MediaPlayerEntityFeature:
"""Return the supported features as MediaPlayerEntityFeature.
Remove this compatibility shim in 2025.1 or later.
"""
features = self.supported_features
if type(features) is int:
new_features = MediaPlayerEntityFeature(features)
self._report_deprecated_supported_features_values(new_features)
return new_features
return features
def turn_on(self) -> None: def turn_on(self) -> None:
"""Turn the media player on.""" """Turn the media player on."""
raise NotImplementedError raise NotImplementedError
@ -966,87 +953,85 @@ class MediaPlayerEntity(Entity, cached_properties=CACHED_PROPERTIES_WITH_ATTR_):
@property @property
def support_play(self) -> bool: def support_play(self) -> bool:
"""Boolean if play is supported.""" """Boolean if play is supported."""
return MediaPlayerEntityFeature.PLAY in self.supported_features_compat return MediaPlayerEntityFeature.PLAY in self.supported_features
@final @final
@property @property
def support_pause(self) -> bool: def support_pause(self) -> bool:
"""Boolean if pause is supported.""" """Boolean if pause is supported."""
return MediaPlayerEntityFeature.PAUSE in self.supported_features_compat return MediaPlayerEntityFeature.PAUSE in self.supported_features
@final @final
@property @property
def support_stop(self) -> bool: def support_stop(self) -> bool:
"""Boolean if stop is supported.""" """Boolean if stop is supported."""
return MediaPlayerEntityFeature.STOP in self.supported_features_compat return MediaPlayerEntityFeature.STOP in self.supported_features
@final @final
@property @property
def support_seek(self) -> bool: def support_seek(self) -> bool:
"""Boolean if seek is supported.""" """Boolean if seek is supported."""
return MediaPlayerEntityFeature.SEEK in self.supported_features_compat return MediaPlayerEntityFeature.SEEK in self.supported_features
@final @final
@property @property
def support_volume_set(self) -> bool: def support_volume_set(self) -> bool:
"""Boolean if setting volume is supported.""" """Boolean if setting volume is supported."""
return MediaPlayerEntityFeature.VOLUME_SET in self.supported_features_compat return MediaPlayerEntityFeature.VOLUME_SET in self.supported_features
@final @final
@property @property
def support_volume_mute(self) -> bool: def support_volume_mute(self) -> bool:
"""Boolean if muting volume is supported.""" """Boolean if muting volume is supported."""
return MediaPlayerEntityFeature.VOLUME_MUTE in self.supported_features_compat return MediaPlayerEntityFeature.VOLUME_MUTE in self.supported_features
@final @final
@property @property
def support_previous_track(self) -> bool: def support_previous_track(self) -> bool:
"""Boolean if previous track command supported.""" """Boolean if previous track command supported."""
return MediaPlayerEntityFeature.PREVIOUS_TRACK in self.supported_features_compat return MediaPlayerEntityFeature.PREVIOUS_TRACK in self.supported_features
@final @final
@property @property
def support_next_track(self) -> bool: def support_next_track(self) -> bool:
"""Boolean if next track command supported.""" """Boolean if next track command supported."""
return MediaPlayerEntityFeature.NEXT_TRACK in self.supported_features_compat return MediaPlayerEntityFeature.NEXT_TRACK in self.supported_features
@final @final
@property @property
def support_play_media(self) -> bool: def support_play_media(self) -> bool:
"""Boolean if play media command supported.""" """Boolean if play media command supported."""
return MediaPlayerEntityFeature.PLAY_MEDIA in self.supported_features_compat return MediaPlayerEntityFeature.PLAY_MEDIA in self.supported_features
@final @final
@property @property
def support_select_source(self) -> bool: def support_select_source(self) -> bool:
"""Boolean if select source command supported.""" """Boolean if select source command supported."""
return MediaPlayerEntityFeature.SELECT_SOURCE in self.supported_features_compat return MediaPlayerEntityFeature.SELECT_SOURCE in self.supported_features
@final @final
@property @property
def support_select_sound_mode(self) -> bool: def support_select_sound_mode(self) -> bool:
"""Boolean if select sound mode command supported.""" """Boolean if select sound mode command supported."""
return ( return MediaPlayerEntityFeature.SELECT_SOUND_MODE in self.supported_features
MediaPlayerEntityFeature.SELECT_SOUND_MODE in self.supported_features_compat
)
@final @final
@property @property
def support_clear_playlist(self) -> bool: def support_clear_playlist(self) -> bool:
"""Boolean if clear playlist command supported.""" """Boolean if clear playlist command supported."""
return MediaPlayerEntityFeature.CLEAR_PLAYLIST in self.supported_features_compat return MediaPlayerEntityFeature.CLEAR_PLAYLIST in self.supported_features
@final @final
@property @property
def support_shuffle_set(self) -> bool: def support_shuffle_set(self) -> bool:
"""Boolean if shuffle is supported.""" """Boolean if shuffle is supported."""
return MediaPlayerEntityFeature.SHUFFLE_SET in self.supported_features_compat return MediaPlayerEntityFeature.SHUFFLE_SET in self.supported_features
@final @final
@property @property
def support_grouping(self) -> bool: def support_grouping(self) -> bool:
"""Boolean if player grouping is supported.""" """Boolean if player grouping is supported."""
return MediaPlayerEntityFeature.GROUPING in self.supported_features_compat return MediaPlayerEntityFeature.GROUPING in self.supported_features
async def async_toggle(self) -> None: async def async_toggle(self) -> None:
"""Toggle the power on the media player.""" """Toggle the power on the media player."""
@ -1074,7 +1059,7 @@ class MediaPlayerEntity(Entity, cached_properties=CACHED_PROPERTIES_WITH_ATTR_):
if ( if (
self.volume_level is not None self.volume_level is not None
and self.volume_level < 1 and self.volume_level < 1
and MediaPlayerEntityFeature.VOLUME_SET in self.supported_features_compat and MediaPlayerEntityFeature.VOLUME_SET in self.supported_features
): ):
await self.async_set_volume_level( await self.async_set_volume_level(
min(1, self.volume_level + self.volume_step) min(1, self.volume_level + self.volume_step)
@ -1092,7 +1077,7 @@ class MediaPlayerEntity(Entity, cached_properties=CACHED_PROPERTIES_WITH_ATTR_):
if ( if (
self.volume_level is not None self.volume_level is not None
and self.volume_level > 0 and self.volume_level > 0
and MediaPlayerEntityFeature.VOLUME_SET in self.supported_features_compat and MediaPlayerEntityFeature.VOLUME_SET in self.supported_features
): ):
await self.async_set_volume_level( await self.async_set_volume_level(
max(0, self.volume_level - self.volume_step) max(0, self.volume_level - self.volume_step)
@ -1135,7 +1120,7 @@ class MediaPlayerEntity(Entity, cached_properties=CACHED_PROPERTIES_WITH_ATTR_):
def capability_attributes(self) -> dict[str, Any]: def capability_attributes(self) -> dict[str, Any]:
"""Return capability attributes.""" """Return capability attributes."""
data: dict[str, Any] = {} data: dict[str, Any] = {}
supported_features = self.supported_features_compat supported_features = self.supported_features
if ( if (
source_list := self.source_list source_list := self.source_list
@ -1364,7 +1349,7 @@ async def websocket_browse_media(
connection.send_error(msg["id"], "entity_not_found", "Entity not found") connection.send_error(msg["id"], "entity_not_found", "Entity not found")
return return
if MediaPlayerEntityFeature.BROWSE_MEDIA not in player.supported_features_compat: if MediaPlayerEntityFeature.BROWSE_MEDIA not in player.supported_features:
connection.send_message( connection.send_message(
websocket_api.error_message( websocket_api.error_message(
msg["id"], ERR_NOT_SUPPORTED, "Player does not support browsing media" msg["id"], ERR_NOT_SUPPORTED, "Player does not support browsing media"
@ -1447,7 +1432,7 @@ async def websocket_search_media(
connection.send_error(msg["id"], "entity_not_found", "Entity not found") connection.send_error(msg["id"], "entity_not_found", "Entity not found")
return return
if MediaPlayerEntityFeature.SEARCH_MEDIA not in player.supported_features_compat: if MediaPlayerEntityFeature.SEARCH_MEDIA not in player.supported_features:
connection.send_message( connection.send_message(
websocket_api.error_message( websocket_api.error_message(
msg["id"], ERR_NOT_SUPPORTED, "Player does not support searching media" msg["id"], ERR_NOT_SUPPORTED, "Player does not support searching media"

28
tests/components/media_player/test_init.py
View File

@ -152,7 +152,9 @@ def test_support_properties(hass: HomeAssistant, property_suffix: str) -> None:
entity4 = MediaPlayerEntity() entity4 = MediaPlayerEntity()
entity4.hass = hass entity4.hass = hass
entity4.platform = MockEntityPlatform(hass) entity4.platform = MockEntityPlatform(hass)
entity4._attr_supported_features = all_features - feature entity4._attr_supported_features = media_player.MediaPlayerEntityFeature(
all_features - feature
)
assert getattr(entity1, f"support_{property_suffix}") is False assert getattr(entity1, f"support_{property_suffix}") is False
assert getattr(entity2, f"support_{property_suffix}") is True assert getattr(entity2, f"support_{property_suffix}") is True
@ -652,27 +654,3 @@ async def test_get_async_get_browse_image_quoting(
url = player.get_browse_image_url("album", media_content_id) url = player.get_browse_image_url("album", media_content_id)
await client.get(url) await client.get(url)
mock_browse_image.assert_called_with("album", media_content_id, None) mock_browse_image.assert_called_with("album", media_content_id, None)
def test_deprecated_supported_features_ints(
hass: HomeAssistant, caplog: pytest.LogCaptureFixture
) -> None:
"""Test deprecated supported features ints."""
class MockMediaPlayerEntity(MediaPlayerEntity):
@property
def supported_features(self) -> int:
"""Return supported features."""
return 1
entity = MockMediaPlayerEntity()
entity.hass = hass
entity.platform = MockEntityPlatform(hass)
assert entity.supported_features_compat is MediaPlayerEntityFeature(1)
assert "MockMediaPlayerEntity" in caplog.text
assert "is using deprecated supported features values" in caplog.text
assert "Instead it should use" in caplog.text
assert "MediaPlayerEntityFeature.PAUSE" in caplog.text
caplog.clear()
assert entity.supported_features_compat is MediaPlayerEntityFeature(1)
assert "is using deprecated supported features values" not in caplog.text