Deprecate stt_service parameter in STTMuteFilter #1176
Merged
Conversation
This file contains 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
aconchillo
reviewed
Feb 9, 2025
| **kwargs: Additional arguments passed to parent class | ||
| """ | ||
|
|
||
| def __init__(self, stt_service: STTService, config: STTMuteConfig, **kwargs): | ||
| def __init__(self, config: STTMuteConfig, stt_service: Optional[STTService] = None, **kwargs): |
There was a problem hiding this comment.
This looks like a breaking change, which is fine. We should foce keyword arguments which save us from breaking changes like this:
def __init__(self, *, config: STTMuteConfig, stt_service: Optional[STTService] = None, **kwargs):
aconchillo
reviewed
Feb 9, 2025
| self._config = config | ||
| if stt_service is not None: | ||
| warnings.warn( |
There was a problem hiding this comment.
Move import warnings here so we can remove the whole block in the future and we don't forget removing the import.
aconchillo
approved these changes
Feb 9, 2025
|
LGTM! Minor comments. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Please describe the changes in your PR. If it is addressing an issue, please reference that as well.
The
STTMuteFiltercurrently takes anSTTServiceparameter but only uses it to check mute state. This is unnecessary coupling since the filter can manage this state internally.This PR:
stt_serviceparameter optionalI've tested using the 24 example that this doesn't introduce a regression.