ENH: Add typing for pandas.core.frame.dropna #38968
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| | @@ -5537,14 +5537,38 @@ def notna(self) -> DataFrame: | |||||
| def notnull(self) -> DataFrame: | ||||||
| return ~self.isna() | ||||||
| | ||||||
| @overload | ||||||
| # https://github.com/python/mypy/issues/6580 | ||||||
| # Overloaded function signatures 1 and 2 overlap with incompatible return types | ||||||
| def dropna( # type: ignore[misc] | ||||||
| self, | ||||||
| axis: Axis = ..., | ||||||
| how: str = ..., | ||||||
| thresh: Optional[int] = ..., | ||||||
| subset: Optional[Union[Hashable, Sequence[Hashable]]] = ..., | ||||||
| inplace: Literal[False] = ..., | ||||||
| ) -> DataFrame: | ||||||
| ... | ||||||
| | ||||||
| @overload | ||||||
| def dropna( | ||||||
| self, | ||||||
| axis: Axis = ..., | ||||||
| how: str = ..., | ||||||
| thresh: Optional[int] = ..., | ||||||
| subset: Optional[Union[Hashable, Sequence[Hashable]]] = ..., | ||||||
| Member There was a problem hiding this comment. we now have an Suggested change
| ||||||
| inplace: Literal[True] = ..., | ||||||
| ) -> None: | ||||||
| ... | ||||||
| | ||||||
| def dropna( | ||||||
| self, | ||||||
| axis: Axis = 0, | ||||||
| how: str = "any", | ||||||
| thresh: Optional[int] = None, | ||||||
| subset: Optional[Union[Hashable, Sequence[Hashable]]] = None, | ||||||
| inplace: bool = False, | ||||||
| ) -> Optional[DataFrame]: | ||||||
| Member There was a problem hiding this comment. I see you used #37137 as a example. However the motivation for that PR was to remove an Not needed to be done in this PR, but just FYI if the motivation for adding the types is for the public api, then the return type should be the same type as self for subclassed DataFrames. | ||||||
| """ | ||||||
| Remove missing values. | ||||||
| | ||||||
| | @@ -5683,6 +5707,7 @@ def dropna( | |||||
| | ||||||
| if inplace: | ||||||
| self._update_inplace(result) | ||||||
| return None | ||||||
| else: | ||||||
| return result | ||||||
| | ||||||
| | ||||||
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm pretty sure this comment has to go above the decorator?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It doesn't in
pandas.core.frame.reset_index, which doesn't seem to cause any problems. Also, it passed the typing portion of CI/Checks build, so I think we are fine. Happy to move it if there is a style preference though!There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't have a preference since it passes CI