Skip to content

Fix Bug with NA value in Grouping for Groupby.nth #26152

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.

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 17 commits into from
May 5, 2019
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
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/whatsnew/v0.25.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -389,6 +389,7 @@ Groupby/Resample/Rolling
- Ensured that result group order is correct when grouping on an ordered ``Categorical`` and specifying ``observed=True`` (:issue:`25871`, :issue:`25167`)
- Bug in :meth:`pandas.core.window.Rolling.min` and :meth:`pandas.core.window.Rolling.max` that caused a memory leak (:issue:`25893`)
- Bug in :func:`idxmax` and :func:`idxmin` on :meth:`DataFrame.groupby` with datetime column would return incorrect dtype (:issue:`25444`, :issue:`15306`)
- Bug in :meth:`pandas.core.groupby.GroupBy.nth` where NA values in the grouping would return incorrect results (:issue:`26011`)

Reshaping
^^^^^^^^^
Expand Down
17 changes: 11 additions & 6 deletions pandas/core/groupby/groupby.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ class providing the base-class of operations.
import datetime
from functools import partial, wraps
import types
from typing import FrozenSet, Optional, Tuple, Type
from typing import (
cast, Collection, FrozenSet, List, Optional, Tuple, Type, Union)
import warnings

import numpy as np
Expand Down Expand Up @@ -1546,15 +1547,16 @@ def backfill(self, limit=None):

@Substitution(name='groupby')
@Substitution(see_also=_common_see_also)
def nth(self, n, dropna=None):
def nth(self,
n: Union[int, Collection[int]],
Copy link
Member Author

Choose a reason for hiding this comment

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

Could arguably go list-like here if we wanted to try and add to _typing but didn't want to stray too far.

The documentation mentions only supporting lists, though the actual implementation makes accommodations for lists, sets or tuples

Copy link
Contributor

Choose a reason for hiding this comment

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

so generally we would use Sequence then

Copy link
Member Author

@WillAyd WillAyd Apr 19, 2019

Choose a reason for hiding this comment

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

Was thinking that but the isinstance check in the method body also includes set, which wouldn't qualify as a Sequence.

I reverted it to List to keep it simple since Collection isn't available from typing until 3.6 and that is what the documentation shows anyway

dropna: Optional[str] = None) -> DataFrame:
"""
Take the nth row from each group if n is an int, or a subset of rows
if n is a list of ints.

If dropna, will take the nth non-null row, dropna is either
Truthy (if a Series) or 'all', 'any' (if a DataFrame);
this is equivalent to calling dropna(how=dropna) before the
groupby.
'all' or 'any'; this is equivalent to calling dropna(how=dropna)
before the groupby.

Parameters
----------
Expand Down Expand Up @@ -1636,11 +1638,13 @@ def nth(self, n, dropna=None):
-nth_values)
mask = mask_left | mask_right

ids, _, _ = self.grouper.group_info
mask = mask & (ids != -1) # Drop NA values in grouping
Copy link
Contributor

Choose a reason for hiding this comment

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

can you put the comment on the prior line


out = self._selected_obj[mask]
if not self.as_index:
return out

ids, _, _ = self.grouper.group_info
out.index = self.grouper.result_index[ids[mask]]

return out.sort_index() if self.sort else out
Expand All @@ -1665,6 +1669,7 @@ def nth(self, n, dropna=None):

# old behaviour, but with all and any support for DataFrames.
# modified in GH 7559 to have better perf
n = cast(n, int)
max_len = n if n >= 0 else - 1 - n
dropped = self.obj.dropna(how=dropna, axis=self.axis)

Expand Down
17 changes: 17 additions & 0 deletions pandas/tests/groupby/test_nth.py
Original file line number Diff line number Diff line change
Expand Up @@ -434,3 +434,20 @@ def test_nth_column_order():
columns=['C', 'B'],
index=Index([1, 2], name='A'))
assert_frame_equal(result, expected)


@pytest.mark.parametrize("dropna", [None, 'any', 'all'])
def test_nth_nan_in_grouper(dropna):
# GH 26011
df = DataFrame([
[np.nan, 0, 1],
['abc', 2, 3],
[np.nan, 4, 5],
['def', 6, 7],
[np.nan, 8, 9],
], columns=list('abc'))
result = df.groupby('a').nth(0, dropna=dropna)
expected = pd.DataFrame([[2, 3], [6, 7]], columns=list('bc'),
index=Index(['abc', 'def'], name='a'))

assert_frame_equal(result, expected)