dycw-utilities 0.167.1__tar.gz → 0.167.2__tar.gz

{dycw_utilities-0.167.1 → dycw_utilities-0.167.2}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.167.1
+Version: 0.167.2
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12
 Requires-Dist: atomicwrites<1.5,>=1.4.1
 Requires-Dist: typing-extensions<4.16,>=4.15.0
 Requires-Dist: tzlocal<5.4,>=5.3.1
-Requires-Dist: whenever<0.9,>=0.8.8
+Requires-Dist: whenever<0.9,>=0.8.9
 Provides-Extra: logging
 Requires-Dist: coloredlogs<15.1,>=15.0.1; extra == 'logging'
 Provides-Extra: test

{dycw_utilities-0.167.1 → dycw_utilities-0.167.2}/pyproject.toml

@@ -25,13 +25,13 @@ cachetools = [
   "cachetools >=6.2.0, <6.3",
 ]
 click = [
-  "click >=8.2.1, <8.3",
+  "click >=8.3.0, <8.4",
 ]
 core = [
   "atomicwrites >=1.4.1, <1.5",
   "typing-extensions >=4.15.0, <4.16",
   "tzlocal >=5.3.1, <5.4",
-  "whenever >=0.8.8, <0.9",
+  "whenever >=0.8.9, <0.9",
 ]
 cryptography = [
   "cryptography >=46.0.1, <46.1",
@@ -52,7 +52,7 @@ dev = [
   "pytest-timeout >=2.4.0, <2.5",
 ]
 fastapi = [
-  "fastapi >=0.116.2, <0.117",
+  "fastapi >=0.117.1, <0.118",
 ]
 fastapi-test = [
   "httpx",
@@ -244,12 +244,12 @@ dependencies = [
   "atomicwrites >=1.4.1, <1.5",
   "typing-extensions >=4.15.0, <4.16",
   "tzlocal >=5.3.1, <5.4",
-  "whenever >=0.8.8, <0.9",
+  "whenever >=0.8.9, <0.9",
 ]
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.167.1"
+version = "0.167.2"
 
 [project.entry-points.pytest11]
 pytest-randomly = "utilities.pytest_plugins.pytest_randomly"
@@ -282,7 +282,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.167.1"
+current_version = "0.167.2"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.167.1 → dycw_utilities-0.167.2}/src/tests/test_whenever.py

@@ -125,6 +125,7 @@ from utilities.whenever import (
     get_time_local,
     get_today,
     get_today_local,
+    is_weekend,
     mean_datetime,
     min_max_date,
     round_date_or_date_time,
@@ -507,6 +508,141 @@ class TestGetTodayLocal:
         assert isinstance(TODAY_LOCAL, Date)
 
 
+class TestIsWeekend:
+    @mark.parametrize(
+        ("weekday", "time", "expected"),
+        [
+            param(Weekday.SATURDAY, Time(23, 59, 59), False),
+            param(Weekday.SUNDAY, Time(7, 59, 59), False),
+            param(Weekday.SUNDAY, Time(8), True),
+            param(Weekday.SUNDAY, Time(8, 0, 1), True),
+            param(Weekday.SUNDAY, Time(16, 59, 59), True),
+            param(Weekday.SUNDAY, Time(17), True),
+            param(Weekday.SUNDAY, Time(17, 0, 1), False),
+        ],
+    )
+    def test_one_day(self, *, weekday: Weekday, time: Time, expected: bool) -> None:
+        self._run_test(
+            weekday,
+            time,
+            Weekday.SUNDAY,
+            Time(8),
+            Weekday.SUNDAY,
+            Time(17),
+            expected=expected,
+        )
+
+    @mark.parametrize(
+        ("weekday", "time", "expected"),
+        [
+            param(Weekday.FRIDAY, Time(23, 59, 59), False),
+            param(Weekday.SATURDAY, Time(), False),
+            param(Weekday.SATURDAY, Time(0, 0, 1), False),
+            param(Weekday.SATURDAY, Time(7, 59, 59), False),
+            param(Weekday.SATURDAY, Time(8), True),
+            param(Weekday.SATURDAY, Time(8, 0, 1), True),
+            param(Weekday.SATURDAY, Time(23, 59, 59), True),
+            param(Weekday.SUNDAY, Time(), True),
+            param(Weekday.SUNDAY, Time(0, 0, 1), True),
+            param(Weekday.SUNDAY, Time(16, 59, 59), True),
+            param(Weekday.SUNDAY, Time(17), True),
+            param(Weekday.SUNDAY, Time(17, 0, 1), False),
+        ],
+    )
+    def test_two_days(self, *, weekday: Weekday, time: Time, expected: bool) -> None:
+        self._run_test(
+            weekday,
+            time,
+            Weekday.SATURDAY,
+            Time(8),
+            Weekday.SUNDAY,
+            Time(17),
+            expected=expected,
+        )
+
+    @mark.parametrize(
+        ("weekday", "time", "expected"),
+        [
+            param(Weekday.THURSDAY, Time(23, 59, 59), False),
+            param(Weekday.FRIDAY, Time(), False),
+            param(Weekday.FRIDAY, Time(0, 0, 1), False),
+            param(Weekday.FRIDAY, Time(7, 59, 59), False),
+            param(Weekday.FRIDAY, Time(8), True),
+            param(Weekday.FRIDAY, Time(8, 0, 1), True),
+            param(Weekday.FRIDAY, Time(23, 59, 59), True),
+            param(Weekday.SATURDAY, Time(), True),
+            param(Weekday.SATURDAY, Time(0, 0, 1), True),
+            param(Weekday.SATURDAY, Time(23, 59, 59), True),
+            param(Weekday.SUNDAY, Time(), True),
+            param(Weekday.SUNDAY, Time(0, 0, 1), True),
+            param(Weekday.SUNDAY, Time(16, 59, 59), True),
+            param(Weekday.SUNDAY, Time(17), True),
+            param(Weekday.SUNDAY, Time(17, 0, 1), False),
+        ],
+    )
+    def test_three_days(self, *, weekday: Weekday, time: Time, expected: bool) -> None:
+        self._run_test(
+            weekday,
+            time,
+            Weekday.FRIDAY,
+            Time(8),
+            Weekday.SUNDAY,
+            Time(17),
+            expected=expected,
+        )
+
+    @mark.parametrize(
+        ("weekday", "time", "expected"),
+        [
+            param(Weekday.FRIDAY, Time(23, 59, 59), False),
+            param(Weekday.SATURDAY, Time(), False),
+            param(Weekday.SATURDAY, Time(0, 0, 1), False),
+            param(Weekday.SATURDAY, Time(7, 59, 59), False),
+            param(Weekday.SATURDAY, Time(8), True),
+            param(Weekday.SATURDAY, Time(8, 0, 1), True),
+            param(Weekday.SATURDAY, Time(23, 59, 59), True),
+            param(Weekday.SUNDAY, Time(), True),
+            param(Weekday.SUNDAY, Time(0, 0, 1), True),
+            param(Weekday.SUNDAY, Time(23, 59, 59), True),
+            param(Weekday.MONDAY, Time(), True),
+            param(Weekday.MONDAY, Time(0, 0, 1), True),
+            param(Weekday.MONDAY, Time(16, 59, 59), True),
+            param(Weekday.MONDAY, Time(17), True),
+            param(Weekday.MONDAY, Time(17, 0, 1), False),
+        ],
+    )
+    def test_wrap(self, *, weekday: Weekday, time: Time, expected: bool) -> None:
+        self._run_test(
+            weekday,
+            time,
+            Weekday.SATURDAY,
+            Time(8),
+            Weekday.MONDAY,
+            Time(17),
+            expected=expected,
+        )
+
+    def _run_test(
+        self,
+        weekday: Weekday,
+        time: Time,
+        start_weekday: Weekday,
+        start_time: Time,
+        end_weekday: Weekday,
+        end_time: Time,
+        /,
+        *,
+        expected: bool,
+    ) -> None:
+        date_time = get_today().at(time).assume_tz(UTC.key)
+        while date_time.date().day_of_week() is not weekday:
+            date_time += DAY
+        result = is_weekend(
+            date_time, start=(start_weekday, start_time), end=(end_weekday, end_time)
+        )
+        assert result is expected
+
+
 class TestMeanDateTime:
     threshold: ClassVar[TimeDelta] = 100 * MICROSECOND
 

{dycw_utilities-0.167.1 → dycw_utilities-0.167.2}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.167.1"
+__version__ = "0.167.2"

{dycw_utilities-0.167.1 → dycw_utilities-0.167.2}/src/utilities/whenever.py

@@ -433,6 +433,36 @@ TODAY_LOCAL = get_today_local()
 ##
 
 
+def is_weekend(
+    date_time: ZonedDateTime,
+    /,
+    *,
+    start: tuple[Weekday, Time] = (Weekday.SATURDAY, Time.MIN),
+    end: tuple[Weekday, Time] = (Weekday.SUNDAY, Time.MAX),
+) -> bool:
+    """Check if a datetime is in the weekend."""
+    weekday, time = date_time.date().day_of_week(), date_time.time()
+    start_weekday, start_time = start
+    end_weekday, end_time = end
+    if start_weekday.value == end_weekday.value:
+        return start_time <= time <= end_time
+    if start_weekday.value < end_weekday.value:
+        return (
+            ((weekday == start_weekday) and (time >= start_time))
+            or (start_weekday.value < weekday.value < end_weekday.value)
+            or ((weekday == end_weekday) and (time <= end_time))
+        )
+    return (
+        ((weekday == start_weekday) and (time >= start_time))
+        or (weekday.value > start_weekday.value)
+        or (weekday.value < end_weekday.value)
+        or ((weekday == end_weekday) and (time <= end_time))
+    )
+
+
+##
+
+
 def mean_datetime(
     datetimes: Iterable[ZonedDateTime],
     /,
@@ -2033,6 +2063,7 @@ __all__ = [
     "get_time_local",
     "get_today",
     "get_today_local",
+    "is_weekend",
     "mean_datetime",
     "min_max_date",
     "round_date_or_date_time",