pandas.tseries.offsets.CustomBusinessDay

class pandas.tseries.offsets.CustomBusinessDay

DateOffset subclass representing custom business days excluding holidays.

Parameters
nint, default 1
normalizebool, default False

Normalize start/end dates to midnight before generating date range.

weekmaskstr, Default ‘Mon Tue Wed Thu Fri’

Weekmask of valid business days, passed to numpy.busdaycalendar.

holidayslist

List/array of dates to exclude from the set of valid business days, passed to numpy.busdaycalendar.

calendarnp.busdaycalendar
offsettimedelta, default timedelta(0)

Examples

>>> ts = pd.Timestamp(2022, 8, 5)
>>> ts + pd.offsets.CustomBusinessDay(1)
Timestamp('2022-08-08 00:00:00')

Attributes

base

Returns a copy of the calling offset object with n=1 and all other attributes equal.

freqstr

Return a string representing the frequency.

kwds

Return a dict of extra parameters for the offset.

name

Return a string representing the base frequency.

offset

Alias for self._offset.

calendar

holidays

n

nanos

normalize

rule_code

weekmask

Methods

__call__(*args, **kwargs)

Call self as a function.

apply_index

(DEPRECATED) Vectorized apply of DateOffset to DatetimeIndex.

copy

Return a copy of the frequency.

is_anchored

Return boolean whether the frequency is a unit frequency (n=1).

is_month_end

Return boolean whether a timestamp occurs on the month end.

is_month_start

Return boolean whether a timestamp occurs on the month start.

is_on_offset

Return boolean whether a timestamp intersects with this frequency.

is_quarter_end

Return boolean whether a timestamp occurs on the quarter end.

is_quarter_start

Return boolean whether a timestamp occurs on the quarter start.

is_year_end

Return boolean whether a timestamp occurs on the year end.

is_year_start

Return boolean whether a timestamp occurs on the year start.

rollback

Roll provided date backward to next offset only if not on offset.

rollforward

Roll provided date forward to next offset only if not on offset.

apply

isAnchored

onOffset