Skip to content
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

Jump to bottom

Add explicit type parameters to arguments of df.apply #953

Merged
merged 2 commits into from
Jun 29, 2024
Merged

Add explicit type parameters to arguments of df.apply #953

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
2dd5189
Add explicit Any type parameters for arguments used in df.apply
JanEricNitschke Jun 29, 2024
cdb7b9a
Add any to args, kwargs and Mapping overloads
JanEricNitschke Jun 29, 2024
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
4 changes: 2 additions & 2 deletions pandas-stubs/_typing.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -490,8 +490,8 @@ Axis: TypeAlias = AxisIndex | AxisColumn
DtypeNp = TypeVar("DtypeNp", bound=np.dtype[np.generic])
KeysArgType: TypeAlias = Any
ListLike = TypeVar("ListLike", Sequence, np.ndarray, Series, Index)
ListLikeExceptSeriesAndStr = TypeVar(
"ListLikeExceptSeriesAndStr", MutableSequence, np.ndarray, tuple, Index
ListLikeExceptSeriesAndStr: TypeAlias = (
MutableSequence[Any] | np.ndarray[Any, Any] | tuple[Any, ...] | Index[Any]
)
ListLikeU: TypeAlias = Sequence | np.ndarray | Series | Index
ListLikeHashable: TypeAlias = (
Expand Down
76 changes: 39 additions & 37 deletions pandas-stubs/core/frame.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1250,12 +1250,12 @@ class DataFrame(NDFrame, OpsMixin):
@overload
def apply(
self,
f: Callable[..., ListLikeExceptSeriesAndStr | Series],
f: Callable[..., ListLikeExceptSeriesAndStr | Series[Any]],
axis: AxisIndex = ...,
raw: _bool = ...,
result_type: None = ...,
args=...,
**kwargs,
args: Any = ...,
**kwargs: Any,
) -> DataFrame: ...
@overload
def apply(
Expand All @@ -1264,21 +1264,21 @@ class DataFrame(NDFrame, OpsMixin):
axis: AxisIndex = ...,
raw: _bool = ...,
result_type: None = ...,
args=...,
**kwargs,
args: Any = ...,
**kwargs: Any,
) -> Series[S1]: ...
# Since non-scalar type T is not supported in Series[T],
# we separate this overload from the above one
@overload
def apply(
self,
f: Callable[..., Mapping],
f: Callable[..., Mapping[Any, Any]],
axis: AxisIndex = ...,
raw: _bool = ...,
result_type: None = ...,
args=...,
**kwargs,
) -> Series: ...
args: Any = ...,
**kwargs: Any,
) -> Series[Any]: ...

# apply() overloads with keyword result_type, and axis does not matter
@overload
Expand All @@ -1287,57 +1287,59 @@ class DataFrame(NDFrame, OpsMixin):
f: Callable[..., S1],
axis: Axis = ...,
raw: _bool = ...,
args=...,
args: Any = ...,
*,
result_type: Literal["expand", "reduce"],
**kwargs,
**kwargs: Any,
) -> Series[S1]: ...
@overload
def apply(
self,
f: Callable[..., ListLikeExceptSeriesAndStr | Series | Mapping],
f: Callable[..., ListLikeExceptSeriesAndStr | Series[Any] | Mapping[Any, Any]],
axis: Axis = ...,
raw: _bool = ...,
args=...,
args: Any = ...,
*,
result_type: Literal["expand"],
**kwargs,
**kwargs: Any,
) -> DataFrame: ...
@overload
def apply(
self,
f: Callable[..., ListLikeExceptSeriesAndStr | Mapping],
f: Callable[..., ListLikeExceptSeriesAndStr | Mapping[Any, Any]],
axis: Axis = ...,
raw: _bool = ...,
args=...,
args: Any = ...,
*,
result_type: Literal["reduce"],
**kwargs,
) -> Series: ...
**kwargs: Any,
) -> Series[Any]: ...
@overload
def apply(
self,
f: Callable[..., ListLikeExceptSeriesAndStr | Series | Scalar | Mapping],
f: Callable[
..., ListLikeExceptSeriesAndStr | Series[Any] | Scalar | Mapping[Any, Any]
],
axis: Axis = ...,
raw: _bool = ...,
args=...,
args: Any = ...,
*,
result_type: Literal["broadcast"],
**kwargs,
**kwargs: Any,
) -> DataFrame: ...

# apply() overloads with keyword result_type, and axis does matter
@overload
def apply(
self,
f: Callable[..., Series],
f: Callable[..., Series[Any]],
axis: AxisIndex = ...,
raw: _bool = ...,
args=...,
args: Any = ...,
*,
result_type: Literal["reduce"],
**kwargs,
) -> Series: ...
**kwargs: Any,
) -> Series[Any]: ...

# apply() overloads with default result_type of None, and keyword axis=1 matters
@overload
Expand All @@ -1346,45 +1348,45 @@ class DataFrame(NDFrame, OpsMixin):
f: Callable[..., S1],
raw: _bool = ...,
result_type: None = ...,
args=...,
args: Any = ...,
*,
axis: AxisColumn,
**kwargs,
**kwargs: Any,
) -> Series[S1]: ...
@overload
def apply(
self,
f: Callable[..., ListLikeExceptSeriesAndStr | Mapping],
f: Callable[..., ListLikeExceptSeriesAndStr | Mapping[Any, Any]],
raw: _bool = ...,
result_type: None = ...,
args=...,
args: Any = ...,
*,
axis: AxisColumn,
**kwargs,
) -> Series: ...
**kwargs: Any,
) -> Series[Any]: ...
@overload
def apply(
self,
f: Callable[..., Series],
f: Callable[..., Series[Any]],
raw: _bool = ...,
result_type: None = ...,
args=...,
args: Any = ...,
*,
axis: AxisColumn,
**kwargs,
**kwargs: Any,
) -> DataFrame: ...

# apply() overloads with keyword axis=1 and keyword result_type
@overload
def apply(
self,
f: Callable[..., Series],
f: Callable[..., Series[Any]],
raw: _bool = ...,
args=...,
args: Any = ...,
*,
axis: AxisColumn,
result_type: Literal["reduce"],
**kwargs,
**kwargs: Any,
) -> DataFrame: ...

# Add spacing between apply() overloads and remaining annotations
Expand Down
Loading