Skip to content

ENH: Add dt.date support for functions that accept it #371

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

Merged
merged 4 commits into from
Oct 7, 2022
Merged
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
1 change: 1 addition & 0 deletions pandas-stubs/_typing.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ PandasScalar: TypeAlias = Union[
# Scalar: TypeAlias = Union[PythonScalar, PandasScalar]

DatetimeLike: TypeAlias = Union[datetime.datetime, np.datetime64, Timestamp]
DateAndDatetimeLike: TypeAlias = Union[datetime.date, DatetimeLike]

DatetimeDictArg: TypeAlias = Union[
Sequence[int], Sequence[float], list[str], tuple[Scalar, ...], AnyArrayLike
Expand Down
17 changes: 8 additions & 9 deletions pandas-stubs/core/indexes/datetimes.pyi
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
from datetime import (
date,
timedelta,
tzinfo,
)
Expand Down Expand Up @@ -27,7 +26,7 @@ from pandas.core.series import (
from pandas._typing import (
AnyArrayLike,
ArrayLike,
DatetimeLike,
DateAndDatetimeLike,
IntervalClosedType,
)

Expand Down Expand Up @@ -89,8 +88,8 @@ class DatetimeIndex(DatetimeTimedeltaMixin, DatetimeIndexProperties):
def dtype(self) -> np.dtype | DatetimeTZDtype: ...

def date_range(
start: str | DatetimeLike | None = ...,
end: str | DatetimeLike | None = ...,
start: str | DateAndDatetimeLike | None = ...,
end: str | DateAndDatetimeLike | None = ...,
periods: int | None = ...,
freq: str | timedelta | Timedelta | BaseOffset = ...,
tz: str | tzinfo = ...,
Expand All @@ -100,8 +99,8 @@ def date_range(
) -> DatetimeIndex: ...
@overload
def bdate_range(
start: str | DatetimeLike | None = ...,
end: str | DatetimeLike | None = ...,
start: str | DateAndDatetimeLike | None = ...,
end: str | DateAndDatetimeLike | None = ...,
periods: int | None = ...,
freq: str | timedelta | Timedelta | BaseOffset = ...,
tz: str | tzinfo = ...,
Expand All @@ -113,15 +112,15 @@ def bdate_range(
) -> DatetimeIndex: ...
@overload
def bdate_range(
start: str | DatetimeLike | None = ...,
end: str | DatetimeLike | None = ...,
start: str | DateAndDatetimeLike | None = ...,
end: str | DateAndDatetimeLike | None = ...,
periods: int | None = ...,
*,
freq: str | timedelta | Timedelta | BaseOffset,
tz: str | tzinfo = ...,
normalize: bool = ...,
name: Hashable | None = ...,
weekmask: str | None = ...,
holidays: Sequence[str | DatetimeLike | date],
holidays: Sequence[str | DateAndDatetimeLike],
inclusive: IntervalClosedType = ...,
) -> DatetimeIndex: ...
19 changes: 19 additions & 0 deletions tests/test_timefuncs.py
Original file line number Diff line number Diff line change
Expand Up @@ -558,6 +558,24 @@ def test_some_offsets() -> None:
),
pd.DatetimeIndex,
)
check(
assert_type(
pd.date_range(
dt.date(2022, 1, 1), dt.date(2022, 2, 1), freq=dt.timedelta(days=2)
),
pd.DatetimeIndex,
),
pd.DatetimeIndex,
)
check(
assert_type(
pd.bdate_range(
dt.date(2022, 1, 1), dt.date(2022, 2, 1), freq=dt.timedelta(days=2)
),
pd.DatetimeIndex,
),
pd.DatetimeIndex,
)
check(
assert_type(
pd.date_range("1/1/2022", "2/1/2022", freq=pd.Timedelta(days=5)),
Expand Down Expand Up @@ -689,6 +707,7 @@ def test_to_timedelta_index() -> None:

def test_bdate_range_holidays() -> None:
pd.bdate_range("2000-1-1", "2001-1-1", freq="C", holidays=["2000-12-15"])
pd.bdate_range("2000-1-1", "2001-1-1", freq="C", holidays=[dt.date(2000, 12, 15)])
pd.bdate_range(
"2000-1-1", "2001-1-1", freq="C", holidays=[pd.Timestamp(2000, 12, 15)]
)
Expand Down