mirror of
https://github.com/home-assistant/core.git
synced 2025-04-23 16:57:53 +00:00
Add significant Change support for media player (#105999)
This commit is contained in:
Michael
GitHub
parent
d747b0891d
commit
0824a1f4a2
71
homeassistant/components/media_player/significant_change.py
Normal file
71
homeassistant/components/media_player/significant_change.py
Normal file
@ -0,0 +1,71 @@
|
||||
"""Helper to test significant Media Player state changes."""
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Any
|
||||
|
||||
from homeassistant.core import HomeAssistant, callback
|
||||
from homeassistant.helpers.significant_change import (
|
||||
check_absolute_change,
|
||||
check_valid_float,
|
||||
)
|
||||
|
||||
from . import (
|
||||
ATTR_ENTITY_PICTURE_LOCAL,
|
||||
ATTR_GROUP_MEMBERS,
|
||||
ATTR_MEDIA_POSITION,
|
||||
ATTR_MEDIA_POSITION_UPDATED_AT,
|
||||
ATTR_MEDIA_VOLUME_LEVEL,
|
||||
ATTR_TO_PROPERTY,
|
||||
)
|
||||
|
||||
INSIGNIFICANT_ATTRIBUTES: set[str] = {
|
||||
ATTR_MEDIA_POSITION,
|
||||
ATTR_MEDIA_POSITION_UPDATED_AT,
|
||||
}
|
||||
|
||||
SIGNIFICANT_ATTRIBUTES: set[str] = {
|
||||
ATTR_ENTITY_PICTURE_LOCAL,
|
||||
ATTR_GROUP_MEMBERS,
|
||||
*ATTR_TO_PROPERTY,
|
||||
}
|
||||
|
||||
|
||||
@callback
|
||||
def async_check_significant_change(
|
||||
hass: HomeAssistant,
|
||||
old_state: str,
|
||||
old_attrs: dict,
|
||||
new_state: str,
|
||||
new_attrs: dict,
|
||||
**kwargs: Any,
|
||||
) -> bool | None:
|
||||
"""Test if state significantly changed."""
|
||||
if old_state != new_state:
|
||||
return True
|
||||
|
||||
old_attrs_s = set(old_attrs.items())
|
||||
new_attrs_s = set(new_attrs.items())
|
||||
changed_attrs: set[str] = {item[0] for item in old_attrs_s ^ new_attrs_s}
|
||||
|
||||
for attr_name in changed_attrs:
|
||||
if attr_name not in SIGNIFICANT_ATTRIBUTES - INSIGNIFICANT_ATTRIBUTES:
|
||||
continue
|
||||
|
||||
if attr_name != ATTR_MEDIA_VOLUME_LEVEL:
|
||||
return True
|
||||
|
||||
old_attr_value = old_attrs.get(attr_name)
|
||||
new_attr_value = new_attrs.get(attr_name)
|
||||
if new_attr_value is None or not check_valid_float(new_attr_value):
|
||||
# New attribute value is invalid, ignore it
|
||||
continue
|
||||
|
||||
if old_attr_value is None or not check_valid_float(old_attr_value):
|
||||
# Old attribute value was invalid, we should report again
|
||||
return True
|
||||
|
||||
if check_absolute_change(old_attr_value, new_attr_value, 0.1):
|
||||
return True
|
||||
|
||||
# no significant attribute change detected
|
||||
return False
|
||||
126
tests/components/media_player/test_significant_change.py
Normal file
126
tests/components/media_player/test_significant_change.py
Normal file
@ -0,0 +1,126 @@
|
||||
"""Test the Media Player significant change platform."""
|
||||
import pytest
|
||||
|
||||
from homeassistant.components.media_player import (
|
||||
ATTR_APP_ID,
|
||||
ATTR_APP_NAME,
|
||||
ATTR_ENTITY_PICTURE_LOCAL,
|
||||
ATTR_GROUP_MEMBERS,
|
||||
ATTR_INPUT_SOURCE,
|
||||
ATTR_MEDIA_ALBUM_ARTIST,
|
||||
ATTR_MEDIA_ALBUM_NAME,
|
||||
ATTR_MEDIA_ARTIST,
|
||||
ATTR_MEDIA_CHANNEL,
|
||||
ATTR_MEDIA_CONTENT_ID,
|
||||
ATTR_MEDIA_CONTENT_TYPE,
|
||||
ATTR_MEDIA_DURATION,
|
||||
ATTR_MEDIA_EPISODE,
|
||||
ATTR_MEDIA_PLAYLIST,
|
||||
ATTR_MEDIA_POSITION,
|
||||
ATTR_MEDIA_POSITION_UPDATED_AT,
|
||||
ATTR_MEDIA_REPEAT,
|
||||
ATTR_MEDIA_SEASON,
|
||||
ATTR_MEDIA_SERIES_TITLE,
|
||||
ATTR_MEDIA_SHUFFLE,
|
||||
ATTR_MEDIA_TITLE,
|
||||
ATTR_MEDIA_TRACK,
|
||||
ATTR_MEDIA_VOLUME_LEVEL,
|
||||
ATTR_MEDIA_VOLUME_MUTED,
|
||||
ATTR_SOUND_MODE,
|
||||
)
|
||||
from homeassistant.components.media_player.significant_change import (
|
||||
async_check_significant_change,
|
||||
)
|
||||
|
||||
|
||||
async def test_significant_state_change() -> None:
|
||||
"""Detect Media Player significant state changes."""
|
||||
attrs = {}
|
||||
assert not async_check_significant_change(None, "on", attrs, "on", attrs)
|
||||
assert async_check_significant_change(None, "on", attrs, "off", attrs)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("old_attrs", "new_attrs", "expected_result"),
|
||||
[
|
||||
({ATTR_APP_ID: "old_value"}, {ATTR_APP_ID: "old_value"}, False),
|
||||
({ATTR_APP_ID: "old_value"}, {ATTR_APP_ID: "new_value"}, True),
|
||||
({ATTR_APP_NAME: "old_value"}, {ATTR_APP_NAME: "new_value"}, True),
|
||||
(
|
||||
{ATTR_ENTITY_PICTURE_LOCAL: "old_value"},
|
||||
{ATTR_ENTITY_PICTURE_LOCAL: "new_value"},
|
||||
True,
|
||||
),
|
||||
({ATTR_GROUP_MEMBERS: "old_value"}, {ATTR_GROUP_MEMBERS: "new_value"}, True),
|
||||
({ATTR_INPUT_SOURCE: "old_value"}, {ATTR_INPUT_SOURCE: "new_value"}, True),
|
||||
(
|
||||
{ATTR_MEDIA_ALBUM_ARTIST: "old_value"},
|
||||
{ATTR_MEDIA_ALBUM_ARTIST: "new_value"},
|
||||
True,
|
||||
),
|
||||
(
|
||||
{ATTR_MEDIA_ALBUM_NAME: "old_value"},
|
||||
{ATTR_MEDIA_ALBUM_NAME: "new_value"},
|
||||
True,
|
||||
),
|
||||
({ATTR_MEDIA_ARTIST: "old_value"}, {ATTR_MEDIA_ARTIST: "new_value"}, True),
|
||||
({ATTR_MEDIA_CHANNEL: "old_value"}, {ATTR_MEDIA_CHANNEL: "new_value"}, True),
|
||||
(
|
||||
{ATTR_MEDIA_CONTENT_ID: "old_value"},
|
||||
{ATTR_MEDIA_CONTENT_ID: "new_value"},
|
||||
True,
|
||||
),
|
||||
(
|
||||
{ATTR_MEDIA_CONTENT_TYPE: "old_value"},
|
||||
{ATTR_MEDIA_CONTENT_TYPE: "new_value"},
|
||||
True,
|
||||
),
|
||||
({ATTR_MEDIA_DURATION: "old_value"}, {ATTR_MEDIA_DURATION: "new_value"}, True),
|
||||
({ATTR_MEDIA_EPISODE: "old_value"}, {ATTR_MEDIA_EPISODE: "new_value"}, True),
|
||||
({ATTR_MEDIA_PLAYLIST: "old_value"}, {ATTR_MEDIA_PLAYLIST: "new_value"}, True),
|
||||
({ATTR_MEDIA_REPEAT: "old_value"}, {ATTR_MEDIA_REPEAT: "new_value"}, True),
|
||||
({ATTR_MEDIA_SEASON: "old_value"}, {ATTR_MEDIA_SEASON: "new_value"}, True),
|
||||
(
|
||||
{ATTR_MEDIA_SERIES_TITLE: "old_value"},
|
||||
{ATTR_MEDIA_SERIES_TITLE: "new_value"},
|
||||
True,
|
||||
),
|
||||
({ATTR_MEDIA_SHUFFLE: "old_value"}, {ATTR_MEDIA_SHUFFLE: "new_value"}, True),
|
||||
({ATTR_MEDIA_TITLE: "old_value"}, {ATTR_MEDIA_TITLE: "new_value"}, True),
|
||||
({ATTR_MEDIA_TRACK: "old_value"}, {ATTR_MEDIA_TRACK: "new_value"}, True),
|
||||
(
|
||||
{ATTR_MEDIA_VOLUME_MUTED: "old_value"},
|
||||
{ATTR_MEDIA_VOLUME_MUTED: "new_value"},
|
||||
True,
|
||||
),
|
||||
({ATTR_SOUND_MODE: "old_value"}, {ATTR_SOUND_MODE: "new_value"}, True),
|
||||
# multiple attributes
|
||||
(
|
||||
{ATTR_SOUND_MODE: "old_value", ATTR_MEDIA_VOLUME_MUTED: "old_value"},
|
||||
{ATTR_SOUND_MODE: "new_value", ATTR_MEDIA_VOLUME_MUTED: "old_value"},
|
||||
True,
|
||||
),
|
||||
# float attributes
|
||||
({ATTR_MEDIA_VOLUME_LEVEL: 0.1}, {ATTR_MEDIA_VOLUME_LEVEL: 0.2}, True),
|
||||
({ATTR_MEDIA_VOLUME_LEVEL: 0.1}, {ATTR_MEDIA_VOLUME_LEVEL: 0.19}, False),
|
||||
({ATTR_MEDIA_VOLUME_LEVEL: "invalid"}, {ATTR_MEDIA_VOLUME_LEVEL: 1}, True),
|
||||
({ATTR_MEDIA_VOLUME_LEVEL: 1}, {ATTR_MEDIA_VOLUME_LEVEL: "invalid"}, False),
|
||||
# insignificant attributes
|
||||
({ATTR_MEDIA_POSITION: "old_value"}, {ATTR_MEDIA_POSITION: "new_value"}, False),
|
||||
(
|
||||
{ATTR_MEDIA_POSITION_UPDATED_AT: "old_value"},
|
||||
{ATTR_MEDIA_POSITION_UPDATED_AT: "new_value"},
|
||||
False,
|
||||
),
|
||||
({"unknown_attr": "old_value"}, {"unknown_attr": "old_value"}, False),
|
||||
({"unknown_attr": "old_value"}, {"unknown_attr": "new_value"}, False),
|
||||
],
|
||||
)
|
||||
async def test_significant_atributes_change(
|
||||
old_attrs: dict, new_attrs: dict, expected_result: bool
|
||||
) -> None:
|
||||
"""Detect Media Player significant attribute changes."""
|
||||
assert (
|
||||
async_check_significant_change(None, "state", old_attrs, "state", new_attrs)
|
||||
== expected_result
|
||||
)
|
||||
Loading…
x
Reference in New Issue
Block a user