Skip to content

feat(series): #1098 __add__ and __mul__ #1275

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.

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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
36 changes: 34 additions & 2 deletions pandas-stubs/core/series.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,8 @@ from pandas._typing import (
VoidDtypeArg,
WriteBuffer,
np_ndarray_anyint,
np_ndarray_complex,
np_ndarray_float,
npt,
num,
)
Expand Down Expand Up @@ -1580,6 +1582,10 @@ class Series(IndexOpsMixin[S1], NDFrame):
# just failed to generate these so I couldn't match
# them up.
@overload
def __add__(
self: Series[S1], other: complex | Sequence[complex] | Series[complex]
) -> Series[S1]: ...
@overload
def __add__(self, other: S1 | Self) -> Self: ...
@overload
def __add__(
Expand Down Expand Up @@ -1626,6 +1632,10 @@ class Series(IndexOpsMixin[S1], NDFrame):
@overload
def __or__(self, other: int | np_ndarray_anyint | Series[int]) -> Series[int]: ...
@overload
def __radd__(
self: Series[S1], other: complex | Sequence[complex] | np_ndarray_complex
) -> Series[S1]: ...
@overload
def __radd__(self, other: S1 | Series[S1]) -> Self: ...
@overload
def __radd__(self, other: num | _str | _ListLike | Series) -> Series: ...
Expand Down Expand Up @@ -1705,7 +1715,14 @@ class Series(IndexOpsMixin[S1], NDFrame):
# Methods
def add(
self,
other: Series[S1] | Scalar,
other: (
Sequence[S1]
| np_ndarray_anyint
| np_ndarray_float
| np_ndarray_complex
| Series[S1]
| Scalar
),
level: Level | None = ...,
fill_value: float | None = ...,
axis: int = ...,
Expand Down Expand Up @@ -1890,6 +1907,14 @@ class Series(IndexOpsMixin[S1], NDFrame):
axis: AxisIndex | None = ...,
) -> Series[S1]: ...
@overload
def mul(
self: Series[int],
other: int | Sequence[int] | Series[int],
level: Level | None = ...,
fill_value: float | None = ...,
axis: AxisIndex | None = ...,
) -> Series[int]: ...
@overload
def mul(
self,
other: timedelta | Timedelta | TimedeltaSeries | np.timedelta64,
Expand Down Expand Up @@ -1947,7 +1972,14 @@ class Series(IndexOpsMixin[S1], NDFrame):
) -> Scalar: ...
def radd(
self,
other: Series[S1] | Scalar,
other: (
Sequence[S1]
| np_ndarray_anyint
| np_ndarray_float
| np_ndarray_complex
| Series[S1]
| Scalar
),
level: Level | None = ...,
fill_value: float | None = ...,
axis: AxisIndex = ...,
Expand Down
Empty file added tests/series/__init__.py
Empty file.
Empty file.
105 changes: 105 additions & 0 deletions tests/series/arithmetic/any/test_add.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
from typing import assert_type

import numpy as np
import pandas as pd

from tests import check

left = pd.DataFrame({"a": [1, 2, 3]})["a"] # left operand


def test_add_py_scalar() -> None:
"""Test pd.Series[Any] + Python native scalars"""
i, f, c = 1, 1.0, 1j

check(assert_type(left + i, pd.Series), pd.Series)
check(assert_type(left + f, pd.Series), pd.Series)
check(assert_type(left + c, pd.Series), pd.Series)

check(assert_type(i + left, pd.Series), pd.Series)
check(assert_type(f + left, pd.Series), pd.Series)
check(assert_type(c + left, pd.Series), pd.Series)

check(assert_type(left.add(i), pd.Series), pd.Series)
check(assert_type(left.add(f), pd.Series), pd.Series)
check(assert_type(left.add(c), pd.Series), pd.Series)

check(assert_type(left.radd(i), pd.Series), pd.Series)
check(assert_type(left.radd(f), pd.Series), pd.Series)
check(assert_type(left.radd(c), pd.Series), pd.Series)


def test_add_py_sequence() -> None:
"""Test pd.Series[Any] + Python native sequence"""
i, f, c = [2, 3, 5], [1.0, 2.0, 3.0], [1j, 1j, 4j]

check(assert_type(left + i, pd.Series), pd.Series)
check(assert_type(left + f, pd.Series), pd.Series)
check(assert_type(left + c, pd.Series), pd.Series)

check(assert_type(i + left, pd.Series), pd.Series)
check(assert_type(f + left, pd.Series), pd.Series)
check(assert_type(c + left, pd.Series), pd.Series)

check(assert_type(left.add(i), pd.Series), pd.Series)
check(assert_type(left.add(f), pd.Series), pd.Series)
check(assert_type(left.add(c), pd.Series), pd.Series)

check(assert_type(left.radd(i), pd.Series), pd.Series)
check(assert_type(left.radd(f), pd.Series), pd.Series)
check(assert_type(left.radd(c), pd.Series), pd.Series)


def test_add_numpy_array() -> None:
"""Test pd.Series[Any] + numpy array"""
i = np.array([2, 3, 5], np.int64)
f = np.array([1.0, 2.0, 3.0], np.float64)
c = np.array([1.1j, 2.2j, 4.1j], np.complex64)

check(assert_type(left + i, pd.Series), pd.Series)
check(assert_type(left + f, pd.Series), pd.Series)
check(assert_type(left + c, pd.Series), pd.Series)

# check(assert_type(i + l, pd.Series), pd.Series)
# check(assert_type(f + l, pd.Series), pd.Series)
# check(assert_type(c + l, pd.Series), pd.Series)

check(assert_type(left.add(i), pd.Series), pd.Series)
check(assert_type(left.add(f), pd.Series), pd.Series)
check(assert_type(left.add(c), pd.Series), pd.Series)

check(assert_type(left.radd(i), pd.Series), pd.Series)
check(assert_type(left.radd(f), pd.Series), pd.Series)
check(assert_type(left.radd(c), pd.Series), pd.Series)


def test_add_pd_series() -> None:
"""Test pd.Series[Any] + pandas series"""
i = pd.Series([2, 3, 5])
f = pd.Series([1.0, 2.0, 3.0])
c = pd.Series([1.1j, 2.2j, 4.1j])

check(assert_type(left + i, pd.Series), pd.Series)
check(assert_type(left + f, pd.Series), pd.Series)
check(assert_type(left + c, pd.Series), pd.Series)

check(
assert_type(i + left, pd.Series), # pyright: ignore[reportAssertTypeFailure]
pd.Series,
)
check(
assert_type(f + left, pd.Series), # pyright: ignore[reportAssertTypeFailure]
pd.Series,
)
check(
assert_type(c + left, pd.Series), # pyright: ignore[reportAssertTypeFailure]
pd.Series,
)

check(assert_type(left.add(i), pd.Series), pd.Series)
check(assert_type(left.add(f), pd.Series), pd.Series)
check(assert_type(left.add(c), pd.Series), pd.Series)

check(assert_type(left.radd(i), pd.Series), pd.Series)
check(assert_type(left.radd(f), pd.Series), pd.Series)
check(assert_type(left.radd(c), pd.Series), pd.Series)
3 changes: 1 addition & 2 deletions tests/test_series.py → tests/series/test_series.py
Original file line number Diff line number Diff line change
Expand Up @@ -818,8 +818,7 @@ def test_types_element_wise_arithmetic() -> None:
# TODO these two below should type pd.Series[int]
# check(assert_type(s * s2, "pd.Series[int]"), pd.Series, np.integer )
check(assert_type(s * s2, pd.Series), pd.Series, np.integer)
# check(assert_type(s.mul(s2, fill_value=0), "pd.Series[int]"), pd.Series, np.integer)
check(assert_type(s.mul(s2, fill_value=0), pd.Series), pd.Series, np.integer)
check(assert_type(s.mul(s2, fill_value=0), "pd.Series[int]"), pd.Series, np.integer)

# TODO these two below should type pd.Series[float]
# check(assert_type(s / s2, "pd.Series[float]"), pd.Series, np.float64)
Expand Down