Skip to content

added np.timedelta64 for series arithmatic methods #432

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 21 commits into from
Nov 23, 2022
Merged

added np.timedelta64 for series arithmatic methods #432

Show file tree
Hide file tree
Changes from 19 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
acd9ac8
update
ramvikrams Nov 18, 2022
19a7df2
update
ramvikrams Nov 19, 2022
e06f583
Update test_timefuncs.py
ramvikrams Nov 19, 2022
fb9dc01
Update test_timefuncs.py
ramvikrams Nov 19, 2022
83aa4c0
Update test_timefuncs.py
ramvikrams Nov 19, 2022
9fc4c76
Update test_timefuncs.py
ramvikrams Nov 19, 2022
dda43a9
Update test_timefuncs.py
ramvikrams Nov 19, 2022
994c6db
Update test_timefuncs.py
ramvikrams Nov 19, 2022
c0ea3b0
Update test_timefuncs.py
ramvikrams Nov 19, 2022
2284670
Update test_timefuncs.py
ramvikrams Nov 19, 2022
9e03f29
update
ramvikrams Nov 20, 2022
258e32a
update
ramvikrams Nov 21, 2022
a5ed64d
update
ramvikrams Nov 22, 2022
fee79d6
update
ramvikrams Nov 22, 2022
fd59d02
Update series.pyi
ramvikrams Nov 22, 2022
31db112
Update series.pyi
ramvikrams Nov 22, 2022
f01d3c0
Update test_timefuncs.py
ramvikrams Nov 22, 2022
fc41d33
Update test_timefuncs.py
ramvikrams Nov 22, 2022
21992b8
update
ramvikrams Nov 22, 2022
cb26631
update
ramvikrams Nov 23, 2022
ca75099
Update test_timefuncs.py
ramvikrams Nov 23, 2022
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
39 changes: 30 additions & 9 deletions pandas-stubs/core/series.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,10 @@ from pandas.core.window.rolling import (
Rolling,
Window,
)
from typing_extensions import TypeAlias
from typing_extensions import (
Never,
TypeAlias,
)
import xarray as xr

from pandas._libs.missing import NAType
Expand Down Expand Up @@ -1211,7 +1214,7 @@ class Series(IndexOpsMixin, NDFrame, Generic[S1]):
def __add__(self, other: Timestamp) -> TimestampSeries: ...
@overload
def __add__(
self, other: num | _str | Timedelta | _ListLike | Series[S1]
self, other: num | _str | Timedelta | _ListLike | Series[S1] | np.timedelta64
) -> Series: ...
# ignore needed for mypy as we want different results based on the arguments
@overload
Expand Down Expand Up @@ -1243,7 +1246,9 @@ class Series(IndexOpsMixin, NDFrame, Generic[S1]):
def __le__(self, other: S1 | _ListLike | Series[S1]) -> Series[_bool]: ...
def __lt__(self, other: S1 | _ListLike | Series[S1]) -> Series[_bool]: ...
@overload
def __mul__(self, other: Timedelta | TimedeltaSeries) -> TimedeltaSeries: ...
def __mul__(
self, other: Timedelta | TimedeltaSeries | np.timedelta64
) -> TimedeltaSeries: ...
@overload
def __mul__(self, other: num | _ListLike | Series) -> Series: ...
def __mod__(self, other: num | _ListLike | Series[S1]) -> Series[S1]: ...
Expand Down Expand Up @@ -1304,17 +1309,19 @@ class Series(IndexOpsMixin, NDFrame, Generic[S1]):
) -> TimedeltaSeries: ...
@overload
def __sub__(
self: Series[Timestamp], other: Timedelta | TimedeltaSeries | TimedeltaIndex
self: Series[Timestamp],
other: Timedelta | TimedeltaSeries | TimedeltaIndex | np.timedelta64,
) -> TimestampSeries: ...
@overload
def __sub__(
self: Series[Timedelta], other: Timedelta | TimedeltaSeries | TimedeltaIndex
self: Series[Timedelta],
other: Timedelta | TimedeltaSeries | TimedeltaIndex | np.timedelta64,
) -> TimedeltaSeries: ...
@overload
def __sub__(self, other: num | _ListLike | Series) -> Series: ...
@overload
def __truediv__(
self, other: Timedelta | TimedeltaSeries | TimedeltaIndex
self, other: Timedelta | TimedeltaSeries | TimedeltaIndex | np.timedelta64
) -> Series[float]: ...
@overload
def __truediv__(self, other: num | _ListLike | Series[S1]) -> Series: ...
Expand Down Expand Up @@ -1739,6 +1746,14 @@ class TimestampSeries(Series[Timestamp]):
# ignore needed because of mypy
@property
def dt(self) -> TimestampProperties: ... # type: ignore[override]
@overload # type: ignore[override]
def __add__(
self, other: TimedeltaSeries | np.timedelta64 | TimestampSeries
) -> TimestampSeries: ...
@overload
def __add__(self, other: Timestamp) -> TimestampSeries: ...
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can't add a Timestamp to a TimestampSeries. Make the return type Never here.

Copy link
Contributor Author

@ramvikrams ramvikrams Nov 23, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have issue in line number 266 of tests/time_funcs.py if we change this, it's pyright issue.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On that line, change # TODO both: ignore[operator] to # pyright: ignore

def __mul__(self, other: TimestampSeries | np.timedelta64 | TimedeltaSeries) -> Never: ... # type: ignore[override]
def __truediv__(self, other: TimestampSeries | np.timedelta64 | TimedeltaSeries) -> Never: ... # type: ignore[override]

class TimedeltaSeries(Series[Timedelta]):
# ignores needed because of mypy
Expand All @@ -1747,12 +1762,18 @@ class TimedeltaSeries(Series[Timedelta]):
@overload
def __add__(self, other: Timestamp | DatetimeIndex) -> TimestampSeries: ...
@overload
def __add__(self, other: Timedelta) -> TimedeltaSeries: ...
def __add__(self, other: Timedelta | np.timedelta64) -> TimedeltaSeries: ...
def __radd__(self, pther: Timestamp | TimestampSeries) -> TimestampSeries: ... # type: ignore[override]
def __mul__(self, other: num) -> TimedeltaSeries: ... # type: ignore[override]
@overload # type: ignore[override]
def __mul__(
self, other: TimestampSeries | np.timedelta64 | Timedelta | TimedeltaSeries
) -> Never: ...
@overload
def __mul__(self, other: num) -> TimedeltaSeries: ...
def __sub__( # type: ignore[override]
self, other: Timedelta | TimedeltaSeries | TimedeltaIndex
self, other: Timedelta | TimedeltaSeries | TimedeltaIndex | np.timedelta64
) -> TimedeltaSeries: ...
def __truediv__(self, other: TimedeltaSeries | np.timedelta64 | TimedeltaIndex) -> Series[float]: ... # type: ignore[override]
@property
def dt(self) -> TimedeltaProperties: ... # type: ignore[override]

Expand Down
20 changes: 19 additions & 1 deletion tests/test_timefuncs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,10 @@
import pandas as pd
from pandas.core.indexes.numeric import IntegerIndex
import pytz
from typing_extensions import assert_type
from typing_extensions import (
Never,
assert_type,
)

from pandas._libs import NaTType
from pandas._libs.tslibs import BaseOffset
Expand Down Expand Up @@ -1035,3 +1038,18 @@ def test_timedelta_range() -> None:
def test_dateoffset_freqstr() -> None:
offset = DateOffset(minutes=10)
check(assert_type(offset.freqstr, str), str)


def timedelta64_and_arithmatic_operator() -> None:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the name of any test function must begin with test_. If you make that change, you will see that the tests will fail. They were never getting tested.

You will have to change the tests as well. See example.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sir even after adding the test_ the poe mypy test doesn't fail on my system

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do poe test to run all tests or poe pytest to just run pytest which is where the failures will occur

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes sir there were errors, I'll fix it then

s1 = pd.Series(data=pd.date_range("1/1/2020", "2/1/2020"))
s2 = pd.Series(data=pd.date_range("1/1/2021", "2/1/2021"))
s3 = s2 - s1
td = np.timedelta64(1, "M")
check(assert_type((s1 - td), TimestampSeries), TimestampSeries, pd.Timestamp)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

check(assert_type((s1 - td), "TimestampSeries"), pd.Series, pd.Timestamp)

All the tests should look like this. The type TimestampSeries isn't known at runtime, so you have to surround it with quotes.

you will have to do something similar for TimedeltaSeries and pd.Series[float].

Look elsewhere in the code to see examples

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we also change thte left 3 tests because they cannot pass pytets

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. Move those 3 tests to the end and do

if TYPE_CHECKING_INVALID_USAGE:
     # test 1 here
     # test 2 here
     # test 3 here

you import TYPE_CHECKING_INVALID_USAGE from tests

check(assert_type((s1 + td), TimestampSeries), TimestampSeries, pd.Timestamp)
assert_type((s1 * td), Never) # pyright: ignore
assert_type((s1 / td), Never) # pyright: ignore
check(assert_type((s3 - td), TimedeltaSeries), TimedeltaSeries, pd.Timedelta)
check(assert_type((s3 + td), TimedeltaSeries), TimedeltaSeries, pd.Timedelta)
assert_type((s3 * td), Never) # pyright: ignore
check(assert_type((s3 / td), pd.Series[float]), pd.Series[float], float)