Skip to content

Commit 4c60287

Browse files
loicdiridollouloicdiridollou
committed
GH1089 Partial typehinting
1 parent 01130e1 commit 4c60287

File tree

2 files changed

+48
-9
lines changed

2 files changed

+48
-9
lines changed

‎pandas-stubs/core/series.pyi‎

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -857,7 +857,7 @@ class Series(IndexOpsMixin[S1], NDFrame):
857857
@overload
858858
def dot(self, other: Series[S1]) -> Scalar: ...
859859
@overload
860-
def dot(self, other: DataFrame) -> Series[S1]: ...
860+
def dot(self, other: DataFrame) -> Series: ...
861861
@overload
862862
def dot(
863863
self, other: ArrayLike | dict[_str, np.ndarray] | Sequence[S1] | Index[S1]
@@ -1628,6 +1628,11 @@ class Series(IndexOpsMixin[S1], NDFrame):
16281628
self, other: int | np_ndarray_anyint | Series[int]
16291629
) -> Series[int]: ...
16301630
# def __array__(self, dtype: Optional[_bool] = ...) -> _np_ndarray
1631+
@overload
1632+
def __div__(self: Series[int], other: Series[int]) -> Series[float]: ...
1633+
@overload
1634+
def __div__(self: Series[int], other: int) -> Series[float]: ...
1635+
@overload
16311636
def __div__(self, other: num | _ListLike | Series[S1]) -> Series[S1]: ...
16321637
def __eq__(self, other: object) -> Series[_bool]: ... # type: ignore[override] # pyright: ignore[reportIncompatibleMethodOverride]
16331638
def __floordiv__(self, other: num | _ListLike | Series[S1]) -> Series[int]: ...
@@ -1648,6 +1653,14 @@ class Series(IndexOpsMixin[S1], NDFrame):
16481653
self, other: timedelta | Timedelta | TimedeltaSeries | np.timedelta64
16491654
) -> TimedeltaSeries: ...
16501655
@overload
1656+
def __mul__(self: Series[int], other: int) -> Series[int]: ...
1657+
@overload
1658+
def __mul__(self: Series[int], other: Series[int]) -> Series[int]: ...
1659+
@overload
1660+
def __mul__(self: Series[int], other: Series[float]) -> Series[float]: ...
1661+
@overload
1662+
def __mul__(self: Series[Any], other: Series[Any]) -> Series: ...
1663+
@overload
16511664
def __mul__(self, other: num | _ListLike | Series) -> Series: ...
16521665
def __mod__(self, other: num | _ListLike | Series[S1]) -> Series[S1]: ...
16531666
def __ne__(self, other: object) -> Series[_bool]: ... # type: ignore[override] # pyright: ignore[reportIncompatibleMethodOverride]
@@ -1674,6 +1687,11 @@ class Series(IndexOpsMixin[S1], NDFrame):
16741687
def __rand__( # pyright: ignore[reportIncompatibleMethodOverride]
16751688
self, other: int | np_ndarray_anyint | Series[int]
16761689
) -> Series[int]: ...
1690+
@overload
1691+
def __rdiv__(self: Series[int], other: int) -> Series[float]: ...
1692+
@overload
1693+
def __rdiv__(self: Series[int], other: Series[int]) -> Series[float]: ...
1694+
@overload
16771695
def __rdiv__(self, other: num | _ListLike | Series[S1]) -> Series[S1]: ...
16781696
def __rdivmod__(self, other: num | _ListLike | Series[S1]) -> Series[S1]: ... # type: ignore[override] # pyright: ignore[reportIncompatibleMethodOverride]
16791697
def __rfloordiv__(self, other: num | _ListLike | Series[S1]) -> Series[S1]: ...
@@ -1936,6 +1954,22 @@ class Series(IndexOpsMixin[S1], NDFrame):
19361954
axis: AxisIndex | None = ...,
19371955
) -> Series[S1]: ...
19381956
@overload
1957+
def mul(
1958+
self: Series[int],
1959+
other: Series[int],
1960+
level: Level | None = ...,
1961+
fill_value: float | None = ...,
1962+
axis: AxisIndex | None = ...,
1963+
) -> Series[int]: ...
1964+
@overload
1965+
def mul(
1966+
self: Series[int],
1967+
other: Series[float],
1968+
level: Level | None = ...,
1969+
fill_value: float | None = ...,
1970+
axis: AxisIndex | None = ...,
1971+
) -> Series[float]: ...
1972+
@overload
19391973
def mul(
19401974
self,
19411975
other: timedelta | Timedelta | TimedeltaSeries | np.timedelta64,

‎tests/test_series.py‎

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -656,10 +656,12 @@ def test_types_element_wise_arithmetic() -> None:
656656
check(assert_type(s - s2, pd.Series), pd.Series, np.integer)
657657
check(assert_type(s.sub(s2, fill_value=0), "pd.Series[int]"), pd.Series, np.integer)
658658

659-
check(assert_type(s * s2, pd.Series), pd.Series, np.integer)
660-
check(assert_type(s.mul(s2, fill_value=0), pd.Series), pd.Series, np.integer)
659+
check(assert_type(s * s2, "pd.Series[int]"), pd.Series, np.integer)
660+
check(assert_type(s.mul(s2, fill_value=0), "pd.Series[int]"), pd.Series, np.integer)
661661

662-
check(assert_type(s / s2, pd.Series), pd.Series, np.float64)
662+
# GH1089 should be the following
663+
# check(assert_type(s / s2, "pd.Series[float]"), pd.Series, np.float64)
664+
check(assert_type(s / s2, "pd.Series"), pd.Series, np.float64)
663665
check(
664666
assert_type(s.div(s2, fill_value=0), "pd.Series[float]"), pd.Series, np.float64
665667
)
@@ -693,9 +695,11 @@ def test_types_scalar_arithmetic() -> None:
693695
check(assert_type(s - 1, "pd.Series[int]"), pd.Series, np.integer)
694696
check(assert_type(s.sub(1, fill_value=0), "pd.Series[int]"), pd.Series, np.integer)
695697

696-
check(assert_type(s * 2, pd.Series), pd.Series, np.integer)
698+
check(assert_type(s * 2, "pd.Series[int]"), pd.Series, np.integer)
697699
check(assert_type(s.mul(2, fill_value=0), pd.Series), pd.Series, np.integer)
698700

701+
# GH1089 should be
702+
# check(assert_type(s / 2, "pd.Series[float]"), pd.Series, np.float64)
699703
check(assert_type(s / 2, pd.Series), pd.Series, np.float64)
700704
check(
701705
assert_type(s.div(2, fill_value=0), "pd.Series[float]"), pd.Series, np.float64
@@ -1311,7 +1315,7 @@ def test_types_dot() -> None:
13111315
n1 = np.array([[0, 1], [1, 2], [-1, -1], [2, 0]])
13121316
check(assert_type(s1.dot(s2), Scalar), np.integer)
13131317
check(assert_type(s1 @ s2, Scalar), np.integer)
1314-
check(assert_type(s1.dot(df1), "pd.Series[int]"), pd.Series, np.integer)
1318+
check(assert_type(s1.dot(df1), pd.Series), pd.Series, np.integer)
13151319
check(assert_type(s1 @ df1, pd.Series), pd.Series)
13161320
check(assert_type(s1.dot(n1), np.ndarray), np.ndarray)
13171321
check(assert_type(s1 @ n1, np.ndarray), np.ndarray)
@@ -1333,7 +1337,8 @@ def test_series_min_max_sub_axis() -> None:
13331337
sd = s1 / s2
13341338
check(assert_type(sa, pd.Series), pd.Series)
13351339
check(assert_type(ss, pd.Series), pd.Series)
1336-
check(assert_type(sm, pd.Series), pd.Series)
1340+
# TODO GH1089 This should not match to Series[int]
1341+
check(assert_type(sm, pd.Series), pd.Series) # pyright: ignore
13371342
check(assert_type(sd, pd.Series), pd.Series)
13381343

13391344

@@ -1368,11 +1373,11 @@ def test_series_multiindex_getitem() -> None:
13681373
def test_series_mul() -> None:
13691374
s = pd.Series([1, 2, 3])
13701375
sm = s * 4
1371-
check(assert_type(sm, pd.Series), pd.Series)
1376+
check(assert_type(sm, "pd.Series[int]"), pd.Series, np.integer)
13721377
ss = s - 4
13731378
check(assert_type(ss, "pd.Series[int]"), pd.Series, np.integer)
13741379
sm2 = s * s
1375-
check(assert_type(sm2, pd.Series), pd.Series)
1380+
check(assert_type(sm2, "pd.Series[int]"), pd.Series, np.integer)
13761381
sp = s + 4
13771382
check(assert_type(sp, "pd.Series[int]"), pd.Series, np.integer)
13781383

0 commit comments

Comments
 (0)