-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
TYP: offsets.pyi #45331
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
TYP: offsets.pyi #45331
Changes from 4 commits
b9cb593
84eb759
5b633c8
24a1fd6
9d48700
70c1674
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,256 @@ | ||
from __future__ import annotations | ||
|
||
from datetime import ( | ||
datetime, | ||
timedelta, | ||
) | ||
from typing import ( | ||
TYPE_CHECKING, | ||
Any, | ||
Collection, | ||
Literal, | ||
Tuple, | ||
TypeVar, | ||
Union, | ||
overload, | ||
) | ||
|
||
import numpy as np | ||
|
||
from pandas._typing import npt | ||
|
||
from .timedeltas import Timedelta | ||
|
||
if TYPE_CHECKING: | ||
from pandas.core.indexes.datetimes import DatetimeIndex | ||
_BaseOffsetT = TypeVar("_BaseOffsetT", bound="BaseOffset") | ||
_DatetimeT = TypeVar("_DatetimeT", bound=datetime) | ||
_TimedeltaT = TypeVar("_TimedeltaT", bound=timedelta) | ||
|
||
_relativedelta_kwds: set[str] | ||
prefix_mapping: dict[str, type] | ||
|
||
class ApplyTypeError(TypeError): ... | ||
|
||
class BaseOffset: | ||
n: int | ||
def __init__(self, n: int = ..., normalize: bool = ...) -> None: ... | ||
def __eq__(self, other) -> bool: ... | ||
def __ne__(self, other) -> bool: ... | ||
def __hash__(self) -> int: ... | ||
@property | ||
def kwds(self) -> dict: ... | ||
@property | ||
def base(self) -> BaseOffset: ... | ||
@overload | ||
def __add__(self, other: npt.NDArray[np.object_]) -> npt.NDArray[np.object_]: ... | ||
@overload | ||
def __add__(self: _BaseOffsetT, other: BaseOffset) -> _BaseOffsetT: ... | ||
@overload | ||
def __add__(self, other: _DatetimeT) -> _DatetimeT: ... | ||
@overload | ||
def __add__(self, other: _TimedeltaT) -> _TimedeltaT: ... | ||
@overload | ||
def __radd__(self, other: npt.NDArray[np.object_]) -> npt.NDArray[np.object_]: ... | ||
@overload | ||
def __radd__(self: _BaseOffsetT, other: BaseOffset) -> _BaseOffsetT: ... | ||
@overload | ||
def __radd__(self, other: _DatetimeT) -> _DatetimeT: ... | ||
@overload | ||
def __radd__(self, other: _TimedeltaT) -> _TimedeltaT: ... | ||
def __sub__(self: _BaseOffsetT, other: BaseOffset) -> _BaseOffsetT: ... | ||
@overload | ||
def __rsub__(self, other: npt.NDArray[np.object_]) -> npt.NDArray[np.object_]: ... | ||
@overload | ||
def __rsub__(self: _BaseOffsetT, other: BaseOffset) -> _BaseOffsetT: ... | ||
@overload | ||
def __rsub__(self, other: _DatetimeT) -> _DatetimeT: ... | ||
@overload | ||
def __rsub__(self, other: _TimedeltaT) -> _TimedeltaT: ... | ||
def __call__(self, other): ... | ||
@overload | ||
def __mul__(self, other: np.ndarray) -> np.ndarray: ... | ||
@overload | ||
def __mul__(self: _BaseOffsetT, other: int) -> _BaseOffsetT: ... | ||
@overload | ||
def __rmul__(self, other: np.ndarray) -> np.ndarray: ... | ||
@overload | ||
def __rmul__(self: _BaseOffsetT, other: int) -> _BaseOffsetT: ... | ||
def __neg__(self: _BaseOffsetT) -> _BaseOffsetT: ... | ||
def copy(self: _BaseOffsetT) -> _BaseOffsetT: ... | ||
def __repr__(self) -> str: ... | ||
@property | ||
def name(self) -> str: ... | ||
@property | ||
def rule_code(self) -> str: ... | ||
def freqstr(self) -> str: ... | ||
def apply_index(self, dtindex: "DatetimeIndex") -> "DatetimeIndex": ... | ||
def _apply_array(self, dtarr) -> None: ... | ||
def rollback(self, dt: datetime) -> datetime: ... | ||
def rollforward(self, dt: datetime) -> datetime: ... | ||
def is_on_offset(self, dt: datetime) -> bool: ... | ||
def __setstate__(self, state) -> None: ... | ||
def __getstate__(self): ... | ||
@property | ||
def nanos(self) -> int: ... | ||
def onOffset(self, dt: datetime) -> bool: ... | ||
def isAnchored(self) -> bool: ... | ||
def is_anchored(self) -> bool: ... | ||
|
||
def _get_offset(name: str) -> BaseOffset: ... | ||
|
||
class SingleConstructorOffset(BaseOffset): | ||
@classmethod | ||
def _from_name(cls, suffix=...): ... | ||
def __reduce__(self): ... | ||
|
||
@overload | ||
def to_offset(freq: None) -> None: ... | ||
@overload | ||
def to_offset(freq: timedelta | BaseOffset | str) -> BaseOffset: ... | ||
|
||
class Tick(SingleConstructorOffset): | ||
def __init__(self, n: int = ..., normalize: bool = ...) -> None: ... | ||
@property | ||
def delta(self) -> Timedelta: ... | ||
@property | ||
def nanos(self) -> int: ... | ||
|
||
def delta_to_tick(delta: timedelta) -> Tick: ... | ||
|
||
class Day(Tick): ... | ||
class Hour(Tick): ... | ||
class Minute(Tick): ... | ||
class Second(Tick): ... | ||
class Milli(Tick): ... | ||
class Micro(Tick): ... | ||
class Nano(Tick): ... | ||
|
||
class RelativeDeltaOffset(BaseOffset): | ||
def __init__(self, n: int = ..., normalize: bool = ..., **kwds: Any) -> None: ... | ||
|
||
class BusinessMixin(SingleConstructorOffset): | ||
def __init__( | ||
self, n: int = ..., normalize: bool = ..., offset: timedelta = ... | ||
): ... | ||
|
||
class BusinessDay(BusinessMixin): ... | ||
|
||
class BusinessHour(BusinessMixin): | ||
def __init__( | ||
self, | ||
n: int = ..., | ||
normalize: bool = ..., | ||
start: str | Collection[str] = ..., | ||
end: str | Collection[str] = ..., | ||
offset: timedelta = ..., | ||
): ... | ||
|
||
class WeekOfMonthMixin(SingleConstructorOffset): ... | ||
|
||
class YearOffset(SingleConstructorOffset): | ||
def __init__( | ||
self, n: int = ..., normalize: bool = ..., month: int | None = ... | ||
): ... | ||
|
||
class BYearEnd(YearOffset): ... | ||
class BYearBegin(YearOffset): ... | ||
class YearEnd(YearOffset): ... | ||
class YearBegin(YearOffset): ... | ||
|
||
class QuarterOffset(SingleConstructorOffset): | ||
def __init__( | ||
self, n: int = ..., normalize: bool = ..., startingMonth: int | None = ... | ||
) -> None: ... | ||
|
||
class BQuarterEnd(QuarterOffset): ... | ||
class BQuarterBegin(QuarterOffset): ... | ||
class QuarterEnd(QuarterOffset): ... | ||
class QuarterBegin(QuarterOffset): ... | ||
class MonthOffset(SingleConstructorOffset): ... | ||
class MonthEnd(MonthOffset): ... | ||
class MonthBegin(MonthOffset): ... | ||
class BusinessMonthEnd(MonthOffset): ... | ||
class BusinessMonthBegin(MonthOffset): ... | ||
|
||
class SemiMonthOffset(SingleConstructorOffset): | ||
def __init__( | ||
self, n: int = ..., normalize: bool = ..., day_of_month: int | None = ... | ||
) -> None: ... | ||
|
||
class SemiMonthEnd(SemiMonthOffset): ... | ||
class SemiMonthBegin(SemiMonthOffset): ... | ||
|
||
class Week(SingleConstructorOffset): | ||
def __init__( | ||
self, n: int = ..., normalize: bool = ..., weekday: int | None = ... | ||
) -> None: ... | ||
|
||
class WeekOfMonth(WeekOfMonthMixin): ... | ||
class LastWeekOfMonth(WeekOfMonthMixin): ... | ||
|
||
class FY5253Mixin(SingleConstructorOffset): | ||
def __init__( | ||
self, | ||
n: int = ..., | ||
normalize: bool = ..., | ||
weekday: int = ..., | ||
startingMonth: int = ..., | ||
variation: str = ..., | ||
) -> None: ... | ||
|
||
class FY5253(FY5253Mixin): ... | ||
class FY5253Quarter(FY5253Mixin): ... | ||
class Easter(SingleConstructorOffset): ... | ||
|
||
class _CustomBusinessMonth(BusinessMixin): | ||
def __init__( | ||
self, | ||
n: int = ..., | ||
normalize: bool = ..., | ||
offset: timedelta = ..., | ||
holidays: None | list = ..., | ||
): ... | ||
|
||
class CustomBusinessDay(BusinessDay): | ||
def __init__( | ||
self, | ||
n: int = ..., | ||
normalize: bool = ..., | ||
offset: timedelta = ..., | ||
weekmask: str = ..., | ||
): ... | ||
|
||
class CustomBusinessHour(BusinessHour): | ||
def __init__( | ||
self, | ||
n: int = ..., | ||
normalize: bool = ..., | ||
start: str = ..., | ||
end: str = ..., | ||
offset: timedelta = ..., | ||
holidays: None | list = ..., | ||
): ... | ||
|
||
class CustomBusinessMonthEnd(_CustomBusinessMonth): ... | ||
class CustomBusinessMonthBegin(_CustomBusinessMonth): ... | ||
class DateOffset(RelativeDeltaOffset): ... | ||
|
||
BDay = BusinessDay | ||
BMonthEnd = BusinessMonthEnd | ||
BMonthBegin = BusinessMonthBegin | ||
CBMonthEnd = CustomBusinessMonthEnd | ||
CBMonthBegin = CustomBusinessMonthBegin | ||
CDay = CustomBusinessDay | ||
|
||
def roll_qtrday( | ||
other: datetime, n: int, month: int, day_opt: str, modby: int | ||
) -> int: ... | ||
|
||
INVALID_FREQ_ERR_MSG: Literal["Invalid frequency: {0}"] | ||
|
||
def shift_months( | ||
dtindex: npt.NDArray[np.int64], months: int, day_opt: str | None = ... | ||
) -> npt.NDArray[np.int64]: ... | ||
|
||
_offset_map: dict[str, BaseOffset] |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -605,7 +605,8 @@ def asfreq(self, freq=None, how: str = "E") -> PeriodArray: | |
|
||
freq = Period._maybe_convert_freq(freq) | ||
|
||
base1 = self.freq._period_dtype_code | ||
# error: "BaseOffset" has no attribute "_period_dtype_code" | ||
base1 = self.freq._period_dtype_code # type: ignore[attr-defined] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This error occurs a few times. BaseOffset does not have this attribute but almost all(?) sub-classes of BaseOffset have this attribute. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Not all, no. |
||
base2 = freq._period_dtype_code | ||
|
||
asi8 = self.asi8 | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These operators are not "perfect" but they might be good enough for now. Based on the current annotations,
__add__(self: Year, other: Second)
is declared to return aYear
but it actually returnsSecond