-
Notifications
You must be signed in to change notification settings - Fork 3.7k
feat(voice): expose SpeechHandle.hold_interruptions context manager #7201
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
devtechedge
wants to merge
2
commits into
livekit:main
Choose a base branch
from
devtechedge:feat/speech-handle-hold-interruptions
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+132
−4
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| """Public SpeechHandle.hold_interruptions() context manager (issue #7191).""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import pytest | ||
|
|
||
| from livekit.agents.voice.speech_handle import SpeechHandle | ||
|
|
||
| pytestmark = pytest.mark.unit | ||
|
|
||
|
|
||
| def test_hold_interruptions_disallows_then_restores() -> None: | ||
| handle = SpeechHandle.create(allow_interruptions=True) | ||
|
|
||
| with handle.hold_interruptions() as held: | ||
| assert held is handle | ||
| assert handle.allow_interruptions is False | ||
| with pytest.raises(RuntimeError, match="does not allow interruptions"): | ||
| handle.interrupt() | ||
|
|
||
| assert handle.allow_interruptions is True | ||
| handle.interrupt() | ||
| assert handle.interrupted | ||
|
|
||
|
|
||
| def test_hold_interruptions_nested_restores_once() -> None: | ||
| handle = SpeechHandle.create(allow_interruptions=True) | ||
|
|
||
| with handle.hold_interruptions(): | ||
| assert handle.allow_interruptions is False | ||
| with handle.hold_interruptions(): | ||
| assert handle.allow_interruptions is False | ||
| # inner release must not restore while outer still holds | ||
| assert handle.allow_interruptions is False | ||
|
|
||
| assert handle.allow_interruptions is True | ||
|
|
||
|
|
||
| def test_hold_interruptions_preserves_prior_false() -> None: | ||
| handle = SpeechHandle.create(allow_interruptions=False) | ||
|
|
||
| with handle.hold_interruptions(): | ||
| assert handle.allow_interruptions is False | ||
|
|
||
| assert handle.allow_interruptions is False | ||
|
|
||
|
|
||
| def test_force_interrupt_bypasses_hold() -> None: | ||
| handle = SpeechHandle.create(allow_interruptions=True) | ||
|
|
||
| with handle.hold_interruptions(): | ||
| handle.interrupt(force=True) | ||
| assert handle.interrupted | ||
|
|
||
|
|
||
| def test_allow_interruptions_true_during_hold_restores_after_release() -> None: | ||
| handle = SpeechHandle.create(allow_interruptions=False) | ||
|
|
||
| with handle.hold_interruptions(): | ||
| assert handle.allow_interruptions is False | ||
| handle.allow_interruptions = True | ||
| # assignment is deferred; hold stays effective | ||
| assert handle.allow_interruptions is False | ||
| with pytest.raises(RuntimeError, match="does not allow interruptions"): | ||
| handle.interrupt() | ||
|
|
||
| assert handle.allow_interruptions is True | ||
| handle.interrupt() | ||
| assert handle.interrupted | ||
|
|
||
|
|
||
| def test_allow_interruptions_false_during_nested_holds_restores_after_final() -> None: | ||
| handle = SpeechHandle.create(allow_interruptions=True) | ||
|
|
||
| with handle.hold_interruptions(): | ||
| assert handle.allow_interruptions is False | ||
| handle.allow_interruptions = True | ||
| assert handle.allow_interruptions is False | ||
| with handle.hold_interruptions(): | ||
| handle.allow_interruptions = False | ||
| assert handle.allow_interruptions is False | ||
| # outer still holds; still not interruptible | ||
| assert handle.allow_interruptions is False | ||
| with pytest.raises(RuntimeError, match="does not allow interruptions"): | ||
| handle.interrupt() | ||
|
|
||
| assert handle.allow_interruptions is False | ||
| with pytest.raises(RuntimeError, match="does not allow interruptions"): | ||
| handle.interrupt() | ||
|
|
||
|
|
||
| def test_force_interrupt_still_works_after_deferred_true_assignment() -> None: | ||
| handle = SpeechHandle.create(allow_interruptions=True) | ||
|
|
||
| with handle.hold_interruptions(): | ||
| handle.allow_interruptions = True | ||
| assert handle.allow_interruptions is False | ||
| handle.interrupt(force=True) | ||
| assert handle.interrupted | ||
|
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.