python: groupby_dynamic closed left (#4332)

pola-rs · Aug 9, 2022 · ead3f52 · ead3f52
1 parent fb971a2
commit ead3f52
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 8 deletions.
diff --git a/py-polars/polars/internals/frame.py b/py-polars/polars/internals/frame.py
@@ -2963,7 +2963,7 @@ def groupby_dynamic(
         offset: str | None = None,
         truncate: bool = True,
         include_boundaries: bool = False,
-        closed: ClosedWindow = "right",
+        closed: ClosedWindow = "left",
         by: str | list[str] | pli.Expr | list[pli.Expr] | None = None,
     ) -> DynamicGroupBy[DF]:
         """
@@ -3071,7 +3071,7 @@ def groupby_dynamic(
         Group by windows of 1 hour starting at 2021-12-16 00:00:00.
 
         >>> (
-        ...     df.groupby_dynamic("time", every="1h").agg(
+        ...     df.groupby_dynamic("time", every="1h", closed="right").agg(
         ...         [
         ...             pl.col("time").min().alias("time_min"),
         ...             pl.col("time").max().alias("time_max"),
@@ -3096,9 +3096,9 @@ def groupby_dynamic(
         The window boundaries can also be added to the aggregation result
 
         >>> (
-        ...     df.groupby_dynamic("time", every="1h", include_boundaries=True).agg(
-        ...         [pl.col("time").count().alias("time_count")]
-        ...     )
+        ...     df.groupby_dynamic(
+        ...         "time", every="1h", include_boundaries=True, closed="right"
+        ...     ).agg([pl.col("time").count().alias("time_count")])
         ... )
         shape: (4, 4)
         ┌─────────────────────┬─────────────────────┬─────────────────────┬────────────┐
@@ -3243,6 +3243,7 @@ def groupby_dynamic(
         ...         every="2i",
         ...         period="3i",
         ...         include_boundaries=True,
+        ...         closed="right",
         ...     ).agg(pl.col("A").list().alias("A_agg_list"))
         ... )
         shape: (3, 4)

diff --git a/py-polars/polars/internals/lazy_frame.py b/py-polars/polars/internals/lazy_frame.py
@@ -1100,7 +1100,7 @@ def groupby_dynamic(
         offset: str | None = None,
         truncate: bool = True,
         include_boundaries: bool = False,
-        closed: ClosedWindow = "right",
+        closed: ClosedWindow = "left",
         by: str | list[str] | pli.Expr | list[pli.Expr] | None = None,
     ) -> LazyGroupBy[LDF]:
         """

diff --git a/py-polars/tests/test_df.py b/py-polars/tests/test_df.py
@@ -453,7 +453,7 @@ def test_groupby_dynamic_agg_input_types(lazy: bool) -> None:
     for bad_param in BAD_AGG_PARAMETERS:
         with pytest.raises(TypeError):
             result = df_or_lazy.groupby_dynamic(
-                index_column="index_column", every="2i"
+                index_column="index_column", every="2i", closed="right"
             ).agg(
                 bad_param  # type: ignore[arg-type]
             )
@@ -464,7 +464,7 @@ def test_groupby_dynamic_agg_input_types(lazy: bool) -> None:
 
     for good_param in GOOD_AGG_PARAMETERS:
         result = df_or_lazy.groupby_dynamic(
-            index_column="index_column", every="2i"
+            index_column="index_column", every="2i", closed="right"
         ).agg(good_param)
         if lazy:
             result = result.collect()  # type: ignore[union-attr]