Skip to content

Add type hint for (core.arrays).ranges #26936

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 2 commits into from
Jun 21, 2019
Merged

Add type hint for (core.arrays).ranges #26936

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
baafc0c
Add type hint for (core.arrays).ranges
xcz011 Jun 19, 2019
96aa1cf
remove comma
xcz011 Jun 19, 2019
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
19 changes: 15 additions & 4 deletions pandas/core/arrays/_ranges.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,19 @@
(and possibly TimedeltaArray/PeriodArray)
"""

from typing import Tuple

import numpy as np

from pandas._libs.tslibs import OutOfBoundsDatetime, Timestamp

from pandas.tseries.offsets import Tick, generate_range
from pandas.tseries.offsets import DateOffset, Tick, generate_range


def generate_regular_range(start, end, periods, freq):
def generate_regular_range(start: Timestamp,
end: Timestamp,
periods: int,
freq: DateOffset) -> Tuple[np.ndarray, str]:
"""
Generate a range of dates with the spans between dates described by
the given `freq` DateOffset.
Expand Down Expand Up @@ -79,7 +84,10 @@ def generate_regular_range(start, end, periods, freq):
return values, tz


def _generate_range_overflow_safe(endpoint, periods, stride, side='start'):
def _generate_range_overflow_safe(endpoint: int,
periods: int,
stride: int,
side: str = 'start') -> int:
"""
Calculate the second endpoint for passing to np.arange, checking
to avoid an integer overflow. Catch OverflowError and re-raise
Expand Down Expand Up @@ -146,7 +154,10 @@ def _generate_range_overflow_safe(endpoint, periods, stride, side='start'):
return _generate_range_overflow_safe(midpoint, remaining, stride, side)


def _generate_range_overflow_safe_signed(endpoint, periods, stride, side):
def _generate_range_overflow_safe_signed(endpoint: int,
periods: int,
stride: int,
side: str) -> int:
"""
A special case for _generate_range_overflow_safe where `periods * stride`
can be calculated without overflowing int64 bounds.
Expand Down