Skip to content

Cleanup & De-duplication for custom offset classes #18640

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 8 commits into from
Dec 6, 2017
Merged

Cleanup & De-duplication for custom offset classes #18640

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e93ab50
remove unused BeginMixin
jbrockmendel Dec 4, 2017
ce8c7b5
dont use DateOffset.__init__ for YearOffsets
jbrockmendel Dec 4, 2017
1205f44
implement _CustomMixin
jbrockmendel Dec 4, 2017
c37bde0
implement _CustomBusinessMonth
jbrockmendel Dec 4, 2017
c20ea5b
implement next_bday in BusinessHourMixin
jbrockmendel Dec 4, 2017
5d14df6
typo fixup
jbrockmendel Dec 4, 2017
ca9ca9a
define self.kwds outside BusinessHourMixin.__init__
jbrockmendel Dec 4, 2017
2274cc3
edits per reviewer requests
jbrockmendel Dec 5, 2017
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
21 changes: 0 additions & 21 deletions pandas/_libs/tslibs/offsets.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,27 +307,6 @@ class CacheableOffset(object):
_cacheable = True


class BeginMixin(object):
# helper for vectorized offsets

def _beg_apply_index(self, i, freq):
"""Offsets index to beginning of Period frequency"""

off = i.to_perioddelta('D')

base, mult = get_freq_code(freq)
base_period = i.to_period(base)
if self.n <= 0:
# when subtracting, dates on start roll to prior
roll = np.where(base_period.to_timestamp() == i - off,
self.n, self.n + 1)
else:
roll = self.n

base = (base_period + roll).to_timestamp()
return base + off


class EndMixin(object):
# helper for vectorized offsets

Expand Down
178 changes: 70 additions & 108 deletions pandas/tseries/offsets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,25 @@ def _from_name(cls, suffix=None):
return cls()


class _CustomMixin(object):
"""
mixin for classes that define and validate calendar, holidays,
Copy link
Member

Choose a reason for hiding this comment

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

Capitalize "mixin"

Copy link
Member

Choose a reason for hiding this comment

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

There's one below BusinessMixin that you can also fix.

and weekdays attributes
"""
def __init__(self, weekmask, holidays, calendar):
calendar, holidays = _get_calendar(weekmask=weekmask,
holidays=holidays,
calendar=calendar)
# Custom offset instances are identified by the
# following two attributes. See DateOffset._params()
# holidays, weekmask

# assumes self.kwds already exists
self.kwds['weekmask'] = self.weekmask = weekmask
self.kwds['holidays'] = self.holidays = holidays
self.kwds['calendar'] = self.calendar = calendar


class BusinessMixin(object):
""" mixin to business types to provide related functions """

Expand Down Expand Up @@ -572,9 +591,26 @@ def __init__(self, start='09:00', end='17:00', offset=timedelta(0)):
kwds = {'offset': offset}
self.start = kwds['start'] = _validate_business_time(start)
self.end = kwds['end'] = _validate_business_time(end)
self.kwds = kwds
self.kwds.update(kwds)
self._offset = offset

@cache_readonly
def next_bday(self):
# used for moving to next businessday
Copy link
Member

Choose a reason for hiding this comment

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

If you're going to discuss what the function does, let's use a doc-string instead of a comment.

Copy link
Member Author

Choose a reason for hiding this comment

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

This comment is retained from the existing version of the method, not sure it merits a full-on docstring. But will do.

if self.n >= 0:
nb_offset = 1
else:
nb_offset = -1
if self._prefix.startswith('C'):
# CustomBusinessHour
return CustomBusinessDay(n=nb_offset,
weekmask=self.weekmask,
holidays=self.holidays,
calendar=self.calendar)
else:
return BusinessDay(n=nb_offset)

# TODO: Cache this once offsets are immutable
def _get_daytime_flag(self):
if self.start == self.end:
raise ValueError('start and end must not be the same')
Expand Down Expand Up @@ -616,6 +652,7 @@ def _prev_opening_time(self, other):
return datetime(other.year, other.month, other.day,
self.start.hour, self.start.minute)

# TODO: cache this once offsets are immutable
def _get_business_hours_by_sec(self):
"""
Return business hours in a day by seconds.
Expand Down Expand Up @@ -784,19 +821,11 @@ def __init__(self, n=1, normalize=False, start='09:00',
end='17:00', offset=timedelta(0)):
self.n = self._validate_n(n)
self.normalize = normalize
self.kwds = {}
super(BusinessHour, self).__init__(start=start, end=end, offset=offset)

@cache_readonly
def next_bday(self):
# used for moving to next businessday
if self.n >= 0:
nb_offset = 1
else:
nb_offset = -1
return BusinessDay(n=nb_offset)


class CustomBusinessDay(BusinessDay):
class CustomBusinessDay(_CustomMixin, BusinessDay):
"""
DateOffset subclass representing possibly n custom business days,
excluding holidays
Expand All @@ -822,19 +851,9 @@ def __init__(self, n=1, normalize=False, weekmask='Mon Tue Wed Thu Fri',
self.n = self._validate_n(n)
self.normalize = normalize
self._offset = offset
self.kwds = {}

calendar, holidays = _get_calendar(weekmask=weekmask,
holidays=holidays,
calendar=calendar)
# CustomBusinessDay instances are identified by the
# following two attributes. See DateOffset._params()
# holidays, weekmask
self.kwds = {'offset': offset}

self.kwds['weekmask'] = self.weekmask = weekmask
self.kwds['holidays'] = self.holidays = holidays
self.kwds['calendar'] = self.calendar = calendar
self.kwds['offset'] = offset
_CustomMixin.__init__(self, weekmask, holidays, calendar)

@apply_wraps
def apply(self, other):
Expand Down Expand Up @@ -874,7 +893,8 @@ def onOffset(self, dt):
return np.is_busday(day64, busdaycal=self.calendar)


class CustomBusinessHour(BusinessHourMixin, SingleConstructorOffset):
class CustomBusinessHour(_CustomMixin, BusinessHourMixin,
SingleConstructorOffset):
"""
DateOffset subclass representing possibly n custom business days

Expand All @@ -889,27 +909,11 @@ def __init__(self, n=1, normalize=False, weekmask='Mon Tue Wed Thu Fri',
start='09:00', end='17:00', offset=timedelta(0)):
self.n = self._validate_n(n)
self.normalize = normalize
super(CustomBusinessHour, self).__init__(start=start,
end=end, offset=offset)

calendar, holidays = _get_calendar(weekmask=weekmask,
holidays=holidays,
calendar=calendar)
self.kwds['weekmask'] = self.weekmask = weekmask
self.kwds['holidays'] = self.holidays = holidays
self.kwds['calendar'] = self.calendar = calendar
self._offset = offset
self.kwds = {'offset': offset}

@cache_readonly
def next_bday(self):
# used for moving to next businessday
if self.n >= 0:
nb_offset = 1
else:
nb_offset = -1
return CustomBusinessDay(n=nb_offset,
weekmask=self.weekmask,
holidays=self.holidays,
calendar=self.calendar)
_CustomMixin.__init__(self, weekmask, holidays, calendar)
BusinessHourMixin.__init__(self, start=start, end=end, offset=offset)


# ---------------------------------------------------------------------
Expand Down Expand Up @@ -981,10 +985,10 @@ class BusinessMonthBegin(MonthOffset):
_day_opt = 'business_start'


class CustomBusinessMonthEnd(BusinessMixin, MonthOffset):
class _CustomBusinessMonth(_CustomMixin, BusinessMixin, MonthOffset):
"""
DateOffset subclass representing one custom business month, incrementing
between end of month dates
between [BEGIN/END] of month dates

Parameters
----------
Expand All @@ -999,27 +1003,19 @@ class CustomBusinessMonthEnd(BusinessMixin, MonthOffset):
passed to ``numpy.busdaycalendar``
calendar : pd.HolidayCalendar or np.busdaycalendar
"""

_cacheable = False
_prefix = 'CBM'

onOffset = DateOffset.onOffset # override MonthOffset method
onOffset = DateOffset.onOffset # override MonthOffset method
apply_index = DateOffset.apply_index # override MonthOffset method

def __init__(self, n=1, normalize=False, weekmask='Mon Tue Wed Thu Fri',
holidays=None, calendar=None, offset=timedelta(0)):
self.n = self._validate_n(n)
self.normalize = normalize
self._offset = offset
self.kwds = {}
self.kwds = {'offset': offset}

calendar, holidays = _get_calendar(weekmask=weekmask,
holidays=holidays,
calendar=calendar)
self.kwds['weekmask'] = self.weekmask = weekmask
self.kwds['holidays'] = self.holidays = holidays
self.kwds['calendar'] = self.calendar = calendar
self.kwds['offset'] = offset
_CustomMixin.__init__(self, weekmask, holidays, calendar)

@cache_readonly
def cbday(self):
Expand All @@ -1028,7 +1024,17 @@ def cbday(self):

@cache_readonly
def m_offset(self):
return MonthEnd(n=1, normalize=self.normalize)
if self._prefix.endswith('S'):
# MonthBegin:
return MonthBegin(n=1, normalize=self.normalize)
else:
# MonthEnd
return MonthEnd(n=1, normalize=self.normalize)


class CustomBusinessMonthEnd(_CustomBusinessMonth):
__doc__ = _CustomBusinessMonth.__doc__.replace('[BEGIN/END]', 'end')
_prefix = 'CBM'

@apply_wraps
def apply(self, other):
Expand All @@ -1054,57 +1060,10 @@ def apply(self, other):
return result


class CustomBusinessMonthBegin(BusinessMixin, MonthOffset):
"""
DateOffset subclass representing one custom business month, incrementing
between beginning of month dates

Parameters
----------
n : int, default 1
offset : timedelta, default timedelta(0)
normalize : bool, default False
Normalize start/end dates to midnight before generating date range
weekmask : str, Default 'Mon Tue Wed Thu Fri'
weekmask of valid business days, passed to ``numpy.busdaycalendar``
holidays : list
list/array of dates to exclude from the set of valid business days,
passed to ``numpy.busdaycalendar``
calendar : pd.HolidayCalendar or np.busdaycalendar
"""

_cacheable = False
class CustomBusinessMonthBegin(_CustomBusinessMonth):
__doc__ = _CustomBusinessMonth.__doc__.replace('[BEGIN/END]', 'beginning')
_prefix = 'CBMS'

onOffset = DateOffset.onOffset # override MonthOffset method
apply_index = DateOffset.apply_index # override MonthOffset method

def __init__(self, n=1, normalize=False, weekmask='Mon Tue Wed Thu Fri',
holidays=None, calendar=None, offset=timedelta(0)):
self.n = self._validate_n(n)
self.normalize = normalize
self._offset = offset
self.kwds = {}

# _get_calendar does validation and possible transformation
# of calendar and holidays.
calendar, holidays = _get_calendar(weekmask=weekmask,
holidays=holidays,
calendar=calendar)
self.kwds['calendar'] = self.calendar = calendar
self.kwds['weekmask'] = self.weekmask = weekmask
self.kwds['holidays'] = self.holidays = holidays
self.kwds['offset'] = offset

@cache_readonly
def cbday(self):
kwds = self.kwds
return CustomBusinessDay(n=self.n, normalize=self.normalize, **kwds)

@cache_readonly
def m_offset(self):
return MonthBegin(n=1, normalize=self.normalize)

@apply_wraps
def apply(self, other):
n = self.n
Expand Down Expand Up @@ -1707,13 +1666,16 @@ def onOffset(self, dt):
return dt.month == self.month and dt.day == self._get_offset_day(dt)

def __init__(self, n=1, normalize=False, month=None):
self.n = self._validate_n(n)
self.normalize = normalize

month = month if month is not None else self._default_month
self.month = month

if self.month < 1 or self.month > 12:
raise ValueError('Month must go from 1 to 12')

DateOffset.__init__(self, n=n, normalize=normalize, month=month)
self.kwds = {'month': month}

@classmethod
def _from_name(cls, suffix=None):
Expand Down