Skip to content

Commit 68e41e1

Browse files
committed
TYP: Improve date_range and bdate_range
1 parent 27fef79 commit 68e41e1

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

pandas-stubs/core/indexes/datetimes.pyi

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@ from datetime import (
22
timedelta,
33
tzinfo,
44
)
5-
from typing import overload
5+
from typing import (
6+
Hashable,
7+
Literal,
8+
Sequence,
9+
overload,
10+
)
611

712
import numpy as np
813
from pandas import (
@@ -87,23 +92,24 @@ def date_range(
8792
start: str | DatetimeLike | None = ...,
8893
end: str | DatetimeLike | None = ...,
8994
periods: int | None = ...,
95+
# TODO: Test timedelta and Timedelta, update pandas docs
9096
freq: str | timedelta | Timedelta | BaseOffset = ...,
9197
tz: str | tzinfo = ...,
9298
normalize: bool = ...,
93-
name: str | None = ...,
94-
inclusive: IntervalClosedType = ...,
95-
**kwargs,
99+
name: Hashable | None = ...,
100+
inclusive: Literal["left", "right"] | None = ...,
96101
) -> DatetimeIndex: ...
97102
def bdate_range(
98103
start: str | DatetimeLike | None = ...,
99104
end: str | DatetimeLike | None = ...,
100105
periods: int | None = ...,
106+
# TODO: Test timedelta and Timedelta, update pandas docs
101107
freq: str | timedelta | Timedelta | BaseOffset = ...,
102108
tz: str | tzinfo = ...,
103109
normalize: bool = ...,
104-
name: str | None = ...,
110+
name: Hashable | None = ...,
105111
weekmask: str | None = ...,
106-
holidays: list | None = ...,
107-
inclusive: IntervalClosedType = ...,
108-
**kwargs,
112+
# TODO: Check if dt.date is allowed
113+
holidays: list[str | DatetimeLike] | None = ...,
114+
inclusive: Literal["left", "right"] | None = ...,
109115
) -> DatetimeIndex: ...

0 commit comments

Comments
 (0)