Skip to content

GH984 Add overload for DataFrame.clip and update those for Series.clip #1206

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
May 1, 2025
Merged

GH984 Add overload for DataFrame.clip and update those for Series.clip #1206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
996298b
GH984 Add overload for DataFrame.clip and update those for Series.clip
loicdiridollou Apr 29, 2025
f2390b2
GH984 PR feedback
loicdiridollou Apr 30, 2025
41bcadd
GH984 drop duplicate tests
loicdiridollou Apr 30, 2025
475aa98
GH984 PR feedback
loicdiridollou May 1, 2025
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
64 changes: 57 additions & 7 deletions pandas-stubs/core/frame.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1738,23 +1738,73 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack):
@overload
def clip(
self,
lower: float | AnyArrayLike | None = ...,
upper: float | AnyArrayLike | None = ...,
lower: float | None = ...,
upper: float | None = ...,
*,
axis: Axis | None = ...,
inplace: Literal[True],
inplace: Literal[False] = ...,
**kwargs: Any,
) -> None: ...
) -> Self: ...
@overload
def clip(
self,
lower: float | AnyArrayLike | None = ...,
upper: float | AnyArrayLike | None = ...,
lower: AnyArrayLike = ...,
upper: AnyArrayLike | None = ...,
*,
axis: Axis | None = ...,
axis: Axis = ...,
inplace: Literal[False] = ...,
**kwargs: Any,
) -> Self: ...
@overload
def clip(
self,
lower: AnyArrayLike | None = ...,
upper: AnyArrayLike = ...,
*,
axis: Axis = ...,
inplace: Literal[False] = ...,
**kwargs: Any,
) -> Self: ...
@overload
def clip( # pyright: ignore[reportOverlappingOverload]
self,
lower: None = ...,
upper: None = ...,
*,
axis: Axis | None = ...,
inplace: Literal[True],
**kwargs: Any,
) -> Self: ...
@overload
def clip(
self,
lower: float | None = ...,
upper: float | None = ...,
*,
axis: Axis | None = ...,
inplace: Literal[True],
**kwargs: Any,
) -> None: ...
@overload
def clip(
self,
lower: AnyArrayLike = ...,
upper: AnyArrayLike | None = ...,
*,
axis: Axis = ...,
inplace: Literal[True],
**kwargs: Any,
) -> None: ...
@overload
def clip(
self,
lower: AnyArrayLike | None = ...,
upper: AnyArrayLike = ...,
*,
axis: Axis = ...,
inplace: Literal[True],
**kwargs: Any,
) -> None: ...
def copy(self, deep: _bool = ...) -> Self: ...
def cummax(
self, axis: Axis | None = ..., skipna: _bool = ..., *args: Any, **kwargs: Any
Expand Down
10 changes: 10 additions & 0 deletions pandas-stubs/core/series.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1394,6 +1394,16 @@ class Series(IndexOpsMixin[S1], NDFrame):
subset: _str | Sequence[_str] | None = ...,
) -> Scalar | Series[S1]: ...
@overload
def clip( # pyright: ignore[reportOverlappingOverload]
self,
lower: None = ...,
upper: None = ...,
*,
axis: AxisIndex | None = ...,
inplace: Literal[True],
**kwargs: Any,
) -> Self: ...
@overload
def clip(
self,
lower: AnyArrayLike | float | None = ...,
Expand Down
227 changes: 211 additions & 16 deletions tests/test_frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -659,23 +659,218 @@ def test_types_quantile() -> None:
df.quantile(np.array([0.25, 0.75]))


@pytest.mark.parametrize("lower", [None, 5, pd.Series([3, 4])])
@pytest.mark.parametrize("upper", [None, 15, pd.Series([12, 13])])
@pytest.mark.parametrize("axis", [None, 0, "index"])
def test_types_clip(lower, upper, axis) -> None:
def is_none_or_numeric(val: Any) -> bool:
return val is None or isinstance(val, int | float)

def test_dataframe_clip() -> None:
"""Test different clipping combinations for dataframe."""
df = pd.DataFrame(data={"col1": [20, 12], "col2": [3, 14]})
uses_array = not (is_none_or_numeric(lower) and is_none_or_numeric(upper))
if uses_array and axis is None:
with pytest.raises(ValueError):
df.clip(lower=lower, upper=upper, axis=axis)
else:
check(
assert_type(df.clip(lower=lower, upper=upper, axis=axis), pd.DataFrame),
pd.DataFrame,
)
if TYPE_CHECKING_INVALID_USAGE:
df.clip(lower=pd.Series([4, 5]), upper=None, axis=None) # type: ignore[call-overload] # pyright: ignore[reportCallIssue, reportArgumentType]
df.clip(lower=None, upper=pd.Series([4, 5]), axis=None) # type: ignore[call-overload] # pyright: ignore[reportCallIssue, reportArgumentType]
df.clip(lower=pd.Series([1, 2]), upper=pd.Series([4, 5]), axis=None) # type: ignore[call-overload] # pyright: ignore[reportCallIssue, reportArgumentType]
df.copy().clip(lower=pd.Series([1, 2]), upper=None, axis=None, inplace=True) # type: ignore[call-overload] # pyright: ignore[reportCallIssue, reportArgumentType]
df.copy().clip(lower=None, upper=pd.Series([1, 2]), axis=None, inplace=True) # type: ignore[call-overload] # pyright: ignore[reportCallIssue, reportArgumentType]
df.copy().clip(lower=pd.Series([4, 5]), upper=pd.Series([1, 2]), axis=None, inplace=True) # type: ignore[call-overload] # pyright: ignore[reportCallIssue, reportArgumentType]

check(
assert_type(df.clip(lower=None, upper=None, axis=None), pd.DataFrame),
pd.DataFrame,
)
check(
assert_type(df.clip(lower=5, upper=None, axis=None), pd.DataFrame), pd.DataFrame
)
check(
assert_type(df.clip(lower=None, upper=15, axis=None), pd.DataFrame),
pd.DataFrame,
)
check(
assert_type(
df.clip(lower=None, upper=None, axis=None, inplace=True), pd.DataFrame
),
pd.DataFrame,
)
check(
assert_type(df.clip(lower=5, upper=None, axis=None, inplace=True), None),
type(None),
)
check(
assert_type(df.clip(lower=None, upper=15, axis=None, inplace=True), None),
type(None),
)

check(
assert_type(df.clip(lower=None, upper=None, axis=0), pd.DataFrame), pd.DataFrame
)
check(assert_type(df.clip(lower=5, upper=None, axis=0), pd.DataFrame), pd.DataFrame)
check(
assert_type(df.clip(lower=None, upper=15, axis=0), pd.DataFrame), pd.DataFrame
)
check(
assert_type(df.clip(lower=pd.Series([1, 2]), upper=None, axis=0), pd.DataFrame),
pd.DataFrame,
)
check(
assert_type(df.clip(lower=None, upper=pd.Series([1, 2]), axis=0), pd.DataFrame),
pd.DataFrame,
)
check(
assert_type(
df.clip(lower=None, upper=None, axis="index", inplace=True), pd.DataFrame
),
pd.DataFrame,
)
check(
assert_type(df.clip(lower=5, upper=None, axis="index", inplace=True), None),
type(None),
)
check(
assert_type(df.clip(lower=None, upper=15, axis="index", inplace=True), None),
type(None),
)
check(
assert_type(
df.clip(lower=pd.Series([1, 2]), upper=None, axis="index", inplace=True),
None,
),
type(None),
)
check(
assert_type(
df.clip(lower=None, upper=pd.Series([1, 2]), axis="index", inplace=True),
None,
),
type(None),
)
check(
assert_type(df.clip(lower=None, upper=None, axis="index"), pd.DataFrame),
pd.DataFrame,
)
check(
assert_type(df.clip(lower=5, upper=None, axis="index"), pd.DataFrame),
pd.DataFrame,
)
check(
assert_type(df.clip(lower=None, upper=15, axis="index"), pd.DataFrame),
pd.DataFrame,
)
check(
assert_type(
df.clip(lower=pd.Series([1, 2]), upper=None, axis="index"), pd.DataFrame
),
pd.DataFrame,
)
check(
assert_type(
df.clip(lower=None, upper=pd.Series([1, 2]), axis="index"), pd.DataFrame
),
pd.DataFrame,
)
check(
assert_type(
df.clip(lower=None, upper=None, axis=0, inplace=True), pd.DataFrame
),
pd.DataFrame,
)
check(
assert_type(df.clip(lower=5, upper=None, axis=0, inplace=True), None),
type(None),
)
check(
assert_type(df.clip(lower=None, upper=15, axis=0, inplace=True), None),
type(None),
)

# without lower
check(assert_type(df.clip(upper=None, axis=None), pd.DataFrame), pd.DataFrame)
check(assert_type(df.clip(upper=15, axis=None), pd.DataFrame), pd.DataFrame)
check(
assert_type(df.clip(upper=None, axis=None, inplace=True), pd.DataFrame),
pd.DataFrame,
)
check(assert_type(df.clip(upper=15, axis=None, inplace=True), None), type(None))

check(assert_type(df.clip(upper=None, axis=0), pd.DataFrame), pd.DataFrame)
check(assert_type(df.clip(upper=15, axis=0), pd.DataFrame), pd.DataFrame)
check(
assert_type(df.clip(upper=pd.Series([1, 2]), axis=0), pd.DataFrame),
pd.DataFrame,
)
check(
assert_type(df.clip(upper=None, axis="index", inplace=True), pd.DataFrame),
pd.DataFrame,
)
check(
assert_type(df.clip(upper=15, axis="index", inplace=True), None),
type(None),
)
check(
assert_type(df.clip(upper=pd.Series([1, 2]), axis="index", inplace=True), None),
type(None),
)
check(assert_type(df.clip(upper=None, axis="index"), pd.DataFrame), pd.DataFrame)
check(assert_type(df.clip(upper=15, axis="index"), pd.DataFrame), pd.DataFrame)
check(
assert_type(df.clip(upper=pd.Series([1, 2]), axis="index"), pd.DataFrame),
pd.DataFrame,
)
check(
assert_type(df.clip(upper=None, axis=0, inplace=True), pd.DataFrame),
pd.DataFrame,
)
check(assert_type(df.clip(upper=15, axis=0, inplace=True), None), type(None))

# without upper
check(
assert_type(df.clip(lower=None, axis=None), pd.DataFrame),
pd.DataFrame,
)
check(assert_type(df.clip(lower=5, axis=None), pd.DataFrame), pd.DataFrame)
check(
assert_type(df.clip(lower=None, axis=None, inplace=True), pd.DataFrame),
pd.DataFrame,
)
check(
assert_type(df.clip(lower=5, axis=None, inplace=True), None),
type(None),
)
check(
assert_type(df.clip(lower=None, axis=None, inplace=True), pd.DataFrame),
pd.DataFrame,
)

check(assert_type(df.clip(lower=None, axis=0), pd.DataFrame), pd.DataFrame)
check(assert_type(df.clip(lower=5, axis=0), pd.DataFrame), pd.DataFrame)
check(
assert_type(df.clip(lower=pd.Series([1, 2]), axis=0), pd.DataFrame),
pd.DataFrame,
)
check(
assert_type(df.clip(lower=None, axis="index", inplace=True), pd.DataFrame),
pd.DataFrame,
)
check(
assert_type(df.clip(lower=5, axis="index", inplace=True), None),
type(None),
)
check(
assert_type(df.clip(lower=pd.Series([1, 2]), axis="index", inplace=True), None),
type(None),
)
check(
assert_type(df.clip(lower=None, axis="index"), pd.DataFrame),
pd.DataFrame,
)
check(
assert_type(df.clip(lower=5, axis="index"), pd.DataFrame),
pd.DataFrame,
)
check(
assert_type(df.clip(lower=pd.Series([1, 2]), axis="index"), pd.DataFrame),
pd.DataFrame,
)
check(
assert_type(df.clip(lower=None, axis=0, inplace=True), pd.DataFrame),
pd.DataFrame,
)
check(assert_type(df.clip(lower=5, axis=0, inplace=True), None), type(None))


def test_types_abs() -> None:
Expand Down
Loading