[Fix]: inconsistent error messages for st.secrets attribute assignment #10698
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
Collaborator
|
Thank you for working on this! Can you add some tests? |
Contributor
There was a problem hiding this comment.
PR Overview
This PR fixes inconsistent error messages when attempting to assign a value to st.secrets using attribute assignment by ensuring both item and attribute assignments raise a TypeError with the same message.
- Added a unit test to verify that attribute assignment to st.secrets raises the expected TypeError.
- Updated the setattr method to allow setting of internal attributes while still rejecting external attribute assignments.
Reviewed Changes
| File | Description |
|---|---|
| lib/tests/streamlit/runtime/secrets_test.py | Added test case to validate attribute assignment error message |
| lib/streamlit/runtime/secrets.py | Updated setattr to enforce consistent error messaging for assignments |
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (1)
lib/streamlit/runtime/secrets.py:495
- [nitpick] Consider adding an inline comment to explain the rationale behind the allowed keys list (internal attributes) to improve code clarity and maintainability.
def __setattr__(self, key: str, value: Any) -> None:
| except KeyError: | ||
| raise KeyError(_missing_key_error_message(key)) | ||
|
|
||
| def __setattr__(self, key: str, value: Any) -> None: |
Collaborator
There was a problem hiding this comment.
I see there are some other tests that utilize this path, but I think it would be good to also include an explicit test for this path as well.
sfc-gh-lwilby
approved these changes
Mar 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
Make the error message consistent between item assignment (st.secrets["foo"] = "bar") and attribute assignment (st.secrets.foo = "bar"). Both now raise a TypeError with a clear message indicating that Secrets does not support assignment.
GitHub Issue Link (if applicable)
fixes #10107
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.