Skip to content

TYP: Return type for eq/ne/div/... #54725

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 1 commit into from
Aug 24, 2023
Merged

TYP: Return type for eq/ne/div/... #54725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
68 changes: 48 additions & 20 deletions pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8067,71 +8067,85 @@ def _flex_cmp_method(self, other, op, *, axis: Axis = "columns", level=None):
return self._construct_result(new_data)

@Appender(ops.make_flex_doc("eq", "dataframe"))
def eq(self, other, axis: Axis = "columns", level=None):
def eq(self, other, axis: Axis = "columns", level=None) -> DataFrame:
return self._flex_cmp_method(other, operator.eq, axis=axis, level=level)

@Appender(ops.make_flex_doc("ne", "dataframe"))
def ne(self, other, axis: Axis = "columns", level=None):
def ne(self, other, axis: Axis = "columns", level=None) -> DataFrame:
return self._flex_cmp_method(other, operator.ne, axis=axis, level=level)

@Appender(ops.make_flex_doc("le", "dataframe"))
def le(self, other, axis: Axis = "columns", level=None):
def le(self, other, axis: Axis = "columns", level=None) -> DataFrame:
return self._flex_cmp_method(other, operator.le, axis=axis, level=level)

@Appender(ops.make_flex_doc("lt", "dataframe"))
def lt(self, other, axis: Axis = "columns", level=None):
def lt(self, other, axis: Axis = "columns", level=None) -> DataFrame:
return self._flex_cmp_method(other, operator.lt, axis=axis, level=level)

@Appender(ops.make_flex_doc("ge", "dataframe"))
def ge(self, other, axis: Axis = "columns", level=None):
def ge(self, other, axis: Axis = "columns", level=None) -> DataFrame:
return self._flex_cmp_method(other, operator.ge, axis=axis, level=level)

@Appender(ops.make_flex_doc("gt", "dataframe"))
def gt(self, other, axis: Axis = "columns", level=None):
def gt(self, other, axis: Axis = "columns", level=None) -> DataFrame:
return self._flex_cmp_method(other, operator.gt, axis=axis, level=level)

@Appender(ops.make_flex_doc("add", "dataframe"))
def add(self, other, axis: Axis = "columns", level=None, fill_value=None):
def add(
self, other, axis: Axis = "columns", level=None, fill_value=None
) -> DataFrame:
return self._flex_arith_method(
other, operator.add, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("radd", "dataframe"))
def radd(self, other, axis: Axis = "columns", level=None, fill_value=None):
def radd(
self, other, axis: Axis = "columns", level=None, fill_value=None
) -> DataFrame:
return self._flex_arith_method(
other, roperator.radd, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("sub", "dataframe"))
def sub(self, other, axis: Axis = "columns", level=None, fill_value=None):
def sub(
self, other, axis: Axis = "columns", level=None, fill_value=None
) -> DataFrame:
return self._flex_arith_method(
other, operator.sub, level=level, fill_value=fill_value, axis=axis
)

subtract = sub

@Appender(ops.make_flex_doc("rsub", "dataframe"))
def rsub(self, other, axis: Axis = "columns", level=None, fill_value=None):
def rsub(
self, other, axis: Axis = "columns", level=None, fill_value=None
) -> DataFrame:
return self._flex_arith_method(
other, roperator.rsub, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("mul", "dataframe"))
def mul(self, other, axis: Axis = "columns", level=None, fill_value=None):
def mul(
self, other, axis: Axis = "columns", level=None, fill_value=None
) -> DataFrame:
return self._flex_arith_method(
other, operator.mul, level=level, fill_value=fill_value, axis=axis
)

multiply = mul

@Appender(ops.make_flex_doc("rmul", "dataframe"))
def rmul(self, other, axis: Axis = "columns", level=None, fill_value=None):
def rmul(
self, other, axis: Axis = "columns", level=None, fill_value=None
) -> DataFrame:
return self._flex_arith_method(
other, roperator.rmul, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("truediv", "dataframe"))
def truediv(self, other, axis: Axis = "columns", level=None, fill_value=None):
def truediv(
self, other, axis: Axis = "columns", level=None, fill_value=None
) -> DataFrame:
return self._flex_arith_method(
other, operator.truediv, level=level, fill_value=fill_value, axis=axis
)
Expand All @@ -8140,45 +8154,59 @@ def truediv(self, other, axis: Axis = "columns", level=None, fill_value=None):
divide = truediv

@Appender(ops.make_flex_doc("rtruediv", "dataframe"))
def rtruediv(self, other, axis: Axis = "columns", level=None, fill_value=None):
def rtruediv(
self, other, axis: Axis = "columns", level=None, fill_value=None
) -> DataFrame:
return self._flex_arith_method(
other, roperator.rtruediv, level=level, fill_value=fill_value, axis=axis
)

rdiv = rtruediv

@Appender(ops.make_flex_doc("floordiv", "dataframe"))
def floordiv(self, other, axis: Axis = "columns", level=None, fill_value=None):
def floordiv(
self, other, axis: Axis = "columns", level=None, fill_value=None
) -> DataFrame:
return self._flex_arith_method(
other, operator.floordiv, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("rfloordiv", "dataframe"))
def rfloordiv(self, other, axis: Axis = "columns", level=None, fill_value=None):
def rfloordiv(
self, other, axis: Axis = "columns", level=None, fill_value=None
) -> DataFrame:
return self._flex_arith_method(
other, roperator.rfloordiv, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("mod", "dataframe"))
def mod(self, other, axis: Axis = "columns", level=None, fill_value=None):
def mod(
self, other, axis: Axis = "columns", level=None, fill_value=None
) -> DataFrame:
return self._flex_arith_method(
other, operator.mod, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("rmod", "dataframe"))
def rmod(self, other, axis: Axis = "columns", level=None, fill_value=None):
def rmod(
self, other, axis: Axis = "columns", level=None, fill_value=None
) -> DataFrame:
return self._flex_arith_method(
other, roperator.rmod, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("pow", "dataframe"))
def pow(self, other, axis: Axis = "columns", level=None, fill_value=None):
def pow(
self, other, axis: Axis = "columns", level=None, fill_value=None
) -> DataFrame:
return self._flex_arith_method(
other, operator.pow, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("rpow", "dataframe"))
def rpow(self, other, axis: Axis = "columns", level=None, fill_value=None):
def rpow(
self, other, axis: Axis = "columns", level=None, fill_value=None
) -> DataFrame:
return self._flex_arith_method(
other, roperator.rpow, level=level, fill_value=fill_value, axis=axis
)
Expand Down
44 changes: 22 additions & 22 deletions pandas/core/series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5946,63 +5946,63 @@ def _flex_method(self, other, op, *, level=None, fill_value=None, axis: Axis = 0
return op(self, other)

@Appender(ops.make_flex_doc("eq", "series"))
def eq(self, other, level=None, fill_value=None, axis: Axis = 0):
def eq(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
return self._flex_method(
other, operator.eq, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("ne", "series"))
def ne(self, other, level=None, fill_value=None, axis: Axis = 0):
def ne(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
return self._flex_method(
other, operator.ne, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("le", "series"))
def le(self, other, level=None, fill_value=None, axis: Axis = 0):
def le(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
return self._flex_method(
other, operator.le, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("lt", "series"))
def lt(self, other, level=None, fill_value=None, axis: Axis = 0):
def lt(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
return self._flex_method(
other, operator.lt, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("ge", "series"))
def ge(self, other, level=None, fill_value=None, axis: Axis = 0):
def ge(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
return self._flex_method(
other, operator.ge, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("gt", "series"))
def gt(self, other, level=None, fill_value=None, axis: Axis = 0):
def gt(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
return self._flex_method(
other, operator.gt, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("add", "series"))
def add(self, other, level=None, fill_value=None, axis: Axis = 0):
def add(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
return self._flex_method(
other, operator.add, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("radd", "series"))
def radd(self, other, level=None, fill_value=None, axis: Axis = 0):
def radd(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
return self._flex_method(
other, roperator.radd, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("sub", "series"))
def sub(self, other, level=None, fill_value=None, axis: Axis = 0):
def sub(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
return self._flex_method(
other, operator.sub, level=level, fill_value=fill_value, axis=axis
)

subtract = sub

@Appender(ops.make_flex_doc("rsub", "series"))
def rsub(self, other, level=None, fill_value=None, axis: Axis = 0):
def rsub(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
return self._flex_method(
other, roperator.rsub, level=level, fill_value=fill_value, axis=axis
)
Expand All @@ -6014,21 +6014,21 @@ def mul(
level: Level | None = None,
fill_value: float | None = None,
axis: Axis = 0,
):
) -> Series:
return self._flex_method(
other, operator.mul, level=level, fill_value=fill_value, axis=axis
)

multiply = mul

@Appender(ops.make_flex_doc("rmul", "series"))
def rmul(self, other, level=None, fill_value=None, axis: Axis = 0):
def rmul(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
return self._flex_method(
other, roperator.rmul, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("truediv", "series"))
def truediv(self, other, level=None, fill_value=None, axis: Axis = 0):
def truediv(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
return self._flex_method(
other, operator.truediv, level=level, fill_value=fill_value, axis=axis
)
Expand All @@ -6037,57 +6037,57 @@ def truediv(self, other, level=None, fill_value=None, axis: Axis = 0):
divide = truediv

@Appender(ops.make_flex_doc("rtruediv", "series"))
def rtruediv(self, other, level=None, fill_value=None, axis: Axis = 0):
def rtruediv(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
return self._flex_method(
other, roperator.rtruediv, level=level, fill_value=fill_value, axis=axis
)

rdiv = rtruediv

@Appender(ops.make_flex_doc("floordiv", "series"))
def floordiv(self, other, level=None, fill_value=None, axis: Axis = 0):
def floordiv(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
return self._flex_method(
other, operator.floordiv, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("rfloordiv", "series"))
def rfloordiv(self, other, level=None, fill_value=None, axis: Axis = 0):
def rfloordiv(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
return self._flex_method(
other, roperator.rfloordiv, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("mod", "series"))
def mod(self, other, level=None, fill_value=None, axis: Axis = 0):
def mod(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
return self._flex_method(
other, operator.mod, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("rmod", "series"))
def rmod(self, other, level=None, fill_value=None, axis: Axis = 0):
def rmod(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
return self._flex_method(
other, roperator.rmod, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("pow", "series"))
def pow(self, other, level=None, fill_value=None, axis: Axis = 0):
def pow(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
return self._flex_method(
other, operator.pow, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("rpow", "series"))
def rpow(self, other, level=None, fill_value=None, axis: Axis = 0):
def rpow(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
return self._flex_method(
other, roperator.rpow, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("divmod", "series"))
def divmod(self, other, level=None, fill_value=None, axis: Axis = 0):
def divmod(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
return self._flex_method(
other, divmod, level=level, fill_value=fill_value, axis=axis
)

@Appender(ops.make_flex_doc("rdivmod", "series"))
def rdivmod(self, other, level=None, fill_value=None, axis: Axis = 0):
def rdivmod(self, other, level=None, fill_value=None, axis: Axis = 0) -> Series:
return self._flex_method(
other, roperator.rdivmod, level=level, fill_value=fill_value, axis=axis
)
Expand Down