DOC: Update warning in Index.values docstring to clarify index modification which causes segmentation fault
#61069
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
mroeschke
requested changes
Mar 7, 2025
pandas/core/indexes/base.py
Outdated
| @@ -4912,6 +4912,10 @@ def values(self) -> ArrayLike: | |||
| :meth:`Index.to_numpy`, depending on whether you need | |||
| a reference to the underlying data or a NumPy array. | |||
|
|
|||
| Modifying 'Index.values' directly is not supported and can lead to memory | |||
There was a problem hiding this comment.
Instead, could you add a .. versionchanged:: 3.0.0 tag mentioning that the result is read-only?
There was a problem hiding this comment.
@mroeschke thank you for the updates.
please confirm if the below statement should be replaced with the existing one or to modify the first line.
.. versionchanged:: 3.0.0
The result is now read-only, preventing memory corruption or segmentation
faults that could occur when attempting to modify it.
There was a problem hiding this comment.
Probably just
.. versionchanged:: 3.0.0
The returned array is read-only.…cation issues (pandas-dev#60954) with changes
mroeschke
reviewed
Mar 7, 2025
Co-authored-by: Matthew Roeschke <10647082+mroeschke@users.noreply.github.com>
|
@mroeschke Thanks, that was helpful. I made the changes and all the checks are successful. |
mroeschke
approved these changes
Mar 11, 2025
|
Thanks @Manju080 |
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.
Index Modification issues (#60954)
This PR updates the docstring for Index.values to clearly warn users that modifying it directly is not supported and may lead to memory corruption or segmentation faults. It also recommends safe alternatives, such as using
Index.arrayorIndex.to_numpy(copy=True).As per @mroeschke s note, in Pandas 3.0 this operation will raise an error under Copy-on-Write mode, making it clear that modifying is disallowed.
closes #60954