Skip to content
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

DOC: Add MultiIndex.get_locs to generated reference #30234

Merged
merged 2 commits into from
Dec 12, 2019
Merged

DOC: Add MultiIndex.get_locs to generated reference #30234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3dbbf97
DOC: Add MultiIndex.get_locs to generated reference
jorisvandenbossche Dec 12, 2019
418dedf
fixups
TomAugspurger Dec 12, 2019
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
1 change: 1 addition & 0 deletions doc/source/reference/indexing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,7 @@ MultiIndex selecting
:toctree: api/

MultiIndex.get_loc
MultiIndex.get_locs
MultiIndex.get_loc_level
MultiIndex.get_indexer
MultiIndex.get_level_values
Expand Down
26 changes: 13 additions & 13 deletions pandas/core/indexes/multi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2879,37 +2879,37 @@ def convert_indexer(start, stop, step, indexer=indexer, codes=level_codes):

def get_locs(self, seq):
"""
Get location for a given label/slice/list/mask or a sequence of such as
an array of integers.
Get location for a sequence of labels.

Parameters
----------
seq : label/slice/list/mask or a sequence of such
seq : label, slice, list, mask or a sequence of such
You should use one of the above for each level.
If a level should not be used, set it to ``slice(None)``.

Returns
-------
locs : array of integers suitable for passing to iloc
numpy.ndarray
NumPy array of integers suitable for passing to iloc.

See Also
--------
MultiIndex.get_loc : Get location for a label or a tuple of labels.
MultiIndex.slice_locs : Get slice location given start label(s) and
end label(s).

Examples
--------
>>> mi = pd.MultiIndex.from_arrays([list('abb'), list('def')])

>>> mi.get_locs('b')
>>> mi.get_locs('b') # doctest: +SKIP
Copy link
Contributor

Choose a reason for hiding this comment

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

These were failing on the dtype=int64 part. That's only present in the repr on 32-bit systems IIRC, so easier to skip.

array([1, 2], dtype=int64)

>>> mi.get_locs([slice(None), ['e', 'f']])
>>> mi.get_locs([slice(None), ['e', 'f']]) # doctest: +SKIP
array([1, 2], dtype=int64)

>>> mi.get_locs([[True, False, True], slice('e', 'f')])
>>> mi.get_locs([[True, False, True], slice('e', 'f')]) # doctest: +SKIP
array([2], dtype=int64)

See Also
--------
MultiIndex.get_loc : Get location for a label or a tuple of labels.
MultiIndex.slice_locs : Get slice location given start label(s) and
end label(s).
"""
from .numeric import Int64Index

Expand Down