From 734c4e8e32e1f035b1172b90b33b346ebc26eea1 Mon Sep 17 00:00:00 2001 From: Erik Montnemery Date: Tue, 26 Sep 2023 19:12:16 +0200 Subject: [PATCH] Rename WakeWord.ww_id to WakeWord.id (#100903) * Rename WakeWord.ww_id to WakeWord.wake_word_id * Revert unrelated changes * Rename to id * Correct rebase --- homeassistant/components/wake_word/models.py | 4 ++-- homeassistant/components/wyoming/wake_word.py | 5 ++--- tests/components/assist_pipeline/conftest.py | 6 +++--- .../assist_pipeline/snapshots/test_init.ambr | 2 +- .../snapshots/test_websocket.ambr | 4 ++-- tests/components/wake_word/test_init.py | 18 +++++++++--------- .../wyoming/snapshots/test_wake_word.ambr | 2 +- tests/components/wyoming/test_wake_word.py | 2 +- 8 files changed, 21 insertions(+), 22 deletions(-) diff --git a/homeassistant/components/wake_word/models.py b/homeassistant/components/wake_word/models.py index 1ea154f1393..8e0699d97d0 100644 --- a/homeassistant/components/wake_word/models.py +++ b/homeassistant/components/wake_word/models.py @@ -6,7 +6,7 @@ from dataclasses import dataclass class WakeWord: """Wake word model.""" - ww_id: str + id: str name: str @@ -14,7 +14,7 @@ class WakeWord: class DetectionResult: """Result of wake word detection.""" - ww_id: str + wake_word_id: str """Id of detected wake word""" timestamp: int | None diff --git a/homeassistant/components/wyoming/wake_word.py b/homeassistant/components/wyoming/wake_word.py index 710e3408c5a..45d33b2a28c 100644 --- a/homeassistant/components/wyoming/wake_word.py +++ b/homeassistant/components/wyoming/wake_word.py @@ -46,8 +46,7 @@ class WyomingWakeWordProvider(wake_word.WakeWordDetectionEntity): wake_service = service.info.wake[0] self._supported_wake_words = [ - wake_word.WakeWord(ww_id=ww.name, name=ww.name) - for ww in wake_service.models + wake_word.WakeWord(id=ww.name, name=ww.name) for ww in wake_service.models ] self._attr_name = wake_service.name self._attr_unique_id = f"{config_entry.entry_id}-wake_word" @@ -111,7 +110,7 @@ class WyomingWakeWordProvider(wake_word.WakeWordDetectionEntity): queued_audio = [audio_task.result()] return wake_word.DetectionResult( - ww_id=detection.name, + wake_word_id=detection.name, timestamp=detection.timestamp, queued_audio=queued_audio, ) diff --git a/tests/components/assist_pipeline/conftest.py b/tests/components/assist_pipeline/conftest.py index 0ea92dd42fd..cde2666c1ea 100644 --- a/tests/components/assist_pipeline/conftest.py +++ b/tests/components/assist_pipeline/conftest.py @@ -184,18 +184,18 @@ class MockWakeWordEntity(wake_word.WakeWordDetectionEntity): @property def supported_wake_words(self) -> list[wake_word.WakeWord]: """Return a list of supported wake words.""" - return [wake_word.WakeWord(ww_id="test_ww", name="Test Wake Word")] + return [wake_word.WakeWord(id="test_ww", name="Test Wake Word")] async def _async_process_audio_stream( self, stream: AsyncIterable[tuple[bytes, int]], wake_word_id: str | None ) -> wake_word.DetectionResult | None: """Try to detect wake word(s) in an audio stream with timestamps.""" if wake_word_id is None: - wake_word_id = self.supported_wake_words[0].ww_id + wake_word_id = self.supported_wake_words[0].id async for chunk, timestamp in stream: if chunk.startswith(b"wake word"): return wake_word.DetectionResult( - ww_id=wake_word_id, + wake_word_id=wake_word_id, timestamp=timestamp, queued_audio=[(b"queued audio", 0)], ) diff --git a/tests/components/assist_pipeline/snapshots/test_init.ambr b/tests/components/assist_pipeline/snapshots/test_init.ambr index f36a334d97d..2108b84460e 100644 --- a/tests/components/assist_pipeline/snapshots/test_init.ambr +++ b/tests/components/assist_pipeline/snapshots/test_init.ambr @@ -292,7 +292,7 @@ 'data': dict({ 'wake_word_output': dict({ 'timestamp': 2000, - 'ww_id': 'test_ww', + 'wake_word_id': 'test_ww', }), }), 'type': , diff --git a/tests/components/assist_pipeline/snapshots/test_websocket.ambr b/tests/components/assist_pipeline/snapshots/test_websocket.ambr index dd88997262f..044e7758eb2 100644 --- a/tests/components/assist_pipeline/snapshots/test_websocket.ambr +++ b/tests/components/assist_pipeline/snapshots/test_websocket.ambr @@ -281,7 +281,7 @@ 'wake_word_output': dict({ 'queued_audio': None, 'timestamp': 1000, - 'ww_id': 'test_ww', + 'wake_word_id': 'test_ww', }), }) # --- @@ -379,7 +379,7 @@ dict({ 'wake_word_output': dict({ 'timestamp': 0, - 'ww_id': 'test_ww', + 'wake_word_id': 'test_ww', }), }) # --- diff --git a/tests/components/wake_word/test_init.py b/tests/components/wake_word/test_init.py index 47b413db435..2fb7cbd0c97 100644 --- a/tests/components/wake_word/test_init.py +++ b/tests/components/wake_word/test_init.py @@ -41,8 +41,8 @@ class MockProviderEntity(wake_word.WakeWordDetectionEntity): def supported_wake_words(self) -> list[wake_word.WakeWord]: """Return a list of supported wake words.""" return [ - wake_word.WakeWord(ww_id="test_ww", name="Test Wake Word"), - wake_word.WakeWord(ww_id="test_ww_2", name="Test Wake Word 2"), + wake_word.WakeWord(id="test_ww", name="Test Wake Word"), + wake_word.WakeWord(id="test_ww_2", name="Test Wake Word 2"), ] async def _async_process_audio_stream( @@ -50,12 +50,12 @@ class MockProviderEntity(wake_word.WakeWordDetectionEntity): ) -> wake_word.DetectionResult | None: """Try to detect wake word(s) in an audio stream with timestamps.""" if wake_word_id is None: - wake_word_id = self.supported_wake_words[0].ww_id + wake_word_id = self.supported_wake_words[0].id async for _chunk, timestamp in stream: if timestamp >= 2000: return wake_word.DetectionResult( - ww_id=wake_word_id, timestamp=timestamp + wake_word_id=wake_word_id, timestamp=timestamp ) # Not detected @@ -157,7 +157,7 @@ async def test_config_entry_unload( @freeze_time("2023-06-22 10:30:00+00:00") @pytest.mark.parametrize( - ("ww_id", "expected_ww"), + ("wake_word_id", "expected_ww"), [ (None, "test_ww"), ("test_ww_2", "test_ww_2"), @@ -167,7 +167,7 @@ async def test_detected_entity( hass: HomeAssistant, tmp_path: Path, setup: MockProviderEntity, - ww_id: str | None, + wake_word_id: str | None, expected_ww: str, ) -> None: """Test successful detection through entity.""" @@ -181,7 +181,7 @@ async def test_detected_entity( # Need 2 seconds to trigger state = setup.state assert state is None - result = await setup.async_process_audio_stream(three_second_stream(), ww_id) + result = await setup.async_process_audio_stream(three_second_stream(), wake_word_id) assert result == wake_word.DetectionResult(expected_ww, 2048) assert state != setup.state @@ -283,7 +283,7 @@ async def test_list_wake_words( assert msg["success"] assert msg["result"] == { "wake_words": [ - {"ww_id": "test_ww", "name": "Test Wake Word"}, - {"ww_id": "test_ww_2", "name": "Test Wake Word 2"}, + {"id": "test_ww", "name": "Test Wake Word"}, + {"id": "test_ww_2", "name": "Test Wake Word 2"}, ] } diff --git a/tests/components/wyoming/snapshots/test_wake_word.ambr b/tests/components/wyoming/snapshots/test_wake_word.ambr index 041112cb6ff..41518634a51 100644 --- a/tests/components/wyoming/snapshots/test_wake_word.ambr +++ b/tests/components/wyoming/snapshots/test_wake_word.ambr @@ -8,6 +8,6 @@ ), ]), 'timestamp': 0, - 'ww_id': 'Test Model', + 'wake_word_id': 'Test Model', }) # --- diff --git a/tests/components/wyoming/test_wake_word.py b/tests/components/wyoming/test_wake_word.py index 4ec471be7fd..eec5a16ff25 100644 --- a/tests/components/wyoming/test_wake_word.py +++ b/tests/components/wyoming/test_wake_word.py @@ -25,7 +25,7 @@ async def test_support(hass: HomeAssistant, init_wyoming_wake_word) -> None: assert entity is not None assert entity.supported_wake_words == [ - wake_word.WakeWord(ww_id="Test Model", name="Test Model") + wake_word.WakeWord(id="Test Model", name="Test Model") ]