dycw-utilities 0.113.2__tar.gz → 0.113.3__tar.gz

{dycw_utilities-0.113.2 → dycw_utilities-0.113.3}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.113.2
+Version: 0.113.3
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12
 Requires-Dist: typing-extensions<4.14,>=4.13.1
 Provides-Extra: test
-Requires-Dist: hypothesis<6.132,>=6.131.10; extra == 'test'
+Requires-Dist: hypothesis<6.132,>=6.131.14; extra == 'test'
 Requires-Dist: pytest-asyncio<0.27,>=0.26.0; extra == 'test'
 Requires-Dist: pytest-cov<6.2,>=6.1.1; extra == 'test'
 Requires-Dist: pytest-instafail<0.6,>=0.5.0; extra == 'test'
@@ -80,7 +80,7 @@ Provides-Extra: zzz-test-hypothesis
 Requires-Dist: aiosqlite<0.22,>=0.21.0; extra == 'zzz-test-hypothesis'
 Requires-Dist: asyncpg<0.31,>=0.30.0; extra == 'zzz-test-hypothesis'
 Requires-Dist: greenlet<3.3,>=3.2.0; extra == 'zzz-test-hypothesis'
-Requires-Dist: hypothesis<6.132,>=6.131.10; extra == 'zzz-test-hypothesis'
+Requires-Dist: hypothesis<6.132,>=6.131.14; extra == 'zzz-test-hypothesis'
 Requires-Dist: luigi<3.7,>=3.6.0; extra == 'zzz-test-hypothesis'
 Requires-Dist: numpy<2.3,>=2.2.5; extra == 'zzz-test-hypothesis'
 Requires-Dist: pathvalidate<3.3,>=3.2.3; extra == 'zzz-test-hypothesis'

{dycw_utilities-0.113.2 → dycw_utilities-0.113.3}/pyproject.toml

@@ -26,7 +26,7 @@ dev = [
   "fpdf2 >= 2.8.3, < 2.9",
   "greenlet >= 3.2.0, < 3.3",  # for sqlalchemy async
   "httpx >= 0.28.1, < 0.29",  # for fastapi
-  "hypothesis >= 6.131.10, < 6.132",
+  "hypothesis >= 6.131.14, < 6.132",
   "img2pdf >= 0.6.0, < 0.7",
   "lightweight-charts >= 2.1, < 2.2",
   "loguru >= 0.7.3, < 0.8",
@@ -92,11 +92,11 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.113.2"
+version = "0.113.3"
 
 [project.optional-dependencies]
 test = [
-  "hypothesis >= 6.131.10, < 6.132",
+  "hypothesis >= 6.131.14, < 6.132",
   "pytest >= 8.3.5, < 8.4",
   "pytest-asyncio >= 0.26.0, < 0.27",
   "pytest-cov >= 6.1.1, < 6.2",
@@ -174,7 +174,7 @@ zzz-test-hypothesis = [
   "aiosqlite >= 0.21.0, < 0.22",
   "asyncpg >= 0.30.0, < 0.31",  # for sqlalchemy async
   "greenlet >= 3.2.0, < 3.3",  # for sqlalchemy async
-  "hypothesis >= 6.131.10, < 6.132",
+  "hypothesis >= 6.131.14, < 6.132",
   "luigi >= 3.6.0, < 3.7",
   "numpy >= 2.2.5, < 2.3",
   "pathvalidate >= 3.2.3, < 3.3",
@@ -334,7 +334,7 @@ zzz-test-zoneinfo = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.113.2"
+current_version = "0.113.3"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.113.2 → dycw_utilities-0.113.3}/src/tests/test_datetime.py

@@ -50,6 +50,7 @@ from utilities.datetime import (
     AreEqualDateTimesError,
     CheckDateNotDateTimeError,
     EnsureMonthError,
+    GetMinMaxDateError,
     MeanDateTimeError,
     MeanTimeDeltaError,
     MillisecondsSinceEpochError,
@@ -67,6 +68,11 @@ from utilities.datetime import (
     _DateDurationToIntTimeDeltaError,
     _DateDurationToTimeDeltaFloatError,
     _DateDurationToTimeDeltaTimeDeltaError,
+    _GetMinMaxDateMaxAgeError,
+    _GetMinMaxDateMaxDateError,
+    _GetMinMaxDateMinAgeError,
+    _GetMinMaxDateMinDateError,
+    _GetMinMaxDatePeriodError,
     _ParseTwoDigitYearInvalidIntegerError,
     _ParseTwoDigitYearInvalidStringError,
     add_duration,
@@ -91,6 +97,7 @@ from utilities.datetime import (
     get_date,
     get_datetime,
     get_half_years,
+    get_min_max_date,
     get_months,
     get_now,
     get_quarters,
@@ -129,6 +136,7 @@ from utilities.datetime import (
 from utilities.functions import not_func
 from utilities.hypothesis import (
     assume_does_not_raise,
+    date_durations,
     int32s,
     months,
     pairs,
@@ -148,6 +156,7 @@ if TYPE_CHECKING:
     from utilities.sentinel import Sentinel
     from utilities.types import (
         DateOrDateTime,
+        Duration,
         MaybeCallableDate,
         MaybeCallableDateTime,
         Number,
@@ -675,6 +684,79 @@ class TestGetDateTime:
         assert get_datetime(datetime=lambda: datetime) == datetime
 
 
+class TestGetMinMaxDate:
+    @given(
+        min_date=dates(max_value=TODAY_UTC) | none(),
+        max_date=dates(max_value=TODAY_UTC) | none(),
+        min_age=date_durations(min_int=0, min_timedelta=ZERO_TIME) | none(),
+        max_age=date_durations(min_int=0, min_timedelta=ZERO_TIME) | none(),
+    )
+    def test_main(
+        self,
+        *,
+        min_date: dt.date | None,
+        max_date: dt.date | None,
+        min_age: Duration | None,
+        max_age: Duration | None,
+    ) -> None:
+        with assume_does_not_raise(GetMinMaxDateError, OverflowError):
+            min_date_use, max_date_use = get_min_max_date(
+                min_date=min_date, max_date=max_date, min_age=min_age, max_age=max_age
+            )
+        if (min_date is None) and (max_age is None):
+            assert min_date_use is None
+        else:
+            assert min_date_use is not None
+        if (max_date is None) and (min_age is None):
+            assert max_date_use is None
+        else:
+            assert max_date_use is not None
+        if min_date_use is not None:
+            assert min_date_use <= get_today()
+        if max_date_use is not None:
+            assert max_date_use <= get_today()
+        if (min_date_use is not None) and (max_date_use is not None):
+            assert min_date_use <= max_date_use
+
+    @given(date=dates(min_value=TODAY_UTC + DAY))
+    def test_error_min_date(self, *, date: dt.date) -> None:
+        with raises(
+            _GetMinMaxDateMinDateError,
+            match="Min date must be at most today; got .* > .*",
+        ):
+            _ = get_min_max_date(min_date=date)
+
+    @given(duration=date_durations(max_int=-1, max_timedelta=-DAY))
+    def test_error_min_age(self, *, duration: Duration) -> None:
+        with raises(
+            _GetMinMaxDateMinAgeError, match="Min age must be non-negative; got .*"
+        ):
+            _ = get_min_max_date(min_age=duration)
+
+    @given(date=dates(min_value=TODAY_UTC + DAY))
+    def test_error_max_date(self, *, date: dt.date) -> None:
+        with raises(
+            _GetMinMaxDateMaxDateError,
+            match="Max date must be at most today; got .* > .*",
+        ):
+            _ = get_min_max_date(max_date=date)
+
+    @given(duration=date_durations(max_int=-1, max_timedelta=-DAY))
+    def test_error_max_age(self, *, duration: Duration) -> None:
+        with raises(
+            _GetMinMaxDateMaxAgeError, match="Max age must be non-negative; got .*"
+        ):
+            _ = get_min_max_date(max_age=duration)
+
+    @given(dates=pairs(dates(max_value=TODAY_UTC), unique=True, sorted=True))
+    def test_error_period(self, *, dates: tuple[dt.date, dt.date]) -> None:
+        with raises(
+            _GetMinMaxDatePeriodError,
+            match="Min date must be at most max date; got .* > .*",
+        ):
+            _ = get_min_max_date(min_date=dates[1], max_date=dates[0])
+
+
 class TestGetNow:
     @given(time_zone=timezones())
     def test_function(self, *, time_zone: ZoneInfo) -> None:

{dycw_utilities-0.113.2 → dycw_utilities-0.113.3}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.113.2"
+__version__ = "0.113.3"

{dycw_utilities-0.113.2 → dycw_utilities-0.113.3}/src/utilities/datetime.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import datetime as dt
-from collections.abc import Callable, Iterable
+from collections.abc import Callable, Iterable, Sequence
 from dataclasses import dataclass, replace
 from re import search, sub
 from statistics import fmean
@@ -495,6 +495,101 @@ def get_half_years(*, n: int = 1) -> dt.timedelta:
 
 HALF_YEAR = get_half_years(n=1)
 
+##
+
+
+def get_min_max_date(
+    *,
+    min_date: dt.date | None = None,
+    max_date: dt.date | None = None,
+    min_age: Duration | None = None,
+    max_age: Duration | None = None,
+    time_zone: TimeZoneLike = UTC,
+) -> tuple[dt.date | None, dt.date | None]:
+    """Get the min/max date given a combination of dates/ages."""
+    today = get_today(time_zone=time_zone)
+    min_parts: Sequence[dt.date] = []
+    if min_date is not None:
+        if min_date > today:
+            raise _GetMinMaxDateMinDateError(min_date=min_date, today=today)
+        min_parts.append(min_date)
+    if max_age is not None:
+        if date_duration_to_timedelta(max_age) < ZERO_TIME:
+            raise _GetMinMaxDateMaxAgeError(max_age=max_age)
+        min_parts.append(sub_duration(today, duration=max_age))
+    min_date_use = max(min_parts, default=None)
+    max_parts: Sequence[dt.date] = []
+    if max_date is not None:
+        if max_date > today:
+            raise _GetMinMaxDateMaxDateError(max_date=max_date, today=today)
+        max_parts.append(max_date)
+    if min_age is not None:
+        if date_duration_to_timedelta(min_age) < ZERO_TIME:
+            raise _GetMinMaxDateMinAgeError(min_age=min_age)
+        max_parts.append(sub_duration(today, duration=min_age))
+    max_date_use = min(max_parts, default=None)
+    if (
+        (min_date_use is not None)
+        and (max_date_use is not None)
+        and (min_date_use > max_date_use)
+    ):
+        raise _GetMinMaxDatePeriodError(min_date=min_date_use, max_date=max_date_use)
+    return min_date_use, max_date_use
+
+
+@dataclass(kw_only=True, slots=True)
+class GetMinMaxDateError(Exception): ...
+
+
+@dataclass(kw_only=True, slots=True)
+class _GetMinMaxDateMinDateError(GetMinMaxDateError):
+    min_date: dt.date
+    today: dt.date
+
+    @override
+    def __str__(self) -> str:
+        return f"Min date must be at most today; got {self.min_date} > {self.today}"
+
+
+@dataclass(kw_only=True, slots=True)
+class _GetMinMaxDateMinAgeError(GetMinMaxDateError):
+    min_age: Duration
+
+    @override
+    def __str__(self) -> str:
+        return f"Min age must be non-negative; got {self.min_age}"
+
+
+@dataclass(kw_only=True, slots=True)
+class _GetMinMaxDateMaxDateError(GetMinMaxDateError):
+    max_date: dt.date
+    today: dt.date
+
+    @override
+    def __str__(self) -> str:
+        return f"Max date must be at most today; got {self.max_date} > {self.today}"
+
+
+@dataclass(kw_only=True, slots=True)
+class _GetMinMaxDateMaxAgeError(GetMinMaxDateError):
+    max_age: Duration
+
+    @override
+    def __str__(self) -> str:
+        return f"Max age must be non-negative; got {self.max_age}"
+
+
+@dataclass(kw_only=True, slots=True)
+class _GetMinMaxDatePeriodError(GetMinMaxDateError):
+    min_date: dt.date
+    max_date: dt.date
+
+    @override
+    def __str__(self) -> str:
+        return (
+            f"Min date must be at most max date; got {self.min_date} > {self.max_date}"
+        )
+
 
 ##
 
@@ -1244,6 +1339,7 @@ __all__ = [
     "CheckDateNotDateTimeError",
     "DateOrMonth",
     "EnsureMonthError",
+    "GetMinMaxDateError",
     "MeanDateTimeError",
     "MeanTimeDeltaError",
     "MillisecondsSinceEpochError",
@@ -1280,6 +1376,7 @@ __all__ = [
     "get_date",
     "get_datetime",
     "get_half_years",
+    "get_min_max_date",
     "get_months",
     "get_now",
     "get_quarters",