Skip to content

Update description of Index._values/values/ndarray_values #23507

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 8, 2018
Merged

Update description of Index._values/values/ndarray_values #23507

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8e14743
Update description of Index._values/values/ndarray_values
jorisvandenbossche Nov 5, 2018
ad6a4a4
codes -> ndarray[int]
jorisvandenbossche Nov 5, 2018
e58914f
Merge remote-tracking branch 'upstream/master' into jorisvandenbossch…
TomAugspurger Nov 6, 2018
36543b9
merge master [ci skip]
TomAugspurger Nov 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 9 additions & 13 deletions pandas/core/indexes/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -709,7 +709,7 @@ def values(self):

@property
def _values(self):
# type: () -> Union[ExtensionArray, Index]
# type: () -> Union[ExtensionArray, Index, np.ndarray]
# TODO(EA): remove index types as they become extension arrays
"""The best array representation.

Expand All @@ -721,18 +721,14 @@ def _values(self):

It may differ from the public '.values' method.

index | values | _values | _ndarray_values |
----------------- | -------------- -| ----------- | --------------- |
CategoricalIndex | Categorical | Categorical | codes |
DatetimeIndex[tz] | ndarray[M8ns] | DTI[tz] | ndarray[M8ns] |

For the following, the ``._values`` is currently ``ndarray[object]``,
but will soon be an ``ExtensionArray``

index | values | _values | _ndarray_values |
----------------- | --------------- | ------------ | --------------- |
PeriodIndex | ndarray[object] | ndarray[obj] | ndarray[int] |
IntervalIndex | ndarray[object] | ndarray[obj] | ndarray[object] |
index | values | _values | _ndarray_values |
----------------- | --------------- | ------------- | --------------- |
Index | ndarray | ndarray | ndarray |
CategoricalIndex | Categorical | Categorical | codes |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

codes -> ndarray[int]

DatetimeIndex | ndarray[M8ns] | ndarray[M8ns] | ndarray[M8ns] |
DatetimeIndex[tz] | ndarray[M8ns] | DTI[tz] | ndarray[M8ns] |
PeriodIndex | ndarray[object] | PeriodArray | ndarray[int] |
IntervalIndex | IntervalArray | IntervalArray | ndarray[object] |

See Also
--------
Expand Down