Class Holiday

pandas/tseries/holiday.py:155–426

Class that defines a holiday with start/end dates and rules for observance.

class Holiday:
    """
    Class that defines a holiday with start/end dates and rules
    for observance.
    """

    start_date: Timestamp | None
    end_date: Timestamp | None
    days_of_week: tuple[int, ...] | None

    def __init__(
        self,
        name: str,
        year=None,
        month=None,
        day=None,
        offset: BaseOffset | list[BaseOffset] | None = None,
        observance: Callable | None = None,
        start_date=None,
        end_date=None,
        days_of_week: tuple | None = None,
        exclude_dates: DatetimeIndex | None = None,
    ) -> None:
        """
        Parameters
        ----------
        name : str
            Name of the holiday , defaults to class name
        year : int, default None
            Year of the holiday
        month : int, default None
            Month of the holiday
        day : int, default None
            Day of the holiday
        offset : list of pandas.tseries.offsets or
                class from pandas.tseries.offsets, default None
            Computes offset from date
        observance : function, default None
            Computes when holiday is given a pandas Timestamp
        start_date : datetime-like, default None
            First date the holiday is observed
        end_date : datetime-like, default None
            Last date the holiday is observed
        days_of_week : tuple of int or dateutil.relativedelta weekday strs, default None
            Provide a tuple of days e.g  (0,1,2,3,) for Monday through Thursday
            Monday=0,..,Sunday=6
            Only instances of the holiday included in days_of_week will be computed
        exclude_dates : DatetimeIndex or default None
            Specific dates to exclude e.g. skipping a specific year's holiday

        Examples
        --------
        >>> from dateutil.relativedelta import MO

        >>> USMemorialDay = pd.tseries.holiday.Holiday(
        ...     "Memorial Day", month=5, day=31, offset=pd.DateOffset(weekday=MO(-1))
        ... )
        >>> USMemorialDay