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

Jump to bottom

ENH: Reduce type requirements for the subset parameter in drop_duplicates/duplicated #59237

Closed
1 of 3 tasks
behrenhoff opened this issue Jul 12, 2024 · 5 comments · Fixed by #59392
Closed
1 of 3 tasks

ENH: Reduce type requirements for the subset parameter in drop_duplicates/duplicated #59237

behrenhoff opened this issue Jul 12, 2024 · 5 comments · Fixed by #59392
Assignees
@kirill-bash
Labels
duplicated duplicated, drop_duplicates Enhancement
Milestone
3.0

Comments

@behrenhoff
Copy link
Contributor

Feature Type

  • Adding new functionality to pandas

  • Changing existing functionality in pandas

  • Removing existing functionality in pandas

Problem Description

I would like to pass a set to drop_duplicates like so:

df = get_some_df()
subset = {"column1", "column3"}
df_dropped = df.drop_duplicates(subset=subset)

According to type hints, subset is a Hashable | Sequence[Hashable] | None. The documentation says "column label or sequence of labels, optional".

The problem is, I would like to pass a set of columns. The name subset suggests that should be ok. And it does work indeed. However, a set is not a Sequence.

Can the requirements be lowered? Maybe to Collection? (or even Iterable, but that might come with problems).

Looking at the code: https://github.com/pandas-dev/pandas/blob/v2.2.2/pandas/core/frame.py#L6935

It checks if the subset is np.iterable, then a set is created and len(subset) is called. This could be done with collections as well.

Am I missing anything or could this Sequence be make a Collection?

Feature Description

If I am not mistaken, Sequence could simply be replaced with Collection in duplicated as well as drop_duplicates in the docu.

Alternative Solutions

no alt solution required

Additional Context

No response
@behrenhoff behrenhoff added Enhancement Needs Triage Issue that has not been reviewed by a pandas team member labels Jul 12, 2024
@kirill-bash
Copy link
Contributor

Take

kirill-bash added a commit to kirill-bash/pandas that referenced this issue Aug 2, 2024
@kirill-bash
ENH: pandas-dev#59237
7a8f343
kirill-bash added a commit to kirill-bash/pandas that referenced this issue Aug 2, 2024
@kirill-bash
ENH: pandas-dev#59237
39cb4ca
@kirill-bash kirill-bash mentioned this issue Aug 2, 2024
Merged
5 tasks
@rhshadrach
Copy link
Member

This seems reasonable to me; cc @pandas-dev/pandas-core for any thoughts on the expansion of this parameter to sets. In the past, we've explicitly raised on sets for some arguments, but I believe in those cases it was because order mattered. Here, order does not matter.

@rhshadrach rhshadrach added Needs Discussion Requires discussion from core team before further action and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Aug 5, 2024
@Dr-Irv
Copy link
Contributor

Dr-Irv commented Aug 5, 2024

I think this is a documentation and typing issue, not a code issue.

>>> df=pd.DataFrame.from_records([[1,2,3,4], [5,6,7,8], [10,20,3,4], [50,60,7,8]
], columns=["a", "b", "c", "d"])
>>> df
    a   b  c  d
0   1   2  3  4
1   5   6  7  8
2  10  20  3  4
3  50  60  7  8
>>> df.drop_duplicates(subset=["c", "d"])
   a  b  c  d
0  1  2  3  4
1  5  6  7  8
>>> df.drop_duplicates(subset=set(["c", "d"]))
   a  b  c  d
0  1  2  3  4
1  5  6  7  8

So you can pass a set today, but typing isn't allowing it if you are using pandas source to type check your code instead of pandas-stubs (which is the recommended way to type check user code)

I would suggest making a change here, but also in pandas-stubs at https://github.com/pandas-dev/pandas-stubs/blob/1846b34a44c41f151863fd5f9c20c4bc6a322d52/pandas-stubs/core/frame.pyi#L903 where we have yet to create a type for the subset argument.

@kirill-bash
Copy link
Contributor

kirill-bash commented Aug 7, 2024 •
edited
Loading

@Dr-Irv,

That is generally true except for single element sets.
My current PR should address that though.

>>> df=pd.DataFrame.from_records([[1,2,3,4], [5,6,7,8], [10,20,3,4], [50,60,7,8]
], columns=["a", "b", "c", "d"])
>>> df
    a   b  c  d
0   1   2  3  4
1   5   6  7  8
2  10  20  3  4
3  50  60  7  8
>>> df.drop_duplicates(subset=["c"])
   a  b  c  d
0  1  2  3  4
1  5  6  7  8
>>> df.drop_duplicates(subset=set(["c"]))
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/bb/bin/python/lib/python3.11/site-packages/pandas/core/frame.py", line 6802, in drop_duplicates
    result = self[-self.duplicated(subset, keep=keep)]
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/bb/bin/python/lib/python3.11/site-packages/pandas/core/frame.py", line 6938, in duplicated
    result = self[subset[0]].duplicated(keep)
                  ~~~~~~^^^
TypeError: 'set' object is not subscriptable

@Dr-Irv
Copy link
Contributor

Dr-Irv commented Aug 7, 2024

That is generally true except for single element sets. My current PR should address that though.

OK, that makes sense.

@rhshadrach rhshadrach removed the Needs Discussion Requires discussion from core team before further action label Aug 7, 2024
@rhshadrach rhshadrach added this to the 3.0 milestone Aug 13, 2024
@rhshadrach rhshadrach added the duplicated duplicated, drop_duplicates label Aug 13, 2024
@kirill-bash kirill-bash mentioned this issue Aug 26, 2024
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kirill-bash kirill-bash

Labels
duplicated duplicated, drop_duplicates Enhancement
Projects
None yet
Milestone
3.0
Development

Successfully merging a pull request may close this issue.

ENH: Allow Iterable[Hashable] in drop_duplicates kirill-bash/pandas
4 participants
@behrenhoff @Dr-Irv @rhshadrach @kirill-bash