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.

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
Changes from 2 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
111 changes: 111 additions & 0 deletions tests/test_frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -778,6 +778,117 @@ def test_dataframe_clip() -> 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=None, 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", inplace=True), pd.DataFrame),
pd.DataFrame,
)
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=None, 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="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))
check(
assert_type(df.clip(lower=None, axis=0, inplace=True), pd.DataFrame),
pd.DataFrame,
)


def test_types_abs() -> None:
df = pd.DataFrame(data={"col1": [-5, 1], "col2": [3, -14]})
Expand Down