TYP return type of DataFrame.clip not correct

[MarcoGorelli]

pandas/pandas/core/generic.py

Lines 7449 to 7458 in 094f630

	@final
	def clip(
	self: FrameOrSeries,
	lower=None,
	upper=None,
	axis=None,
	inplace: bool_t = False,
	*args,
	**kwargs,
	) -> FrameOrSeries:

Return type should be Optional[FrameOrSeriesUnion]

It could also do with being overloaded according to the value of inplace - see set_axis and DataFrame.reset_index for examples

[DriesSchaumont]

take

[nidhishtyagi]

Hey, so I've changed the return type to Optional[FrameOrSeriesUnion] but could you please explain what you mean by
overloading according to the value of inplace @MarcoGorelli

[MarcoGorelli]

See set_axis and reset_index for examples - it looks like @DriesSchaumont is already working on this though

[DriesSchaumont]

Yep, PR probably out tomorrow.

[MarcoGorelli]

Awesome, feel free to ping if you get stuck on anything

[DriesSchaumont]

@MarcoGorelli Did you mean that the return type is supposed to be FrameOrSeriesUnion | None or FrameOrSeries | None ? If I use FrameOrSeriesUnion, I get pandas/core/generic.py:7538: error: Incompatible return value type (got "FrameOrSeries", expected "Optional[Union[DataFrame, Series]]") [return-value] On line 7526, result = self. So FrameOrSeries seems applicable here?

[MarcoGorelli]

My bad, I meant FrameOrSeries - thanks @DriesSchaumont !