Support passing query params to st.switch_page
#13027
Merged
Conversation
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
Contributor
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Contributor
✅ PR preview is ready!
|
lukasmasuch
added
security-assessment-completed
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for passing query parameters to st.switch_page, allowing developers to programmatically navigate to pages with specific query string values. This enhances the navigation API by providing a way to pass data between pages via URL parameters.
Key Changes
- Added optional
query_paramsparameter tost.switch_pagethat accepts either a mapping or iterable of key-value pairs - Frontend now stores and applies query parameters from the server during page navigation
- Query parameters are applied before the page rerun, ensuring they're available to the target page
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| lib/streamlit/commands/execution_control.py | Added query_params parameter to switch_page(), including type definitions, validation logic, and updated documentation |
| lib/tests/streamlit/commands/execution_control_test.py | Added unit tests covering valid dict/iterable query params and invalid input rejection |
| frontend/app/src/App.tsx | Updated state management to store and apply query parameters from server during page navigation |
| e2e_playwright/multipage_apps_v2/mpa_v2_basics.py | Added test button and query params display for E2E testing |
| e2e_playwright/multipage_apps_v2/mpa_v2_basics_test.py | Added E2E test to verify query params are correctly applied when switching pages |
lukasmasuch
added
the
flaky-verify
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
sfc-gh-lmasuch
added
flaky-verify
lukasmasuch
added
flaky-verify
sfc-gh-lmasuch
added
flaky-verify
lukasmasuch
added
flaky-verify
…rams-for-switch-page
lukasmasuch
added
flaky-verify
lukasmasuch
added
flaky-verify
sfc-gh-lmasuch
added
flaky-verify
sfc-gh-lmasuch
removed
the
flaky-verify
sfc-gh-bnisco
approved these changes
Nov 21, 2025
Comment on lines
+122
to
+128
| if isinstance(new_query_params, Mapping) or ( | ||
| isinstance(new_query_params, Iterable) | ||
| and not isinstance( | ||
| new_query_params, # type: ignore[unreachable] | ||
| (str, bytes), | ||
| ) | ||
| ): |
Contributor
There was a problem hiding this comment.
The type checker marks this condition as unreachable because by the time the code checks if new_query_params is a string/bytes, it has already confirmed it's an Iterable (since strings are iterable). This could cause unexpected behavior with string inputs.
Consider restructuring the condition to check for string/bytes first:
if isinstance(new_query_params, (str, bytes)):
raise StreamlitAPIException(f"`query_params` must be a mapping or an iterable of (key, value) pairs not a string.")
elif isinstance(new_query_params, Mapping) or isinstance(new_query_params, Iterable):
query_params_state.from_dict(new_query_params)This would make the logic clearer and remove the need for the # type: ignore[unreachable] comment.
Suggested change
| if isinstance(new_query_params, Mapping) or ( | |
| isinstance(new_query_params, Iterable) | |
| and not isinstance( | |
| new_query_params, # type: ignore[unreachable] | |
| (str, bytes), | |
| ) | |
| ): | |
| if isinstance(new_query_params, (str, bytes)): | |
| raise StreamlitAPIException( | |
| f"`query_params` must be a mapping or an iterable of (key, value) pairs not a string." | |
| ) | |
| elif isinstance(new_query_params, Mapping) or isinstance(new_query_params, Iterable): |
Spotted by Graphite Agent
Is this helpful? React 👍 or 👎 to let us know.
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
Adds support for passing query parameters to
st.switch_pageGitHub 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.