pandas.tseries.offsets.BusinessDay

class pandas.tseries.offsets.BusinessDay

DateOffset subclass representing possibly n business days.

BusinessDay, also known as BDay, is a date offset representing a single business day or a number of business days. Business days exclude weekends (Saturday and Sunday) by default.

Attributes

n	Return the count of the number of periods.
normalize	Return boolean whether the frequency can align with midnight.
offset	Return the time offset applied to the business day.

See also

DateOffset

Standard kind of date increment.

Examples

You can use the parameter n to represent a shift of n business days.

>>> ts = pd.Timestamp(2022, 12, 9, 15)
>>> ts.strftime('%a %d %b %Y %H:%M')
'Fri 09 Dec 2022 15:00'
>>> (ts + pd.offsets.BusinessDay(n=5)).strftime('%a %d %b %Y %H:%M')
'Fri 16 Dec 2022 15:00'

Passing the parameter normalize equal to True, you shift the start of the next business day to midnight.

>>> ts = pd.Timestamp(2022, 12, 9, 15)
>>> ts + pd.offsets.BusinessDay(normalize=True)
Timestamp('2022-12-12 00:00:00')

Attributes

base	Returns a copy of the calling offset object with n=1 and all other attributes equal.
calendar	Return the calendar used for business day calculations.
freqstr	Return a string representing the frequency.
holidays	Return the holidays used for custom business day calculations.
kwds	Return a dict of extra parameters for the offset.
n	Return the count of the number of periods.
name	Return a string representing the base frequency.
nanos	Return an integer of the total number of nanoseconds.
normalize	Return boolean whether the frequency can align with midnight.
offset	Return the time offset applied to the business day.
rule_code	Return a string representing the base frequency.
weekmask	Return the weekmask used for custom business day calculations.

Methods

copy()	Return a copy of the frequency.
is_month_end(ts)	Return boolean whether a timestamp occurs on the month end.
is_month_start(ts)	Return boolean whether a timestamp occurs on the month start.
is_on_offset(dt)	Return boolean whether a timestamp intersects with this frequency.
is_quarter_end(ts)	Return boolean whether a timestamp occurs on the quarter end.
is_quarter_start(ts)	Return boolean whether a timestamp occurs on the quarter start.
is_year_end(ts)	Return boolean whether a timestamp occurs on the year end.
is_year_start(ts)	Return boolean whether a timestamp occurs on the year start.
rollback(dt)	Roll provided date backward to next offset only if not on offset.
rollforward(dt)	Roll provided date forward to next offset only if not on offset.