holidays 0.81__py3-none-any.whl → 0.83__py3-none-any.whl

holidays/groups/burmese.py

@@ -0,0 +1,273 @@
+#  holidays
+#  --------
+#  A fast, efficient Python library for generating country, province and state
+#  specific sets of holidays on the fly. It aims to make determining whether a
+#  specific date is a holiday as fast and flexible as possible.
+#
+#  Authors: Vacanza Team and individual contributors (see CONTRIBUTORS file)
+#           dr-prodigy <dr.prodigy.github@gmail.com> (c) 2017-2023
+#           ryanss <ryanssdev@icloud.com> (c) 2014-2017
+#  Website: https://github.com/vacanza/holidays
+#  License: MIT (see LICENSE file)
+
+from datetime import date
+from typing import Optional
+
+from holidays.calendars.burmese import _BurmeseLunisolar
+from holidays.calendars.gregorian import _timedelta
+
+
+class BurmeseCalendarHolidays:
+    """Burmese lunisolar calendar holidays."""
+
+    def __init__(self) -> None:
+        self._burmese_calendar = _BurmeseLunisolar()
+
+    def _add_burmese_calendar_holiday(
+        self, name: str, dt: Optional[date] = None, days_delta: int = 0
+    ) -> Optional[date]:
+        """Add Burmese calendar holiday."""
+
+        if dt is None:
+            return None
+
+        if days_delta:
+            dt = _timedelta(dt, days_delta)
+
+        return self._add_holiday(name, dt)
+
+    def _add_karen_new_year(self, name: str) -> set[date]:
+        """Add Karen New Year holiday.
+
+        The Karen New Year, also known as the Kayin New Year, is one of the major holidays
+        celebrated by the Karen people. The Karen New Year falls on the first day of Pyatho,
+        the tenth month in the Burmese calendar.
+        https://en.wikipedia.org/wiki/Karen_New_Year
+
+        Args:
+            name:
+                Holiday name.
+
+        Returns:
+            Set of dates of added holiday, empty if there is no holiday date for the current year.
+        """
+        return {
+            dt
+            for y in (self._year - 1, self._year)
+            if (
+                dt := self._add_burmese_calendar_holiday(
+                    name, self._burmese_calendar.pyatho_waxing_moon_date(y)
+                )
+            )
+        }
+
+    def _add_kason_full_moon_day(self, name: str) -> Optional[date]:
+        """Add Full Moon Day of Kason holiday.
+
+        Vesak is known as the Full Moon Day of Kason, which is the second month
+        in the traditional Burmese calendar.
+        https://en.wikipedia.org/wiki/Vesak#In_Myanmar_(Burma)
+
+        Args:
+            name:
+                Holiday name.
+
+        Returns:
+            Date of added holiday, `None` if there is no holiday date for the current year.
+        """
+        return self._add_burmese_calendar_holiday(
+            name, self._burmese_calendar.kason_full_moon_date(self._year)
+        )
+
+    def _add_myanmar_diwali(self, name: str) -> Optional[date]:
+        """Add Myanmar Diwali holiday.
+
+        Diwali (Deepavali, Festival of Lights) is one of the most important festivals
+        in Indian religions. In Myanmar, it is celebrated on first day of Tazaungmon,
+        the eighth month of the Burmese calendar.
+        https://en.wikipedia.org/wiki/Diwali
+
+        Args:
+            name:
+                Holiday name.
+
+        Returns:
+            Date of added holiday, `None` if there is no holiday date for the current year.
+        """
+        return self._add_burmese_calendar_holiday(
+            name, self._burmese_calendar.tazaungmon_waxing_moon_date(self._year)
+        )
+
+    def _add_myanmar_national_day(self, name: str) -> Optional[date]:
+        """Add Myanmar National Day holiday.
+
+        National Day is a public holiday in Myanmar, marking the anniversary of the first
+        university student strike at Rangoon University in 1920. The date is based on
+        the traditional Burmese calendar, occurring on the 10th day following
+        the full moon of Tazaungmon.
+        https://en.wikipedia.org/wiki/National_Day_(Myanmar)
+
+        Args:
+            name:
+                Holiday name.
+
+        Returns:
+            Date of added holiday, `None` if there is no holiday date for the current year.
+        """
+        return self._add_burmese_calendar_holiday(
+            name, self._burmese_calendar.tazaungmon_full_moon_date(self._year), days_delta=+10
+        )
+
+    def _add_myanmar_new_year(
+        self,
+        name: str,
+        extra_days_before: int = 0,
+        extra_days_after: int = 0,
+    ) -> set[date]:
+        """Add Myanmar New Year (Thingyan, Water Festival).
+
+        Thingyan, also known as the Myanmar New Year, is a festival that usually occurs
+        in middle of April. Thingyan marks the transition from the old year to the new one,
+        based on the traditional Myanmar lunisolar calendar. The festival usually spans
+        four to five days.
+
+        https://en.wikipedia.org/wiki/Thingyan.
+
+        Args:
+            name:
+                Holiday name.
+
+            extra_days_before:
+                Number of additional holiday days preceding Akya.
+
+            extra_days_after:
+                Whether to add additional holiday days following Atat.
+
+        Returns:
+            Set of dates of added holiday, empty if there is no holiday date for the current year.
+        """
+        akya, atat = self._burmese_calendar.thingyan_dates(self._year)
+        if akya is None or atat is None:
+            return set()
+
+        # Default length is from Thingyan Akyo (akya - 1) to New Year Day (atat + 1).
+        # Optional additional days:
+        # pre-Akya days (1 day in 2007-2016, 4 days in 2022-2023),
+        # post-Atat days (3 or 4 days).
+        begin = -1 - extra_days_before
+        end = extra_days_after or (atat - akya).days + 1
+
+        return {
+            dt
+            for delta in range(begin, end)
+            if (dt := self._add_holiday(name, _timedelta(akya, delta)))
+        }
+
+    def _add_tabaung_full_moon_day(self, name: str) -> Optional[date]:
+        """Add Full Moon Day of Tabaung holiday.
+
+        Māgha Pūjā (also written as Makha Bucha Day, Meak Bochea) is a Buddhist festival
+        celebrated on the full moon day of Tabaung in Myanmar.
+        https://en.wikipedia.org/wiki/Māgha_Pūjā#Myanmar_(Burma)
+
+        Args:
+            name:
+                Holiday name.
+
+        Returns:
+            Date of added holiday, `None` if there is no holiday date for the current year.
+        """
+        return self._add_burmese_calendar_holiday(
+            name, self._burmese_calendar.tabaung_full_moon_date(self._year - 1)
+        )
+
+    def _add_tazaungmon_full_moon_day(self, name: str) -> Optional[date]:
+        """Add Full Moon Day of Tazaungmon holiday.
+
+        The Tazaungdaing Festival, also known as the Festival of Lights, held on the full moon day
+        of Tazaungmon, the eighth month of the Burmese calendar.
+        https://en.wikipedia.org/wiki/Tazaungdaing_festival
+
+        Args:
+            name:
+                Holiday name.
+
+        Returns:
+            Date of added holiday, `None` if there is no holiday date for the current year.
+        """
+        return self._add_burmese_calendar_holiday(
+            name, self._burmese_calendar.tazaungmon_full_moon_date(self._year)
+        )
+
+    def _add_thadingyut_full_moon_eve(self, name: str) -> Optional[date]:
+        """Add Pre-Full Moon Day of Thadingyut holiday.
+
+        The Thadingyut Festival, also known as the Lighting Festival of Myanmar, is held
+        on the full moon day of the Burmese lunar month of Thadingyut.
+        https://en.wikipedia.org/wiki/Thadingyut_Festival
+
+        Args:
+            name:
+                Holiday name.
+
+        Returns:
+            Date of added holiday, `None` if there is no holiday date for the current year.
+        """
+        return self._add_burmese_calendar_holiday(
+            name, self._burmese_calendar.thadingyut_full_moon_date(self._year), days_delta=-1
+        )
+
+    def _add_thadingyut_full_moon_day(self, name: str) -> Optional[date]:
+        """Add Full Moon Day of Thadingyut holiday.
+
+        The Thadingyut Festival, also known as the Lighting Festival of Myanmar, is held
+        on the full moon day of the Burmese lunar month of Thadingyut.
+        https://en.wikipedia.org/wiki/Thadingyut_Festival
+
+        Args:
+            name:
+                Holiday name.
+
+        Returns:
+            Date of added holiday, `None` if there is no holiday date for the current year.
+        """
+        return self._add_burmese_calendar_holiday(
+            name, self._burmese_calendar.thadingyut_full_moon_date(self._year)
+        )
+
+    def _add_thadingyut_full_moon_day_two(self, name: str) -> Optional[date]:
+        """Add Post-Full Moon Day of Thadingyut holiday.
+
+        The Thadingyut Festival, also known as the Lighting Festival of Myanmar, is held
+        on the full moon day of the Burmese lunar month of Thadingyut.
+        https://en.wikipedia.org/wiki/Thadingyut_Festival
+
+        Args:
+            name:
+                Holiday name.
+
+        Returns:
+            Date of added holiday, `None` if there is no holiday date for the current year.
+        """
+        return self._add_burmese_calendar_holiday(
+            name, self._burmese_calendar.thadingyut_full_moon_date(self._year), days_delta=+1
+        )
+
+    def _add_waso_full_moon_day(self, name: str) -> Optional[date]:
+        """Add Full Moon Day of Waso holiday.
+
+        Vassa is the three-month annual retreat observed by Theravada Buddhists.
+        Vassa lasts for three lunar months, from the Burmese month of Waso to
+        the Burmese month of Thadingyut.
+        https://en.wikipedia.org/wiki/Vassa
+
+        Args:
+            name:
+                Holiday name.
+
+        Returns:
+            Date of added holiday, `None` if there is no holiday date for the current year.
+        """
+        return self._add_burmese_calendar_holiday(
+            name, self._burmese_calendar.waso_full_moon_date(self._year)
+        )

holidays/groups/chinese.py

@@ -23,7 +23,7 @@ class ChineseCalendarHolidays(EasternCalendarHolidays):
     Chinese lunisolar calendar holidays.
     """
 
-    def __init__(self, cls=None, show_estimated=False, calendar=CHINESE_CALENDAR) -> None:
+    def __init__(self, cls=None, *, show_estimated=False, calendar=CHINESE_CALENDAR) -> None:
         self._chinese_calendar = (
             cls(calendar=calendar) if cls else _ChineseLunisolar(calendar=calendar)
         )
@@ -92,7 +92,10 @@ class ChineseCalendarHolidays(EasternCalendarHolidays):
         is an estimation.
         """
         return self._add_eastern_calendar_holiday(
-            name, dt_estimated, self._chinese_calendar_show_estimated, days_delta
+            name,
+            dt_estimated,
+            show_estimated=self._chinese_calendar_show_estimated,
+            days_delta=days_delta,
         )
 
     def _add_chinese_birthday_of_buddha(self, name) -> Optional[date]:
@@ -183,6 +186,18 @@ class ChineseCalendarHolidays(EasternCalendarHolidays):
             name, self._chinese_calendar.lunar_new_year_date(self._year), days_delta=+4
         )
 
+    def _add_daeboreum_day(self, name) -> Optional[date]:
+        """
+        Add Daeboreum Day (15th day of 1st lunar month).
+
+        Daeboreum is a Korean holiday that celebrates the first full moon
+        of the new year of the lunar Korean calendar.
+        https://en.wikipedia.org/wiki/Daeboreum
+        """
+        return self._add_chinese_calendar_holiday(
+            name, self._chinese_calendar.lunar_new_year_date(self._year), days_delta=+14
+        )
+
     def _add_dongzhi_festival(self, name) -> Optional[date]:
         """
         Add Dongzhi Festival (Chinese Winter Solstice).
@@ -194,6 +209,19 @@ class ChineseCalendarHolidays(EasternCalendarHolidays):
         """
         return self._add_holiday(name, self._dongzhi_festival)
 
+    def _add_hanshi_festival(self, name) -> Optional[date]:
+        """
+        Add Hanshi Festival (105 days after Winter Solstice).
+
+        The Cold Food or Hanshi Festival is a traditional Chinese holiday. Its name
+        derives from the tradition of avoiding the lighting of any kind of fire,
+        even for the preparation of food.
+        https://en.wikipedia.org/wiki/Cold_Food_Festival
+        """
+        return self._add_chinese_calendar_holiday(
+            name, self._chinese_calendar.winter_solstice_date(self._year - 1), days_delta=+105
+        )
+
     def _add_qingming_festival(self, name) -> date:
         """
         Add Qingming Festival (15th day after the Spring Equinox).

holidays/groups/christian.py

@@ -455,6 +455,16 @@ class ChristianHolidays:
         """
         return self._add_holiday_mar_19(name)
 
+    def _add_saint_patricks_day(self, name) -> date:
+        """
+        Add Saint Patrick's Day (March 17th).
+
+        Saint Patrick's Day is a religious and cultural holiday held on 17 March,
+        the traditional death date of Saint Patrick, the foremost patron saint of Ireland.
+        https://en.wikipedia.org/wiki/Saint_Patrick's_Day
+        """
+        return self._add_holiday_mar_17(name)
+
     def _add_saints_peter_and_paul_day(self, name) -> date:
         """
         Add Feast of Saints Peter and Paul (June 29th).

holidays/groups/custom.py

@@ -31,17 +31,23 @@ class StaticHolidays:
                 setattr(self, attribute_name, value)
                 self.has_special_holidays = True
 
-            # Substituted holidays.
+            # "Substituted" labels.
             elif attribute_name.startswith("substituted_") and (
                 value := getattr(cls, attribute_name, None)
             ):
                 setattr(self, attribute_name, value)
-                self.has_substituted_holidays = True
 
         # Populate substituted holidays from adjacent years.
         self.weekend_workdays = set()
         for special_public_holidays in getattr(self, "special_public_holidays", {}).values():
             for special_public_holiday in _normalize_tuple(special_public_holidays):
+                # Normally, special holiday is a 3 item tuple: (month, day, name).
+                if len(special_public_holiday) < 4:  # Skip non-substituted holidays.
+                    continue
+
+                # Handle cross-year substituted holidays.
                 if len(special_public_holiday) == 5:  # The fifth element is the year.
                     _, _, from_month, from_day, from_year = special_public_holiday
                     self.weekend_workdays.add(date(from_year, from_month, from_day))
+
+                self.has_substituted_holidays = True

holidays/groups/eastern.py

@@ -10,6 +10,7 @@
 #  Website: https://github.com/vacanza/holidays
 #  License: MIT (see LICENSE file)
 
+from collections.abc import Iterable
 from datetime import date
 from typing import Optional
 
@@ -25,6 +26,7 @@ class EasternCalendarHolidays:
         self,
         name: str,
         dt_estimated: tuple[Optional[date], bool],
+        *,
         show_estimated: bool = True,
         days_delta: int = 0,
     ) -> Optional[date]:
@@ -47,3 +49,27 @@ class EasternCalendarHolidays:
             if dt
             else None
         )
+
+    def _add_eastern_calendar_holiday_set(
+        self,
+        name: str,
+        dts_estimated: Iterable[tuple[date, bool]],
+        *,
+        show_estimated: bool = True,
+        days_delta: int = 0,
+    ) -> set[date]:
+        """
+        Add Eastern (Buddhist, Chinese, Hindu, Islamic, Mongolian) calendar holidays.
+
+        Adds customizable estimation label to holiday name if holiday date is an estimation.
+        """
+
+        return {
+            dt
+            for dt_estimated in dts_estimated
+            if (
+                dt := self._add_eastern_calendar_holiday(
+                    name, dt_estimated, show_estimated=show_estimated, days_delta=days_delta
+                )
+            )
+        }

holidays/groups/hebrew.py

@@ -12,10 +12,10 @@
 
 from collections.abc import Iterable
 from datetime import date
-from typing import Optional, Union
+from typing import Union
 
-from holidays.calendars import _HebrewLunisolar
 from holidays.calendars.gregorian import _timedelta
+from holidays.calendars.hebrew import _HebrewLunisolar
 
 
 class HebrewCalendarHolidays:
@@ -29,15 +29,16 @@ class HebrewCalendarHolidays:
     def _add_hebrew_calendar_holiday(
         self, name: str, holiday_date: date, days_delta: Union[int, Iterable[int]] = 0
     ) -> set[date]:
-        added_dates = set()
-        for delta in (days_delta,) if isinstance(days_delta, int) else days_delta:
-            if dt := self._add_holiday(name, _timedelta(holiday_date, delta)):
-                added_dates.add(dt)
-        return added_dates
+        """
+        Add Hebrew calendar holiday.
+        """
+        return {
+            dt
+            for delta in ((days_delta,) if isinstance(days_delta, int) else days_delta)
+            if (dt := self._add_holiday(name, _timedelta(holiday_date, delta)))
+        }
 
-    def _add_hanukkah(
-        self, name: str, days_delta: Union[int, Iterable[int]] = 0
-    ) -> set[Optional[date]]:
+    def _add_hanukkah(self, name: str, days_delta: Union[int, Iterable[int]] = 0) -> set[date]:
         """
         Add Hanukkah.
         In some Gregorian years, there may be two Hanukkah dates.
@@ -46,10 +47,11 @@ class HebrewCalendarHolidays:
         and subsequent rededication of the Second Temple.
         https://en.wikipedia.org/wiki/Hanukkah
         """
-        dts = self._hebrew_calendar.hanukkah_date(self._year)
-        for dt in dts:
-            self._add_hebrew_calendar_holiday(name, dt, days_delta)  # type: ignore[arg-type]
-        return dts
+        return {
+            dt
+            for hanukkah_dt in self._hebrew_calendar.hanukkah_date(self._year)
+            for dt in self._add_hebrew_calendar_holiday(name, hanukkah_dt, days_delta)
+        }
 
     def _add_lag_baomer(self, name: str, days_delta: Union[int, Iterable[int]] = 0) -> set[date]:
         """

holidays/groups/hindu.py

@@ -14,7 +14,7 @@ from collections.abc import Iterable
 from datetime import date
 from typing import Optional
 
-from holidays.calendars import _HinduLunisolar
+from holidays.calendars.hindu import _HinduLunisolar
 from holidays.groups.eastern import EasternCalendarHolidays
 
 
@@ -23,7 +23,7 @@ class HinduCalendarHolidays(EasternCalendarHolidays):
     Hindu lunisolar calendar holidays.
     """
 
-    def __init__(self, cls=None, show_estimated=False) -> None:
+    def __init__(self, cls=None, *, show_estimated=False) -> None:
         self._hindu_calendar = cls() if cls else _HinduLunisolar()
         self._hindu_calendar_show_estimated = show_estimated
 
@@ -38,7 +38,10 @@ class HinduCalendarHolidays(EasternCalendarHolidays):
         """
 
         return self._add_eastern_calendar_holiday(
-            name, dt_estimated, self._hindu_calendar_show_estimated, days_delta
+            name,
+            dt_estimated,
+            show_estimated=self._hindu_calendar_show_estimated,
+            days_delta=days_delta,
         )
 
     def _add_hindu_calendar_holiday_set(
@@ -50,14 +53,12 @@ class HinduCalendarHolidays(EasternCalendarHolidays):
         Adds customizable estimation label to holiday name if holiday date
         is an estimation.
         """
-        added_dates = set()
-        for dt_estimated in dts_estimated:
-            if dt := self._add_eastern_calendar_holiday(
-                name, dt_estimated, self._hindu_calendar_show_estimated, days_delta=days_delta
-            ):
-                added_dates.add(dt)
-
-        return added_dates
+        return self._add_eastern_calendar_holiday_set(
+            name,
+            dts_estimated,
+            show_estimated=self._hindu_calendar_show_estimated,
+            days_delta=days_delta,
+        )
 
     def _add_bhai_dooj(self, name) -> Optional[date]:
         """
@@ -162,11 +163,18 @@ class HinduCalendarHolidays(EasternCalendarHolidays):
 
     def _add_gudi_padwa(self, name) -> Optional[date]:
         """
-        Add Gudi Padwa.
+        Add Gudi Padwa / Ugadi.
+
+        Gudi Padwa is the traditional New Year festival celebrated in
+        Maharashtra. On the same day, the festival is also observed as
+        Ugadi in Karnataka, Telangana, and Andhra Pradesh.
+
+        It falls on the first day of Chaitra (March–April) according to
+        the Hindu lunisolar calendar.
 
-        Gudi Padwa is the traditional New Year festival for Maharashtrians.
-        It falls on the first day of Chaitra (March-April).
-        https://en.wikipedia.org/wiki/Gudi_Padwa
+        References:
+            * https://en.wikipedia.org/wiki/Gudi_Padwa
+            * https://en.wikipedia.org/wiki/Ugadi
         """
         return self._add_hindu_calendar_holiday(
             name, self._hindu_calendar.gudi_padwa_date(self._year)

holidays/groups/international.py

@@ -212,7 +212,7 @@ class InternationalHolidays:
         """
         return self._add_holiday_mar_8(name)
 
-    def _add_world_war_two_victory_day(self, name, is_western=True):
+    def _add_world_war_two_victory_day(self, name, *, is_western=True):
         """
         Add Day of Victory in World War II in Europe (May 8).
         https://en.wikipedia.org/wiki/Victory_in_Europe_Day