Return a copy from get_index - #11563
Open
chiruu12 wants to merge 1 commit into
Open
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
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.
Fixes #2949.
get_indexreturned the stored pandas index. pandas allows.nameto be set in place, so a caller could rename the coordinate of the array or dataset they got the index from:Datasetwas affected the same way, sinceget_indexlives onDataWithCoords.The change is a
copy(deep=False)on the way out. #3126 proposed the same fix in 2019 and stalled on a question about whether it would cost anything, which nobody answered. It does not. A shallow copy of a pandas index is constant time, since the object is immutable and the copy shares the same array:pandas 3.0.5, mean of 10000 calls. The comment at
xarray/core/variable.py:3005already states this.Scope note.
Indexes.__getitem__still returns the stored object, sods.indexes["x"]is unchanged.xarray/tests/test_indexes.py:630asserts that identity, so copying there is an API decision rather than a bug fix, and I left it alone.to_index()andto_dataframe()were already safe because they route throughset_names().Tests: one in
test_dataarray.pyand one intest_dataset.py. Both fail on main and pass here.