dycw-utilities 0.138.14__tar.gz → 0.138.16__tar.gz

{dycw_utilities-0.138.14 → dycw_utilities-0.138.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.138.14
+Version: 0.138.16
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12

{dycw_utilities-0.138.14 → dycw_utilities-0.138.16}/pyproject.toml

@@ -106,7 +106,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.138.14"
+version = "0.138.16"
 
 [project.entry-points.pytest11]
 pytest-regressions = "utilities.pytest_regressions_plugin"
@@ -137,7 +137,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.138.14"
+current_version = "0.138.16"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.138.14 → dycw_utilities-0.138.16}/src/tests/test_whenever.py

@@ -74,6 +74,7 @@ from utilities.whenever import (
     _MinMaxDateMaxDateError,
     _MinMaxDateMinDateError,
     _MinMaxDatePeriodError,
+    add_year_month,
     datetime_utc,
     diff_year_month,
     format_compact,
@@ -86,12 +87,14 @@ from utilities.whenever import (
     get_today_local,
     mean_datetime,
     min_max_date,
+    sub_year_month,
     to_date,
     to_date_time_delta,
     to_days,
     to_local_plain,
     to_months,
     to_nanos,
+    to_py_date_or_date_time,
     to_py_time_delta,
     to_time_delta,
     to_zoned_date_time,
@@ -106,6 +109,37 @@ if TYPE_CHECKING:
     from utilities.types import MaybeCallableDate, MaybeCallableZonedDateTime
 
 
+class TestAddAndSubYearMonth:
+    x: ClassVar[YearMonth] = YearMonth(2005, 7)
+    cases: ClassVar[list[tuple[int, int, YearMonth, YearMonth]]] = [
+        (1, 0, YearMonth(2006, 7), YearMonth(2004, 7)),
+        (0, 11, YearMonth(2006, 6), YearMonth(2004, 8)),
+        (0, 6, YearMonth(2006, 1), YearMonth(2005, 1)),
+        (0, 2, YearMonth(2005, 9), YearMonth(2005, 5)),
+        (0, 1, YearMonth(2005, 8), YearMonth(2005, 6)),
+        (0, 0, YearMonth(2005, 7), YearMonth(2005, 7)),
+        (0, -1, YearMonth(2005, 6), YearMonth(2005, 8)),
+        (0, -2, YearMonth(2005, 5), YearMonth(2005, 9)),
+        (0, -6, YearMonth(2005, 1), YearMonth(2006, 1)),
+        (0, -11, YearMonth(2004, 8), YearMonth(2006, 6)),
+        (-1, 0, YearMonth(2004, 7), YearMonth(2006, 7)),
+    ]
+
+    @mark.parametrize(
+        ("years", "months", "expected"), [param(y, m, e) for y, m, e, _ in cases]
+    )
+    def test_add(self, *, years: int, months: int, expected: YearMonth) -> None:
+        result = add_year_month(self.x, years=years, months=months)
+        assert result == expected
+
+    @mark.parametrize(
+        ("years", "months", "expected"), [param(y, m, e) for y, m, _, e in cases]
+    )
+    def test_sub(self, *, years: int, months: int, expected: YearMonth) -> None:
+        result = sub_year_month(self.x, years=years, months=months)
+        assert result == expected
+
+
 class TestDatetimeUTC:
     @given(datetime=zoned_datetimes())
     def test_main(self, *, datetime: ZonedDateTime) -> None:
@@ -575,6 +609,28 @@ class TestToMonths:
             _ = to_months(delta)
 
 
+class TestToPyDateOrDateTime:
+    @mark.parametrize(
+        ("date_or_date_time", "expected"),
+        [
+            param(Date(2000, 1, 1), dt.date(2000, 1, 1)),
+            param(
+                ZonedDateTime(2000, 1, 1, tz=UTC.key),
+                dt.datetime(2000, 1, 1, tzinfo=UTC),
+            ),
+            param(None, None),
+        ],
+    )
+    def test_main(
+        self,
+        *,
+        date_or_date_time: Date | ZonedDateTime | None,
+        expected: dt.date | None,
+    ) -> None:
+        result = to_py_date_or_date_time(date_or_date_time)
+        assert result == expected
+
+
 class TestToPyTimeDelta:
     @mark.parametrize(
         ("delta", "expected"),
@@ -585,10 +641,14 @@ class TestToPyTimeDelta:
                 DateTimeDelta(days=1, microseconds=1),
                 dt.timedelta(days=1, microseconds=1),
             ),
+            param(None, None),
         ],
     )
     def test_main(
-        self, *, delta: DateDelta | TimeDelta | DateTimeDelta, expected: dt.timedelta
+        self,
+        *,
+        delta: DateDelta | TimeDelta | DateTimeDelta | None,
+        expected: dt.timedelta | None,
     ) -> None:
         result = to_py_time_delta(delta)
         assert result == expected

{dycw_utilities-0.138.14 → dycw_utilities-0.138.16}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.138.14"
+__version__ = "0.138.16"

{dycw_utilities-0.138.14 → dycw_utilities-0.138.16}/src/utilities/types.py

@@ -88,6 +88,10 @@ class Dataclass(Protocol):
     __dataclass_fields__: ClassVar[dict[str, Any]]
 
 
+# datetime
+type MonthInt = Literal[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
+
+
 # enum
 type EnumLike[E: Enum] = MaybeStr[E]
 
@@ -270,6 +274,7 @@ __all__ = [
     "MaybeStr",
     "MaybeType",
     "MonthDayLike",
+    "MonthInt",
     "Number",
     "OpenMode",
     "OptExcInfo",

{dycw_utilities-0.138.14 → dycw_utilities-0.138.16}/src/utilities/whenever.py

@@ -126,6 +126,21 @@ YEAR = DateDelta(years=1)
 ##
 
 
+def add_year_month(x: YearMonth, /, *, years: int = 0, months: int = 0) -> YearMonth:
+    """Add to a year-month."""
+    y = x.on_day(1) + DateDelta(years=years, months=months)
+    return y.year_month()
+
+
+def sub_year_month(x: YearMonth, /, *, years: int = 0, months: int = 0) -> YearMonth:
+    """Subtract from a year-month."""
+    y = x.on_day(1) - DateDelta(years=years, months=months)
+    return y.year_month()
+
+
+##
+
+
 def datetime_utc(
     year: int,
     month: int,
@@ -621,7 +636,39 @@ class ToNanosError(Exception):
 ##
 
 
-def to_py_time_delta(delta: DateDelta | TimeDelta | DateTimeDelta, /) -> dt.timedelta:
+@overload
+def to_py_date_or_date_time(date_or_date_time: Date, /) -> dt.date: ...
+@overload
+def to_py_date_or_date_time(date_or_date_time: ZonedDateTime, /) -> dt.datetime: ...
+@overload
+def to_py_date_or_date_time(date_or_date_time: None, /) -> None: ...
+def to_py_date_or_date_time(
+    date_or_date_time: Date | ZonedDateTime | None, /
+) -> dt.date | None:
+    """Convert a Date or ZonedDateTime into a standard library equivalent."""
+    match date_or_date_time:
+        case Date() as date:
+            return date.py_date()
+        case ZonedDateTime() as date_time:
+            return date_time.py_datetime()
+        case None:
+            return None
+        case _ as never:
+            assert_never(never)
+
+
+##
+
+
+@overload
+def to_py_time_delta(
+    delta: DateDelta | TimeDelta | DateTimeDelta, /
+) -> dt.timedelta: ...
+@overload
+def to_py_time_delta(delta: None, /) -> None: ...
+def to_py_time_delta(
+    delta: DateDelta | TimeDelta | DateTimeDelta | None, /
+) -> dt.timedelta | None:
     """Try convert a DateDelta to a standard library timedelta."""
     match delta:
         case DateDelta():
@@ -636,6 +683,8 @@ def to_py_time_delta(delta: DateDelta | TimeDelta | DateTimeDelta, /) -> dt.time
             return to_py_time_delta(delta.date_part()) + to_py_time_delta(
                 delta.time_part()
             )
+        case None:
+            return None
         case _ as never:
             assert_never(never)
 
@@ -853,6 +902,7 @@ __all__ = [
     "ToNanosError",
     "ToPyTimeDeltaError",
     "WheneverLogRecord",
+    "add_year_month",
     "datetime_utc",
     "diff_year_month",
     "format_compact",
@@ -865,12 +915,14 @@ __all__ = [
     "get_today_local",
     "mean_datetime",
     "min_max_date",
+    "sub_year_month",
     "to_date",
     "to_date_time_delta",
     "to_days",
     "to_local_plain",
     "to_months",
     "to_nanos",
+    "to_py_date_or_date_time",
     "to_py_time_delta",
     "to_zoned_date_time",
     "two_digit_year_month",