dycw-utilities 0.138.13__tar.gz → 0.138.15__tar.gz

{dycw_utilities-0.138.13 → dycw_utilities-0.138.15}/PKG-INFO

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

{dycw_utilities-0.138.13 → dycw_utilities-0.138.15}/pyproject.toml

@@ -106,7 +106,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.138.13"
+version = "0.138.15"
 
 [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.13"
+current_version = "0.138.15"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.138.13 → dycw_utilities-0.138.15}/src/tests/test_whenever.py

@@ -74,7 +74,9 @@ from utilities.whenever import (
     _MinMaxDateMaxDateError,
     _MinMaxDateMinDateError,
     _MinMaxDatePeriodError,
+    add_year_month,
     datetime_utc,
+    diff_year_month,
     format_compact,
     from_timestamp,
     from_timestamp_millis,
@@ -85,6 +87,7 @@ from utilities.whenever import (
     get_today_local,
     mean_datetime,
     min_max_date,
+    sub_year_month,
     to_date,
     to_date_time_delta,
     to_days,
@@ -99,10 +102,43 @@ from utilities.whenever import (
 from utilities.zoneinfo import UTC
 
 if TYPE_CHECKING:
+    from _pytest.mark import ParameterSet
+
     from utilities.sentinel import Sentinel
     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:
@@ -118,6 +154,35 @@ class TestDatetimeUTC:
         assert result == datetime
 
 
+class TestDiffYearMonth:
+    x: ClassVar[YearMonth] = YearMonth(2005, 7)
+    cases: ClassVar[list[ParameterSet]] = [
+        param(YearMonth(2004, 7), 1, 0),
+        param(YearMonth(2004, 8), 0, 11),
+        param(YearMonth(2005, 1), 0, 6),
+        param(YearMonth(2005, 5), 0, 2),
+        param(YearMonth(2005, 6), 0, 1),
+        param(YearMonth(2005, 7), 0, 0),
+        param(YearMonth(2005, 8), 0, -1),
+        param(YearMonth(2005, 9), 0, -2),
+        param(YearMonth(2006, 1), 0, -6),
+        param(YearMonth(2006, 6), 0, -11),
+        param(YearMonth(2006, 7), -1, 0),
+    ]
+
+    @mark.parametrize(("y", "year", "month"), cases)
+    def test_main(self, *, y: YearMonth, year: int, month: int) -> None:
+        result = diff_year_month(self.x, y)
+        expected = 12 * year + month
+        assert result == expected
+
+    @mark.parametrize(("y", "year", "month"), cases)
+    def test_year_and_month(self, *, y: YearMonth, year: int, month: int) -> None:
+        result = diff_year_month(self.x, y, years=True)
+        expected = (year, month)
+        assert result == expected
+
+
 class TestFormatCompact:
     @given(date=dates())
     def test_date(self, *, date: Date) -> None:

{dycw_utilities-0.138.13 → dycw_utilities-0.138.15}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.138.13"
+__version__ = "0.138.15"

{dycw_utilities-0.138.13 → dycw_utilities-0.138.15}/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.13 → dycw_utilities-0.138.15}/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,
@@ -155,6 +170,34 @@ def datetime_utc(
 ##
 
 
+@overload
+def diff_year_month(
+    x: YearMonth, y: YearMonth, /, *, years: Literal[True]
+) -> tuple[int, int]: ...
+@overload
+def diff_year_month(
+    x: YearMonth, y: YearMonth, /, *, years: Literal[False] = False
+) -> int: ...
+@overload
+def diff_year_month(
+    x: YearMonth, y: YearMonth, /, *, years: bool = False
+) -> int | tuple[int, int]: ...
+def diff_year_month(
+    x: YearMonth, y: YearMonth, /, *, years: bool = False
+) -> int | tuple[int, int]:
+    """Compute the difference between two year-months."""
+    x_date, y_date = x.on_day(1), y.on_day(1)
+    diff = x_date - y_date
+    if years:
+        yrs, mth, _ = diff.in_years_months_days()
+        return yrs, mth
+    mth, _ = diff.in_months_days()
+    return mth
+
+
+##
+
+
 def format_compact(
     obj: Date | Time | PlainDateTime | ZonedDateTime, /, *, fmt: str | None = None
 ) -> str:
@@ -825,7 +868,9 @@ __all__ = [
     "ToNanosError",
     "ToPyTimeDeltaError",
     "WheneverLogRecord",
+    "add_year_month",
     "datetime_utc",
+    "diff_year_month",
     "format_compact",
     "from_timestamp",
     "from_timestamp_millis",
@@ -836,6 +881,7 @@ __all__ = [
     "get_today_local",
     "mean_datetime",
     "min_max_date",
+    "sub_year_month",
     "to_date",
     "to_date_time_delta",
     "to_days",