Make shallow copies of options returned from ensure_indexable #8064
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
vdonato
force-pushed
the
vdonato/fix/7534
branch
from
be5a162
to
1aa5068
Compare
kajarenc
approved these changes
Feb 2, 2024
kajarenc
reviewed
Feb 2, 2024
vdonato
force-pushed
the
vdonato/fix/7534
branch
from
1aa5068
to
f38e081
Compare
zyxue
pushed a commit
to zyxue/streamlit
that referenced
this pull request
Apr 16, 2024
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.
The strange behavior in #7534 is caused by us saving a reference to the
optionsobject into the*Serdeclass of an options widget. This causes any mutations to that object to cause weird sideeffects in the next script run.
To avoid this, we return a shallow copy of every object passed into
ensure_indexableeitherby calling
copy.copy(for already indexable objects) or by converting the object into alist(for non-indexable objects).
There's some chance that making this change may have unintended side effects in some apps
that somehow rely on the current behavior, so we should probably do some testing to see if we
can catch any of these cases before this PR lands in a release. Most likely, though, we'll be willing
to bend SemVer conventions and break any existing apps to make this fix because the current
behavior is quite strange/unintuitive.
Closes #7534