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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.138.11
+Version: 0.138.13
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12
@@ -12,7 +12,7 @@ Provides-Extra: logging
 Requires-Dist: coloredlogs<15.1,>=15.0.1; extra == 'logging'
 Provides-Extra: test
 Requires-Dist: dycw-pytest-only<2.2,>=2.1.1; extra == 'test'
-Requires-Dist: hypothesis<6.136,>=6.135.15; extra == 'test'
+Requires-Dist: hypothesis<6.136,>=6.135.16; extra == 'test'
 Requires-Dist: pudb<2025.2,>=2025.1; extra == 'test'
 Requires-Dist: pytest-asyncio<1.1,>=1.0.0; extra == 'test'
 Requires-Dist: pytest-cov<6.2,>=6.1.1; extra == 'test'

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

@@ -36,12 +36,12 @@ dev = [
   "pytest-timeout >= 2.4.0, < 2.5",
 ]
 eventkit = ["eventkit >= 1.0.3, < 1.1"]
-fastapi = ["fastapi >= 0.115.11, < 0.116"]
+fastapi = ["fastapi >= 0.115.14, < 0.116"]
 fastapi-test = ["httpx", "uvicorn"]
 fpdf2 = ["fpdf2 >= 2.8.3, < 2.9"]
 hashlib-test = ["orjson"]
 http-test = ["orjson"]
-hypothesis = ["hypothesis >= 6.135.15, < 6.136"]
+hypothesis = ["hypothesis >= 6.135.16, < 6.136"]
 hypothesis-test = ["libcst", "luigi", "pathvalidate", "numpy", "pytest-rerunfailures"]
 inflect = ["inflect >= 7.5.0, < 7.6"]
 jupyter-test = ["pandas", "polars"]
@@ -106,7 +106,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.138.11"
+version = "0.138.13"
 
 [project.entry-points.pytest11]
 pytest-regressions = "utilities.pytest_regressions_plugin"
@@ -117,7 +117,7 @@ logging = [
 ]
 test = [
   "dycw-pytest-only >= 2.1.1, < 2.2",
-  "hypothesis >= 6.135.15, < 6.136",
+  "hypothesis >= 6.135.16, < 6.136",
   "pudb >= 2025.1, < 2025.2",
   "pytest >= 8.3.5, < 8.4",
   "pytest-asyncio >= 1.0.0, < 1.1",
@@ -137,7 +137,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.138.11"
+current_version = "0.138.13"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.138.11 → dycw_utilities-0.138.13}/src/tests/test_polars.py

@@ -153,6 +153,7 @@ from utilities.polars import (
     nan_sum_agg,
     nan_sum_cols,
     normal,
+    order_of_magnitude,
     reify_exprs,
     replace_time_zone,
     set_first_row_as_columns,
@@ -1990,6 +1991,32 @@ class TestNormal:
         assert series.is_finite().all()
 
 
+class TestOrderOfMagnitude:
+    @given(
+        sign=sampled_from([1, -1]),
+        case=sampled_from([
+            (0.25, -0.60206, -1),
+            (0.5, -0.30103, 0),
+            (0.75, -0.1249387, 0),
+            (1.0, 0.0, 0),
+            (5.0, 0.69897, 1),
+            (10.0, 1.0, 1),
+            (50.0, 1.69897, 2),
+            (100.0, 2.0, 2),
+        ]),
+    )
+    def test_main(self, *, sign: int, case: tuple[float, float, int]) -> None:
+        x, exp_float, exp_int = case
+        x_use = Series(values=[sign * x])
+        res_float = order_of_magnitude(x_use)
+        assert res_float.dtype == Float64
+        assert_series_equal(res_float, Series([exp_float]))
+        res_int = order_of_magnitude(x_use, round_=True)
+        assert res_int.dtype == Int64
+        assert_series_equal(res_int, Series([exp_int]))
+        assert (res_int == exp_int).all()
+
+
 class TestReifyExprs:
     @given(length=hypothesis.strategies.integers(0, 10), name=text_ascii())
     def test_one_expr(self, *, length: int, name: str) -> None:

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

@@ -64,6 +64,7 @@ from utilities.whenever import (
     MeanDateTimeError,
     MinMaxDateError,
     ToDaysError,
+    ToMonthsError,
     ToNanosError,
     ToPyTimeDeltaError,
     WheneverLogRecord,
@@ -88,6 +89,7 @@ from utilities.whenever import (
     to_date_time_delta,
     to_days,
     to_local_plain,
+    to_months,
     to_nanos,
     to_py_time_delta,
     to_time_delta,
@@ -523,6 +525,24 @@ class TestToLocalPlain:
         assert isinstance(result, PlainDateTime)
 
 
+class TestToMonths:
+    @given(months=integers())
+    def test_main(self, *, months: int) -> None:
+        with (
+            assume_does_not_raise(ValueError, match="months out of range"),
+            assume_does_not_raise(
+                OverflowError, match="Python int too large to convert to C long"
+            ),
+        ):
+            delta = DateDelta(months=months)
+        assert to_months(delta) == months
+
+    def test_error(self) -> None:
+        delta = DateDelta(days=1)
+        with raises(ToMonthsError, match="Date delta must not contain days; got 1"):
+            _ = to_months(delta)
+
+
 class TestToPyTimeDelta:
     @mark.parametrize(
         ("delta", "expected"),

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

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

{dycw_utilities-0.138.11 → dycw_utilities-0.138.13}/src/utilities/polars.py

@@ -1833,6 +1833,26 @@ def normal(
 ##
 
 
+@overload
+def order_of_magnitude(column: ExprLike, /, *, round_: bool = False) -> Expr: ...
+@overload
+def order_of_magnitude(column: Series, /, *, round_: bool = False) -> Series: ...
+@overload
+def order_of_magnitude(
+    column: IntoExprColumn, /, *, round_: bool = False
+) -> Expr | Series: ...
+def order_of_magnitude(
+    column: IntoExprColumn, /, *, round_: bool = False
+) -> Expr | Series:
+    """Compute the order of magnitude of a column."""
+    column = ensure_expr_or_series(column)
+    result = column.abs().log10()
+    return result.round().cast(Int64) if round_ else result
+
+
+##
+
+
 def reify_exprs(
     *exprs: IntoExprColumn, **named_exprs: IntoExprColumn
 ) -> Expr | Series | DataFrame:
@@ -2184,6 +2204,7 @@ __all__ = [
     "nan_sum_agg",
     "nan_sum_cols",
     "normal",
+    "order_of_magnitude",
     "replace_time_zone",
     "set_first_row_as_columns",
     "struct_dtype",

{dycw_utilities-0.138.11 → dycw_utilities-0.138.13}/src/utilities/whenever.py

@@ -552,6 +552,26 @@ def to_local_plain(date_time: ZonedDateTime, /) -> PlainDateTime:
 ##
 
 
+def to_months(delta: DateDelta, /) -> int:
+    """Compute the number of months in a date delta."""
+    months, days = delta.in_months_days()
+    if days != 0:
+        raise ToMonthsError(days=days)
+    return months
+
+
+@dataclass(kw_only=True, slots=True)
+class ToMonthsError(Exception):
+    days: int
+
+    @override
+    def __str__(self) -> str:
+        return f"Date delta must not contain days; got {self.days}"
+
+
+##
+
+
 def to_nanos(delta: DateTimeDelta, /) -> int:
     """Compute the number of nanoseconds in a date-time delta."""
     try:
@@ -801,6 +821,7 @@ __all__ = [
     "MeanDateTimeError",
     "MinMaxDateError",
     "ToDaysError",
+    "ToMonthsError",
     "ToNanosError",
     "ToPyTimeDeltaError",
     "WheneverLogRecord",
@@ -819,6 +840,7 @@ __all__ = [
     "to_date_time_delta",
     "to_days",
     "to_local_plain",
+    "to_months",
     "to_nanos",
     "to_py_time_delta",
     "to_zoned_date_time",