pandas.tseries.holiday.AbstractHolidayCalendar.holidays#

AbstractHolidayCalendar.holidays(start=None, end=None, return_name=False)[source]#

Return a curve with holidays between start_date and end_date.

The holidays for the calendar are computed by evaluating the dates of each rule in self.rules and merging the results, caching them so that repeated calls covering a previously requested date range do not need to be recomputed.

Parameters:

startstarting date, datetime-like, optional: The earliest date to consider, defaults to AbstractHolidayCalendar.start_date.
endending date, datetime-like, optional: The latest date to consider, defaults to AbstractHolidayCalendar.end_date.
return_namebool, optional: If True, return a series that has dates and holiday names. False will only return a DatetimeIndex of dates.

Returns:

DatetimeIndex or Series: DatetimeIndex of holidays, or a Series mapping holiday dates to their names if return_name is True.

See also

tseries.holiday.Holiday.dates: Calculate holidays observed between start date and end date.

Examples

>>> from pandas.tseries.holiday import AbstractHolidayCalendar, USLaborDay
>>> class MyCalendar(AbstractHolidayCalendar):
...     rules = [USLaborDay]
>>> MyCalendar().holidays(start="2020-01-01", end="2020-12-31")
DatetimeIndex(['2020-09-07'], dtype='datetime64[us]', freq=None)