[TYPING] Add type overloads for inplace dataframe operations #48662
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.
Add type overloads for inplace dataframe operationsctly show a return of None or DataFrame based on flag state.
Additionally adds one small type check function,
validate_strict_bool()
to wrapvalidate_bool_kwargs()
forinplace
, asvalidate_bool_kwargs()
acceptsbool
orNone
; butinplace
can only bebool
.Aside from that very minor function edit, all other changes are exclusively to type hints.
Simple test case:
Before:
The union is returned regardless of state of
inplace
After:
inplace
is implicitly or explicitlyTrue
returns aDataFrame
inplace
is explicitlyFalse
returnsNone
inplace
is ambiguous and eitherTrue
orFalse
, still returnsUnion[DataFrame, None]