Use key as main identity for st.audio_input widget#12720
Merged
lukasmasuch merged 13 commits intodevelopfrom Oct 8, 2025
Merged
Use key as main identity for st.audio_input widget#12720lukasmasuch merged 13 commits intodevelopfrom
key as main identity for st.audio_input widget#12720lukasmasuch merged 13 commits intodevelopfrom
Conversation
Contributor
🎉 Snyk checks have passed. No issues have been found so far.✅ security/snyk check is complete. No issues have been found. (View Details) ✅ license/snyk check is complete. No issues have been found. (View Details) |
Contributor
✅ PR preview is ready!
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the st.audio_input widget to use the key parameter as the main identity for widget ID computation. The change ensures that when a user provides a key, the widget maintains a stable ID even when non-whitelisted parameters change, while still recreating the widget when whitelisted parameters (like sample_rate) are modified.
Key Changes
- Modified widget ID computation to treat the provided key as the main identity
- Added
sample_rateto the whitelisted parameters for ID computation - Added comprehensive unit and E2E tests to verify the stable ID behavior
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
lib/streamlit/elements/widgets/audio_input.py |
Updated widget ID computation to use key as main identity and added sample_rate to whitelisted parameters |
lib/tests/streamlit/elements/audio_input_test.py |
Added unit test to verify stable widget ID behavior with key parameter |
e2e_playwright/st_audio_input_test.py |
Added E2E test for dynamic audio input ID behavior |
e2e_playwright/st_audio_input.py |
Added test app code for dynamic audio input with different configurations |
lukasmasuch
added
security-assessment-completed
change:feature
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
sfc-gh-bnisco
approved these changes
Oct 8, 2025
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
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.
Describe your changes
If a custom
keyis passed to thest.audio_inputwidget it will be used as the main identity. This allows for dynamically changing other parameters in between reruns without causing the widgets to be recreated in the frontend.GitHub Issue Link (if applicable)
Testing Plan
Contribution License Agreement
By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.