feat(python): Mark min_periods as keyword-only for rolling methods (

#16738)
pola-rs · Jun 5, 2024 · e75ece9 · e75ece9
1 parent 077fda0
commit e75ece9
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 28 deletions.
diff --git a/py-polars/polars/expr/expr.py b/py-polars/polars/expr/expr.py
@@ -7294,8 +7294,8 @@ def rolling_min(
         self,
         window_size: int | timedelta | str,
         weights: list[float] | None = None,
-        min_periods: int | None = None,
         *,
+        min_periods: int | None = None,
         center: bool = False,
         by: str | None = None,
         closed: ClosedInterval | None = None,
@@ -7525,8 +7525,8 @@ def rolling_max(
         self,
         window_size: int | timedelta | str,
         weights: list[float] | None = None,
-        min_periods: int | None = None,
         *,
+        min_periods: int | None = None,
         center: bool = False,
         by: str | None = None,
         closed: ClosedInterval | None = None,
@@ -7782,8 +7782,8 @@ def rolling_mean(
         self,
         window_size: int | timedelta | str,
         weights: list[float] | None = None,
-        min_periods: int | None = None,
         *,
+        min_periods: int | None = None,
         center: bool = False,
         by: str | None = None,
         closed: ClosedInterval | None = None,
@@ -8041,8 +8041,8 @@ def rolling_sum(
         self,
         window_size: int | timedelta | str,
         weights: list[float] | None = None,
-        min_periods: int | None = None,
         *,
+        min_periods: int | None = None,
         center: bool = False,
         by: str | None = None,
         closed: ClosedInterval | None = None,
@@ -8298,8 +8298,8 @@ def rolling_std(
         self,
         window_size: int | timedelta | str,
         weights: list[float] | None = None,
-        min_periods: int | None = None,
         *,
+        min_periods: int | None = None,
         center: bool = False,
         by: str | None = None,
         closed: ClosedInterval | None = None,
@@ -8556,8 +8556,8 @@ def rolling_var(
         self,
         window_size: int | timedelta | str,
         weights: list[float] | None = None,
-        min_periods: int | None = None,
         *,
+        min_periods: int | None = None,
         center: bool = False,
         by: str | None = None,
         closed: ClosedInterval | None = None,
@@ -8814,8 +8814,8 @@ def rolling_median(
         self,
         window_size: int | timedelta | str,
         weights: list[float] | None = None,
-        min_periods: int | None = None,
         *,
+        min_periods: int | None = None,
         center: bool = False,
         by: str | None = None,
         closed: ClosedInterval | None = None,
@@ -8991,8 +8991,8 @@ def rolling_quantile(
         interpolation: RollingInterpolationMethod = "nearest",
         window_size: int | timedelta | str = 2,
         weights: list[float] | None = None,
-        min_periods: int | None = None,
         *,
+        min_periods: int | None = None,
         center: bool = False,
         by: str | None = None,
         closed: ClosedInterval | None = None,
@@ -9244,8 +9244,8 @@ def rolling_map(
         function: Callable[[Series], Any],
         window_size: int,
         weights: list[float] | None = None,
-        min_periods: int | None = None,
         *,
+        min_periods: int | None = None,
         center: bool = False,
     ) -> Self:
         """
@@ -10882,7 +10882,7 @@ def entropy(self, base: float = math.e, *, normalize: bool = True) -> Self:
 
     @unstable()
     def cumulative_eval(
-        self, expr: Expr, min_periods: int = 1, *, parallel: bool = False
+        self, expr: Expr, *, min_periods: int = 1, parallel: bool = False
     ) -> Self:
         """
         Run an expression over a sliding window that increases `1` slot every iteration.

diff --git a/py-polars/polars/series/series.py b/py-polars/polars/series/series.py
@@ -2748,7 +2748,7 @@ def entropy(self, base: float = math.e, *, normalize: bool = False) -> float | N
 
     @unstable()
     def cumulative_eval(
-        self, expr: Expr, min_periods: int = 1, *, parallel: bool = False
+        self, expr: Expr, *, min_periods: int = 1, parallel: bool = False
     ) -> Series:
         """
         Run an expression over a sliding window that increases `1` slot every iteration.
@@ -5587,8 +5587,8 @@ def rolling_min(
         self,
         window_size: int,
         weights: list[float] | None = None,
-        min_periods: int | None = None,
         *,
+        min_periods: int | None = None,
         center: bool = False,
     ) -> Series:
         """
@@ -5639,7 +5639,7 @@ def rolling_min(
             self.to_frame()
             .select(
                 F.col(self.name).rolling_min(
-                    window_size, weights, min_periods, center=center
+                    window_size, weights, min_periods=min_periods, center=center
                 )
             )
             .to_series()
@@ -5650,8 +5650,8 @@ def rolling_max(
         self,
         window_size: int,
         weights: list[float] | None = None,
-        min_periods: int | None = None,
         *,
+        min_periods: int | None = None,
         center: bool = False,
     ) -> Series:
         """
@@ -5702,7 +5702,7 @@ def rolling_max(
             self.to_frame()
             .select(
                 F.col(self.name).rolling_max(
-                    window_size, weights, min_periods, center=center
+                    window_size, weights, min_periods=min_periods, center=center
                 )
             )
             .to_series()
@@ -5713,8 +5713,8 @@ def rolling_mean(
         self,
         window_size: int,
         weights: list[float] | None = None,
-        min_periods: int | None = None,
         *,
+        min_periods: int | None = None,
         center: bool = False,
     ) -> Series:
         """
@@ -5765,7 +5765,7 @@ def rolling_mean(
             self.to_frame()
             .select(
                 F.col(self.name).rolling_mean(
-                    window_size, weights, min_periods, center=center
+                    window_size, weights, min_periods=min_periods, center=center
                 )
             )
             .to_series()
@@ -5776,8 +5776,8 @@ def rolling_sum(
         self,
         window_size: int,
         weights: list[float] | None = None,
-        min_periods: int | None = None,
         *,
+        min_periods: int | None = None,
         center: bool = False,
     ) -> Series:
         """
@@ -5828,7 +5828,7 @@ def rolling_sum(
             self.to_frame()
             .select(
                 F.col(self.name).rolling_sum(
-                    window_size, weights, min_periods, center=center
+                    window_size, weights, min_periods=min_periods, center=center
                 )
             )
             .to_series()
@@ -5839,8 +5839,8 @@ def rolling_std(
         self,
         window_size: int,
         weights: list[float] | None = None,
-        min_periods: int | None = None,
         *,
+        min_periods: int | None = None,
         center: bool = False,
         ddof: int = 1,
     ) -> Series:
@@ -5895,7 +5895,11 @@ def rolling_std(
             self.to_frame()
             .select(
                 F.col(self.name).rolling_std(
-                    window_size, weights, min_periods, center=center, ddof=ddof
+                    window_size,
+                    weights,
+                    min_periods=min_periods,
+                    center=center,
+                    ddof=ddof,
                 )
             )
             .to_series()
@@ -5906,8 +5910,8 @@ def rolling_var(
         self,
         window_size: int,
         weights: list[float] | None = None,
-        min_periods: int | None = None,
         *,
+        min_periods: int | None = None,
         center: bool = False,
         ddof: int = 1,
     ) -> Series:
@@ -5962,7 +5966,11 @@ def rolling_var(
             self.to_frame()
             .select(
                 F.col(self.name).rolling_var(
-                    window_size, weights, min_periods, center=center, ddof=ddof
+                    window_size,
+                    weights,
+                    min_periods=min_periods,
+                    center=center,
+                    ddof=ddof,
                 )
             )
             .to_series()
@@ -5974,8 +5982,8 @@ def rolling_map(
         function: Callable[[Series], Any],
         window_size: int,
         weights: list[float] | None = None,
-        min_periods: int | None = None,
         *,
+        min_periods: int | None = None,
         center: bool = False,
     ) -> Series:
         """
@@ -6030,8 +6038,8 @@ def rolling_median(
         self,
         window_size: int,
         weights: list[float] | None = None,
-        min_periods: int | None = None,
         *,
+        min_periods: int | None = None,
         center: bool = False,
     ) -> Series:
         """
@@ -6082,7 +6090,7 @@ def rolling_median(
             self.to_frame()
             .select(
                 F.col(self.name).rolling_median(
-                    window_size, weights, min_periods, center=center
+                    window_size, weights, min_periods=min_periods, center=center
                 )
             )
             .to_series()
@@ -6095,8 +6103,8 @@ def rolling_quantile(
         interpolation: RollingInterpolationMethod = "nearest",
         window_size: int = 2,
         weights: list[float] | None = None,
-        min_periods: int | None = None,
         *,
+        min_periods: int | None = None,
         center: bool = False,
     ) -> Series:
         """
@@ -6166,7 +6174,7 @@ def rolling_quantile(
                     interpolation,
                     window_size,
                     weights,
-                    min_periods,
+                    min_periods=min_periods,
                     center=center,
                 )
             )