Use key as main identity for st.radio widget#12705
Merged
lukasmasuch merged 3 commits intodevelopfrom Oct 8, 2025
Merged
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!
|
sfc-gh-lmasuch
added
security-assessment-completed
change:other
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR implements using a custom key as the main identity for st.radio widgets, allowing dynamic parameter changes between reruns without recreating the widget in the frontend. This ensures widget state persistence when non-critical parameters change.
Key changes:
- Modified radio widget to use key-based identity with whitelisted parameters
- Added comprehensive unit and E2E tests to verify stable widget IDs and state persistence
- Updated selectbox implementation to remove
format_funcfrom whitelisted identity parameters
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
lib/streamlit/elements/widgets/radio.py |
Updated radio widget to use key as main identity with options as the only whitelisted parameter |
lib/streamlit/elements/widgets/selectbox.py |
Removed format_func from selectbox whitelisted identity parameters with explanatory comment |
lib/tests/streamlit/elements/radio_test.py |
Added unit tests for stable widget ID behavior and whitelisted parameter validation |
e2e_playwright/st_radio.py |
Added dynamic radio test case with toggle-based parameter switching |
e2e_playwright/st_radio_test.py |
Added E2E test to verify dynamic radio behavior and state persistence |
sfc-gh-bnisco
approved these changes
Oct 8, 2025
e2e_playwright/st_radio_test.py
Outdated
| get_radio(themed_app, re.compile(r"^radio 14")), name="st_radio-markdown_label" | ||
| ) | ||
|
|
||
| # Dynamic radio snapshots are tested in dedicated test |
Collaborator
There was a problem hiding this comment.
nit: Seems like an unnecessary comment and would be better to remove it.
Collaborator
Author
There was a problem hiding this comment.
oh, yep. Cursor added that :) Removed
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
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.radiowidget 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.