Skip to content

Review inplace parameter #58

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 5 commits into from
Jul 1, 2022
Merged

Review inplace parameter #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
48a08e1
series
crusaderky Jul 1, 2022
5292314
frame
crusaderky Jul 1, 2022
b05dab3
fix
crusaderky Jul 1, 2022
c4efa58
assert_types
crusaderky Jul 1, 2022
c604569
Add references to issue
crusaderky Jul 1, 2022
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: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,9 @@ venv.bak/
# Rope project settings
.ropeproject

# PyCharm project settings
.idea/

# mkdocs documentation
/site

Expand Down
17 changes: 3 additions & 14 deletions pandas-stubs/core/frame.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -544,18 +544,7 @@ class DataFrame(NDFrame, OpsMixin):
self,
to_replace=...,
value: Optional[Union[Scalar, Sequence, Mapping, Pattern]] = ...,
limit: Optional[int] = ...,
regex=...,
method: Optional[_str] = ...,
*,
inplace: Literal[False],
) -> DataFrame: ...
@overload
def replace(
self,
to_replace=...,
value: Optional[Union[Scalar, Sequence, Mapping, Pattern]] = ...,
*,
inplace: Literal[False] = ...,
limit: Optional[int] = ...,
regex=...,
method: Optional[_str] = ...,
Expand Down Expand Up @@ -1238,7 +1227,7 @@ class DataFrame(NDFrame, OpsMixin):
self,
axis: Optional[AxisType] = ...,
*,
inplace: Literal[False],
inplace: Literal[False] = ...,
limit: Optional[int] = ...,
downcast: Optional[Dict] = ...,
) -> DataFrame: ...
Expand Down Expand Up @@ -1327,7 +1316,7 @@ class DataFrame(NDFrame, OpsMixin):
self,
axis: Optional[AxisType] = ...,
*,
inplace: Literal[False],
inplace: Literal[False] = ...,
limit: Optional[int] = ...,
downcast: Optional[Dict] = ...,
) -> DataFrame: ...
Expand Down
56 changes: 27 additions & 29 deletions pandas-stubs/core/series.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -467,18 +467,7 @@ class Series(IndexOpsMixin, NDFrame, Generic[S1]):
na_position: Union[_str, Literal["first", "last"]] = ...,
ignore_index: _bool = ...,
*,
inplace: Literal[False],
key: Optional[Callable] = ...,
) -> Series[S1]: ...
@overload
def sort_values(
self,
axis: AxisType = ...,
ascending: Union[_bool, Sequence[_bool]] = ...,
*,
kind: Union[_str, Literal["quicksort", "mergesort", "heapsort"]] = ...,
na_position: Union[_str, Literal["first", "last"]] = ...,
ignore_index: _bool = ...,
inplace: Literal[False] = ...,
key: Optional[Callable] = ...,
) -> Series[S1]: ...
@overload
Expand Down Expand Up @@ -517,20 +506,7 @@ class Series(IndexOpsMixin, NDFrame, Generic[S1]):
sort_remaining: _bool = ...,
ignore_index: _bool = ...,
*,
inplace: Literal[False],
key: Optional[Callable] = ...,
) -> Series: ...
@overload
def sort_index(
self,
axis: AxisType = ...,
level: Optional[Union[Level, List[int], List[_str]]] = ...,
ascending: Union[_bool, Sequence[_bool]] = ...,
*,
kind: Union[_str, Literal["quicksort", "mergesort", "heapsort"]] = ...,
na_position: Union[_str, Literal["first", "last"]] = ...,
sort_remaining: _bool = ...,
ignore_index: _bool = ...,
inplace: Literal[False] = ...,
key: Optional[Callable] = ...,
) -> Series: ...
@overload
Expand Down Expand Up @@ -747,15 +723,37 @@ class Series(IndexOpsMixin, NDFrame, Generic[S1]):
limit: Optional[int] = ...,
downcast: Optional[Dict] = ...,
) -> Union[Series[S1], None]: ...
@overload
def replace(
self,
to_replace: Optional[Union[_str, List, Dict, Series[S1], int, float]] = ...,
value: Optional[Union[Scalar, Dict, List, _str]] = ...,
inplace: _bool = ...,
inplace: Literal[False] = ...,
limit: Optional[int] = ...,
regex=...,
method: Optional[Union[_str, Literal["pad", "ffill", "bfill"]]] = ...,
) -> Series[S1]: ...
@overload
def replace(
self,
to_replace: Optional[Union[_str, List, Dict, Series[S1], int, float]] = ...,
value: Optional[Union[Scalar, Dict, List, _str]] = ...,
limit: Optional[int] = ...,
regex=...,
method: Optional[Union[_str, Literal["pad", "ffill", "bfill"]]] = ...,
*,
inplace: Literal[True],
) -> None: ...
@overload
def replace(
self,
to_replace: Optional[Union[_str, List, Dict, Series[S1], int, float]] = ...,
value: Optional[Union[Scalar, Dict, List, _str]] = ...,
inplace: _bool = ...,
limit: Optional[int] = ...,
regex=...,
method: Optional[Union[_str, Literal["pad", "ffill", "bfill"]]] = ...,
) -> Union[Series[S1], None]: ...
def shift(
self,
periods: int = ...,
Expand Down Expand Up @@ -878,7 +876,7 @@ class Series(IndexOpsMixin, NDFrame, Generic[S1]):
self,
axis: Optional[SeriesAxisType] = ...,
*,
inplace: Literal[False],
inplace: Literal[False] = ...,
limit: Optional[int] = ...,
downcast: Optional[Dict] = ...,
) -> Series[S1]: ...
Expand All @@ -896,7 +894,7 @@ class Series(IndexOpsMixin, NDFrame, Generic[S1]):
self,
axis: Optional[SeriesAxisType] = ...,
*,
inplace: Literal[False],
inplace: Literal[False] = ...,
limit: Optional[int] = ...,
downcast: Optional[Dict] = ...,
) -> Series[S1]: ...
Expand Down
24 changes: 24 additions & 0 deletions tests/test_frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1020,3 +1020,27 @@ def test_join() -> None:
frameCD = float_frame[["C", "D"]]
right: List[Union[pd.Series, pd.DataFrame]] = [seriesB, frameCD]
result = left.join(right)


def test_types_ffill() -> None:
# GH 44
df = pd.DataFrame([[1, 2, 3]])
assert_type(df.ffill(), pd.DataFrame)
assert_type(df.ffill(inplace=False), pd.DataFrame)
assert_type(df.ffill(inplace=True), None)


def test_types_bfill() -> None:
# GH 44
df = pd.DataFrame([[1, 2, 3]])
assert_type(df.bfill(), pd.DataFrame)
assert_type(df.bfill(inplace=False), pd.DataFrame)
assert_type(df.bfill(inplace=True), None)


def test_types_replace() -> None:
# GH 44
df = pd.DataFrame([[1, 2, 3]])
assert_type(df.replace(1, 2), pd.DataFrame)
assert_type(df.replace(1, 2, inplace=False), pd.DataFrame)
assert_type(df.replace(1, 2, inplace=True), None)
62 changes: 37 additions & 25 deletions tests/test_series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,11 +146,11 @@ def test_types_setting() -> None:

def test_types_drop() -> None:
s = pd.Series([0, 1, 2])
res: pd.Series = s.drop(0)
res2: pd.Series = s.drop([0, 1])
res3: pd.Series = s.drop(0, axis=0)
res4: None = s.drop([0, 1], inplace=True, errors="raise")
res5: None = s.drop([0, 1], inplace=True, errors="ignore")
assert_type(s.drop(0), pd.Series)
assert_type(s.drop([0, 1]), pd.Series)
assert_type(s.drop(0, axis=0), pd.Series)
assert_type(s.drop([0, 1], inplace=True, errors="raise"), None)
assert_type(s.drop([0, 1], inplace=True, errors="ignore"), None)


def test_types_drop_multilevel() -> None:
Expand All @@ -164,25 +164,26 @@ def test_types_drop_multilevel() -> None:

def test_types_dropna() -> None:
s = pd.Series([1, np.nan, np.nan])
res: pd.Series = s.dropna()
res2: None = s.dropna(axis=0, inplace=True)
assert_type(s.dropna(), pd.Series)
assert_type(s.dropna(axis=0, inplace=True), None)


def test_types_fillna() -> None:
s = pd.Series([1, np.nan, np.nan, 3])
res: pd.Series = s.fillna(0)
res2: pd.Series = s.fillna(0, axis="index")
res3: pd.Series = s.fillna(method="backfill", axis=0)
res4: None = s.fillna(method="bfill", inplace=True)
res5: pd.Series = s.fillna(method="pad")
res6: pd.Series = s.fillna(method="ffill", limit=1)
assert_type(s.fillna(0), pd.Series)
assert_type(s.fillna(0, axis="index"), pd.Series)
assert_type(s.fillna(method="backfill", axis=0), pd.Series)
assert_type(s.fillna(method="bfill", inplace=True), None)
assert_type(s.fillna(method="pad"), pd.Series)
assert_type(s.fillna(method="ffill", limit=1), pd.Series)


def test_types_sort_index() -> None:
s = pd.Series([1, 2, 3], index=[2, 3, 1])
res: pd.Series = s.sort_index()
res2: None = s.sort_index(ascending=False, inplace=True)
res3: pd.Series = s.sort_index(kind="mergesort")
assert_type(s.sort_index(), pd.Series)
assert_type(s.sort_index(ascending=False), pd.Series)
assert_type(s.sort_index(ascending=False, inplace=True), None)
assert_type(s.sort_index(kind="mergesort"), pd.Series)


# This was added in 1.1.0 https://pandas.pydata.org/docs/whatsnew/v1.1.0.html
Expand All @@ -193,11 +194,12 @@ def test_types_sort_index_with_key() -> None:

def test_types_sort_values() -> None:
s = pd.Series([4, 2, 1, 3])
res: pd.Series = s.sort_values(0)
res2: pd.Series = s.sort_values(ascending=False)
res3: None = s.sort_values(inplace=True, kind="quicksort")
res4: pd.Series = s.sort_values(na_position="last")
res5: pd.Series = s.sort_values(ignore_index=True)
assert_type(s.sort_values(), pd.Series)
assert_type(s.sort_values(0), pd.Series)
assert_type(s.sort_values(ascending=False), pd.Series)
assert_type(s.sort_values(inplace=True, kind="quicksort"), None)
assert_type(s.sort_values(na_position="last"), pd.Series)
assert_type(s.sort_values(ignore_index=True), pd.Series)


# This was added in 1.1.0 https://pandas.pydata.org/docs/whatsnew/v1.1.0.html
Expand Down Expand Up @@ -547,8 +549,9 @@ def test_types_ne() -> None:

def test_types_bfill() -> None:
s1 = pd.Series([1, 2, 3])
s2: pd.Series = s1.bfill(inplace=False)
s3: None = s1.bfill(inplace=True)
assert_type(s1.bfill(), pd.Series)
assert_type(s1.bfill(inplace=False), pd.Series)
assert_type(s1.bfill(inplace=True), None)


def test_types_ewm() -> None:
Expand All @@ -563,8 +566,9 @@ def test_types_ewm() -> None:

def test_types_ffill() -> None:
s1 = pd.Series([1, 2, 3])
s2: pd.Series = s1.ffill(inplace=False)
s3: None = s1.ffill(inplace=True)
assert_type(s1.ffill(), pd.Series)
assert_type(s1.ffill(inplace=False), pd.Series)
assert_type(s1.ffill(inplace=True), None)


def test_types_as_type() -> None:
Expand Down Expand Up @@ -671,3 +675,11 @@ def test_series_add_str() -> None:
def test_series_dtype() -> None:
s = pd.Series(["abc", "def"], dtype=str)
assert_type(s, "pd.Series[str]")


def test_types_replace() -> None:
# GH 44
s = pd.Series([1, 2, 3])
assert_type(s.replace(1, 2), pd.Series)
assert_type(s.replace(1, 2, inplace=False), pd.Series)
assert_type(s.replace(1, 2, inplace=True), None)