Skip to content

Commit 47d2593

Browse files
committed
use maybe_make_list, add doc examples
1 parent 2e02f10 commit 47d2593

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

pandas/core/frame.py

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5376,12 +5376,12 @@ def is_unique(
53765376
self, subset: Optional[Union[Hashable, Sequence[Hashable]]] = None
53775377
) -> Series:
53785378
"""
5379-
Return boolean Series denoting columns with unique values.
5379+
Return boolean Series denoting which columns have unique values.
53805380
53815381
Parameters
53825382
----------
53835383
subset : column label or sequence of labels, optional
5384-
Only consider certain columns for finding uniques. by default use columns.
5384+
Only check subset of columns for uniques. By default checks all columns.
53855385
53865386
Returns
53875387
-------
@@ -5390,9 +5390,32 @@ def is_unique(
53905390
See Also
53915391
--------
53925392
DataFrame.duplicated : Indicate duplicate rows.
5393+
5394+
Examples
5395+
--------
5396+
>>> df = pd.DataFrame([('falcon', 'bird', 389.0),
5397+
... ('parrot', 'bird', 24.0),
5398+
... ('lion', 'mammal', 80.5),
5399+
... ('monkey', 'mammal', np.nan)],
5400+
... columns=('name', 'class', 'max_speed'))
5401+
>>> df
5402+
name class max_speed
5403+
0 falcon bird 389.0
5404+
1 parrot bird 24.0
5405+
2 lion mammal 80.5
5406+
3 monkey mammal NaN
5407+
>>> df.is_unique()
5408+
name True
5409+
class False
5410+
max_speed True
5411+
dtype: bool
5412+
>>> df.is_unique(["name", "class"])
5413+
name True
5414+
class False
5415+
dtype: bool
53935416
"""
53945417
if subset is not None:
5395-
subset = subset if is_list_like(subset) else [subset]
5418+
subset = com.maybe_make_list(subset)
53965419
self = self[subset]
53975420

53985421
if len(self.columns):

0 commit comments

Comments
 (0)