dycw-utilities 0.159.4__tar.gz → 0.159.5__tar.gz

{dycw_utilities-0.159.4 → dycw_utilities-0.159.5}/PKG-INFO

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

{dycw_utilities-0.159.4 → dycw_utilities-0.159.5}/pyproject.toml

@@ -227,7 +227,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.159.4"
+version = "0.159.5"
 
 [project.entry-points.pytest11]
 pytest-randomly = "utilities.pytest_plugins.pytest_randomly"
@@ -259,7 +259,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.159.4"
+current_version = "0.159.5"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.159.4 → dycw_utilities-0.159.5}/src/tests/test_polars.py

@@ -9,7 +9,7 @@ from enum import auto
 from itertools import chain, repeat
 from math import isfinite, nan
 from random import Random
-from typing import TYPE_CHECKING, Any, ClassVar, Literal, assert_never
+from typing import TYPE_CHECKING, Any, ClassVar, Literal, assert_never, cast
 from uuid import UUID, uuid4
 
 import hypothesis.strategies
@@ -97,6 +97,7 @@ from utilities.polars import (
     InsertBeforeError,
     OneColumnEmptyError,
     OneColumnNonUniqueError,
+    RoundToFloatError,
     SetFirstRowAsColumnsError,
     TimePeriodDType,
     _check_polars_dataframe_predicates,
@@ -1560,7 +1561,7 @@ class TestFiniteEWMWeights:
 
 class TestFirstTrueHorizontal:
     @mark.parametrize(
-        ("row", "expected"),
+        ("values", "expected"),
         [
             param([True, True, True], 0),
             param([False, True, True], 1),
@@ -1568,9 +1569,9 @@ class TestFirstTrueHorizontal:
             param([False, False, False], None),
         ],
     )
-    def test_main(self, *, row: list[bool], expected: int | None) -> None:
-        df = DataFrame([row], schema={str(i): Boolean for i in range(3)}, orient="row")
-        result = first_true_horizontal(df)
+    def test_main(self, *, values: list[bool], expected: int | None) -> None:
+        series = [Series(values=[v], dtype=Boolean) for v in values]
+        result = first_true_horizontal(*series)
         assert result.item() == expected
 
 
@@ -2427,8 +2428,8 @@ class TestReplaceTimeZone:
 class TestRoundToFloat:
     @mark.parametrize(("x", "y", "exp_value"), tests.test_math.TestRoundToFloat.cases)
     def test_main(self, *, x: float, y: float, exp_value: float) -> None:
-        series = Series(name="x", values=[x], dtype=Float64)
-        result = round_to_float(series, y)
+        x_sr = Series(name="x", values=[x], dtype=Float64)
+        result = round_to_float(x_sr, y)
         expected = Series(name="x", values=[exp_value], dtype=Float64)
         assert_series_equal(result, expected, check_exact=True)
 
@@ -2441,6 +2442,29 @@ class TestRoundToFloat:
         expected = Series(name="x", values=[1.2], dtype=Float64).to_frame()
         assert_frame_equal(df, expected)
 
+    def test_series_and_expr(self) -> None:
+        x = Series(name="x", values=[1.234], dtype=Float64)
+        y = lit(0.1, dtype=Float64).alias("y")
+        result = round_to_float(x, y)
+        assert result.item() == 1.2
+
+    def test_expr_and_expr(self) -> None:
+        x = lit(1.234, dtype=Float64).alias("x")
+        y = Series(name="y", values=[0.1], dtype=Float64)
+        result = round_to_float(x, y)
+        assert result.item() == 1.2
+
+    @mark.parametrize(
+        ("x", "y"),
+        [param("x", "y"), param(col.x, "y"), param("x", col.y), param(col.x, col.y)],
+    )
+    def test_error(self, *, x: IntoExprColumn, y: IntoExprColumn) -> None:
+        with raises(
+            RoundToFloatError,
+            match="At least 1 of the dividend and/or divisor must be a Series; got .* and .*",
+        ):
+            _ = round_to_float(cast("Any", x), cast("Any", y))
+
 
 class TestSerializeAndDeserializeDataFrame:
     cases: ClassVar[list[tuple[PolarsDataType, SearchStrategy[Any]]]] = [

{dycw_utilities-0.159.4 → dycw_utilities-0.159.5}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.159.4"
+__version__ = "0.159.5"

{dycw_utilities-0.159.4 → dycw_utilities-0.159.5}/src/utilities/polars.py

@@ -57,6 +57,7 @@ import utilities.math
 from utilities.dataclasses import yield_fields
 from utilities.errors import ImpossibleCaseError
 from utilities.functions import (
+    get_class_name,
     is_dataclass_class,
     is_dataclass_instance,
     make_isinstance,
@@ -1324,10 +1325,27 @@ class _FiniteEWMWeightsError(Exception):
 ##
 
 
-def first_true_horizontal(df: DataFrame, /) -> Series:
+@overload
+def first_true_horizontal(column: Series, /) -> Series: ...
+@overload
+def first_true_horizontal(column1: Series, column2: Series, /) -> Series: ...
+@overload
+def first_true_horizontal(
+    column1: Series, column2: Series, column3: Series, /
+) -> Series: ...
+@overload
+def first_true_horizontal(
+    column1: Series, column2: Series, column3: Series, column4: Series, /
+) -> Series: ...
+@overload
+def first_true_horizontal(*columns: Series) -> Series: ...
+@overload
+def first_true_horizontal(*columns: IntoExprColumn) -> ExprOrSeries: ...
+def first_true_horizontal(*columns: IntoExprColumn) -> ExprOrSeries:
     """Get the index of the first true in each row."""
-    expr = when(any_horizontal(pl.all())).then(concat_list(pl.all()).list.arg_max())
-    return one_column(df.select(expr))
+    columns2 = ensure_expr_or_series_many(*columns)
+    expr = when(any_horizontal(*columns2)).then(concat_list(*columns2).list.arg_max())
+    return try_reify_expr(expr, *columns2)
 
 
 ##
@@ -1972,19 +1990,31 @@ def normal(
 ##
 
 
+@overload
+def number_of_decimals(
+    series: ExprLike, /, *, max_decimals: int = MAX_DECIMALS
+) -> Expr: ...
+@overload
 def number_of_decimals(
     series: Series, /, *, max_decimals: int = MAX_DECIMALS
-) -> Series:
+) -> Series: ...
+@overload
+def number_of_decimals(
+    series: IntoExprColumn, /, *, max_decimals: int = MAX_DECIMALS
+) -> ExprOrSeries: ...
+def number_of_decimals(
+    series: IntoExprColumn, /, *, max_decimals: int = MAX_DECIMALS
+) -> ExprOrSeries:
     """Get the number of decimals."""
+    series = ensure_expr_or_series(series)
     frac = series - series.floor()
-    results = [
+    results = (
         _number_of_decimals_check_scale(frac, s) for s in range(max_decimals + 1)
-    ]
-    df_results = concat_series(*results)
-    return first_true_horizontal(df_results)
+    )
+    return first_true_horizontal(*results)
 
 
-def _number_of_decimals_check_scale(frac: Series, scale: int, /) -> Series:
+def _number_of_decimals_check_scale(frac: ExprOrSeries, scale: int, /) -> ExprOrSeries:
     scaled = 10**scale * frac
     return is_close(scaled, scaled.round()).alias(str(scale))
 
@@ -2346,19 +2376,63 @@ def round_to_float(
 ) -> Expr: ...
 @overload
 def round_to_float(
-    x: Series, y: float, /, *, mode: RoundMode = "half_to_even"
+    x: Series, y: float | ExprOrSeries, /, *, mode: RoundMode = "half_to_even"
+) -> Series: ...
+@overload
+def round_to_float(
+    x: ExprLike, y: Series, /, *, mode: RoundMode = "half_to_even"
 ) -> Series: ...
 @overload
 def round_to_float(
-    x: IntoExprColumn, y: float, /, *, mode: RoundMode = "half_to_even"
+    x: ExprLike, y: Expr, /, *, mode: RoundMode = "half_to_even"
+) -> Expr: ...
+@overload
+def round_to_float(
+    x: IntoExprColumn, y: float | Series, /, *, mode: RoundMode = "half_to_even"
 ) -> ExprOrSeries: ...
 def round_to_float(
-    x: IntoExprColumn, y: float, /, *, mode: RoundMode = "half_to_even"
+    x: IntoExprColumn, y: float | IntoExprColumn, /, *, mode: RoundMode = "half_to_even"
 ) -> ExprOrSeries:
     """Round a column to the nearest multiple of another float."""
     x = ensure_expr_or_series(x)
-    z = (x / y).round(mode=mode) * y
-    return z.round(decimals=utilities.math.number_of_decimals(y) + 1)
+    y = y if isinstance(y, int | float) else ensure_expr_or_series(y)
+    match x, y:
+        case Expr() | Series(), int() | float():
+            z = (x / y).round(mode=mode) * y
+            return z.round(decimals=utilities.math.number_of_decimals(y) + 1)
+        case Series(), Expr() | Series():
+            df = (
+                x.to_frame()
+                .with_columns(y)
+                .with_columns(number_of_decimals(y).alias("_decimals"))
+                .with_row_index(name="_index")
+                .group_by("_decimals")
+                .map_groups(_round_to_float_one)
+                .sort("_index")
+            )
+            return df[df.columns[1]]
+        case Expr(), Series():
+            df = y.to_frame().with_columns(x)
+            return round_to_float(df[df.columns[1]], df[df.columns[0]], mode=mode)
+        case Expr(), Expr() | str():
+            raise RoundToFloatError(x=x, y=y)
+        case never:
+            assert_never(never)
+
+
+def _round_to_float_one(df: DataFrame, /) -> DataFrame:
+    decimals: int = df["_decimals"].unique().item()
+    return df.with_columns(col(df.columns[1]).round(decimals=decimals))
+
+
+@dataclass(kw_only=True, slots=True)
+class RoundToFloatError(Exception):
+    x: IntoExprColumn
+    y: IntoExprColumn
+
+    @override
+    def __str__(self) -> str:
+        return f"At least 1 of the dividend and/or divisor must be a Series; got {get_class_name(self.x)!r} and {get_class_name(self.y)!r}"
 
 
 ##
@@ -2571,6 +2645,7 @@ __all__ = [
     "OneColumnEmptyError",
     "OneColumnError",
     "OneColumnNonUniqueError",
+    "RoundToFloatError",
     "SetFirstRowAsColumnsError",
     "TimePeriodDType",
     "acf",