Skip to content

GH1214 Improve typehinting for DataFrame.unstack #1215

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 2 commits into from
May 16, 2025
Merged

GH1214 Improve typehinting for DataFrame.unstack #1215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a860d0f
GH1214 Improve typehinting for DataFrame.unstack
loicdiridollou May 16, 2025
23adb71
GH1214 Fix test
loicdiridollou May 16, 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
3 changes: 2 additions & 1 deletion pandas-stubs/core/frame.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1300,7 +1300,8 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack):
def unstack(
self,
level: Level = ...,
fill_value: int | _str | dict | None = ...,
fill_value: Scalar | None = ...,
sort: _bool = ...,
) -> Self | Series: ...
def melt(
self,
Expand Down
61 changes: 61 additions & 0 deletions tests/test_frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4339,3 +4339,64 @@ def test_df_loc_dict() -> None:

df.iloc[0] = {"X": 0}
check(assert_type(df, pd.DataFrame), pd.DataFrame)


def test_unstack() -> None:
"""Test different types of argument for `fill_value` in DataFrame.unstack."""
df = pd.DataFrame(
[
["a", "b", pd.Timestamp(2021, 3, 2)],
["a", "a", pd.Timestamp(2023, 4, 2)],
["b", "b", pd.Timestamp(2024, 3, 2)],
]
).set_index([0, 1])
df_sr = pd.DataFrame(
[
["a", "b", "abc"],
["a", "a", "def"],
["b", "b", "ghi"],
]
).set_index([0, 1])
df_flt = pd.DataFrame(
[
["a", "b", 1],
["a", "a", 12],
["b", "b", 14],
]
).set_index([0, 1])

check(assert_type(df.unstack(0), pd.DataFrame | pd.Series), pd.DataFrame)
check(
assert_type(
df.unstack(1, fill_value=pd.Timestamp(2023, 4, 5)), pd.DataFrame | pd.Series
),
pd.DataFrame,
)
check(
assert_type(df_flt.unstack(1, fill_value=0.0), pd.DataFrame | pd.Series),
pd.DataFrame,
)
check(
assert_type(df_flt.unstack(1, fill_value=1), pd.DataFrame | pd.Series),
pd.DataFrame,
)
check(
assert_type(df_sr.unstack(1, fill_value="string"), pd.DataFrame | pd.Series),
pd.DataFrame,
)
check(
assert_type(df.unstack(0, sort=False), pd.DataFrame | pd.Series), pd.DataFrame
)
check(
assert_type(
df.unstack(1, fill_value=pd.Timestamp(2023, 4, 5), sort=True),
pd.DataFrame | pd.Series,
),
pd.DataFrame,
)
check(
assert_type(
df_flt.unstack(1, fill_value=0.0, sort=False), pd.DataFrame | pd.Series
),
pd.DataFrame,
)