DEPR: subclassing Index #52186
Merged
DEPR: subclassing Index #52186
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
mroeschke
reviewed
Mar 27, 2023
| @@ -31,32 +31,6 @@ There are functions that make the creation of a regular index easy: | |||
| * :func:`period_range`: fixed frequency date range generated from a time rule or | |||
| DateOffset. An ndarray of :class:`Period` objects, representing timespans | |||
|
|
|||
| The motivation for having an ``Index`` class in the first place was to enable | |||
There was a problem hiding this comment.
Would be good to add a .. warning:: block here noting that subclassing an Index is not officially supported and users should use the extension array interface instead
mroeschke
added
Docs
Deprecate
mroeschke
reviewed
Mar 28, 2023
doc/source/development/internals.rst
Outdated
| * :meth:`~Index.delete`: Delete a label, yielding a new object | ||
| * :meth:`~Index.drop`: Deletes a set of labels | ||
| * :meth:`~Index.take`: Analogous to ndarray.take | ||
| .. warning:: Custom :class:`Index` subclasses are not supported, custom behavior should |
There was a problem hiding this comment.
The doc build is failing since the note should start on a new line and indented (similar to .. note:: blocks)
mroeschke
approved these changes
Mar 29, 2023
|
Thanks @jbrockmendel |
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.
pandas.Indexcannot be subclassed (despite saying it can be in the docs) #37882doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.This is just a docs change, removing the wording that suggests we explicitly support subclassing Index. So it shouldn't break any implementations in the wild.