A Holidays library for python

In this example we look at a library that you can install  for generating country, province and state specific sets of holidays on the fly.

Installation

The latest version can be installed  via pip like this.

$ pip install holidays

Syntax

class holidays.HolidayBase(years=[], expand=True, observed=True, prov=None, state=None)

The base class used to create holiday country classes.

Parameters:

It takes the following parameter.

• years – It is an iterable list of integers that specify the holidays object should pre-generated. This parameter can only use if the setting increases to False.
• expand – It represents a Boolean value that denotes whether or not to add holidays in the New Year. By default, it is true.
• observed – When we set the observed Boolean value as True, it will include the observed day of a holiday that falls on a weekend.
• prov – It is a string value specifying a province that has unique constitutional holidays. By Default (Australia='ACT', Canada='ON', NewZealand=None).
• state – It represents a state with unique constitutional holidays. (Default – United States = None).

Available Countries

Examples

In this example we will get the list of Uk holidays for 2022

from datetime import date  
import holidays

# Select country  
uk_holidays_list = holidays.UnitedKingdom()

# printing all the holiday of India year 2022  
for p in holidays.UnitedKingdom(years = 2022).items():  
    print(p)  

Running this I saw the following displayed

Run holidasyuk.py
(datetime.date(2022, 1, 1), "New Year's Day")
(datetime.date(2022, 1, 3), "New Year's Day (Observed)")
(datetime.date(2022, 1, 2), 'New Year Holiday [Scotland]')
(datetime.date(2022, 1, 4), 'New Year Holiday [Scotland] (Observed)')
(datetime.date(2022, 3, 17), "St. Patrick's Day [Northern Ireland]")
(datetime.date(2022, 7, 12), 'Battle of the Boyne [Northern Ireland]')
(datetime.date(2022, 8, 1), 'Summer Bank Holiday [Scotland]')
(datetime.date(2022, 11, 30), "St. Andrew's Day [Scotland]")
(datetime.date(2022, 12, 25), 'Christmas Day')
(datetime.date(2022, 12, 27), 'Christmas Day (Observed)')
(datetime.date(2022, 4, 15), 'Good Friday')
(datetime.date(2022, 4, 18), 'Easter Monday [England/Wales/Northern Ireland]')
(datetime.date(2022, 5, 2), 'May Day')
(datetime.date(2022, 6, 2), 'Spring Bank Holiday')
(datetime.date(2022, 8, 29), 'Late Summer Bank Holiday [England/Wales/Northern Ireland]')
(datetime.date(2022, 12, 26), 'Boxing Day')
(datetime.date(2022, 6, 3), 'Platinum Jubilee of Elizabeth II')

Holidays for a state or province

Now, I live in Scotland, so to get my holidays you can see in the table above I can set the state parameter to Scotland

from datetime import date  
import holidays

# Select country  
uk_holidays_list = holidays.UnitedKingdom()

# printing all the holiday of India year 2022  
for p in holidays.UnitedKingdom(state='Scotland',years = 2022).items():  
    print(p)  

When I run this I see the following

%Run holidays_scotland.py
(datetime.date(2022, 1, 1), "New Year's Day")
(datetime.date(2022, 1, 3), "New Year's Day (Observed)")
(datetime.date(2022, 1, 2), 'New Year Holiday')
(datetime.date(2022, 1, 4), 'New Year Holiday (Observed)')
(datetime.date(2022, 8, 1), 'Summer Bank Holiday')
(datetime.date(2022, 11, 30), "St. Andrew's Day")
(datetime.date(2022, 12, 25), 'Christmas Day')
(datetime.date(2022, 12, 27), 'Christmas Day (Observed)')
(datetime.date(2022, 4, 15), 'Good Friday')
(datetime.date(2022, 5, 2), 'May Day')
(datetime.date(2022, 6, 2), 'Spring Bank Holiday')
(datetime.date(2022, 12, 26), 'Boxing Day')
(datetime.date(2022, 6, 3), 'Platinum Jubilee of Elizabeth II')

Check a given date is a holiday

If you want to check a date is a holiday you can do something like this

from datetime import date
import holidays  
  
# Select country  
print (date(2022, 1, 1) in holidays.UK())
print (date(2022, 1, 24) in holidays.UK())
print (date(2022, 12, 25) in holidays.UK())

When run I saw the following displayed

>>> %Run checkholiday.py
True
False
True

Links

examples on github