Add HolidayBase::is_weekend method (#2780)

Co-authored-by: Arkadii Yakovets <[email protected]>

Author: KJhellico

holidays/holiday_base.py

@@ -1135,6 +1135,20 @@ def get_working_days_count(self, start: DateLike, end: DateLike) -> int:
         days = (dt2 - dt1).days + 1
         return sum(self.is_working_day(_timedelta(dt1, n)) for n in range(days))
 
+    def is_weekend(self, key: DateLike) -> bool:
+        """Check if the given date's week day is a weekend day.
+
+        Args:
+            key:
+                The date to check.
+
+        Returns:
+            True if the date's week day is a weekend day, False otherwise.
+        """
+        # To prioritize performance we avoid reusing the internal
+        # `HolidayBase._is_weekend` method and perform the check directly instead.
+        return self.__keytransform__(key).weekday() in self.weekend
+
     def is_working_day(self, key: DateLike) -> bool:
         """Check if the given date is considered a working day.
 

tests/test_holiday_base.py

@@ -696,6 +696,29 @@ def _populate(self, year):
         self.assertIn("2020-07-13", hb)
 
 
+class TestIsWeekend(unittest.TestCase):
+    def setUp(self):
+        self.hb = CountryStub1()
+
+    def test_is_weekend(self):
+        self.hb._populate(2022)
+
+        self.hb.weekend = {MON, TUE}
+        for dt in (date(2022, 10, 3), date(2022, 10, 4), "2022-10-03", "2022-10-04"):
+            self.assertTrue(self.hb.is_weekend(dt))
+
+        self.hb.weekend = set()
+        for dt in (date(2022, 10, 3), date(2022, 10, 4), "2022-10-03", "2022-10-04"):
+            self.assertFalse(self.hb.is_weekend(dt))
+
+        self.hb.weekend = {SAT, SUN}
+        for dt in (date(2022, 10, 1), date(2022, 10, 2), "2022-10-01", "2022-10-02"):
+            self.assertTrue(self.hb.is_weekend(dt))
+
+        for dt in (date(2022, 10, 3), date(2022, 10, 4), "2022-10-03", "2022-10-04"):
+            self.assertFalse(self.hb.is_weekend(dt))
+
+
 class TestKeyTransforms(unittest.TestCase):
     def setUp(self):
         self.hb = CountryStub1()