From 9575caf3306a4518ad5366014f6c3d0a613d2581 Mon Sep 17 00:00:00 2001 From: Stijn de Gooijer Date: Wed, 2 Aug 2023 15:33:08 +0200 Subject: [PATCH] depr(python): Rename first `qcut` parameter to `quantiles` --- py-polars/polars/expr/expr.py | 16 ++++++++++------ py-polars/polars/series/series.py | 12 +++++++----- 2 files changed, 17 insertions(+), 11 deletions(-) diff --git a/py-polars/polars/expr/expr.py b/py-polars/polars/expr/expr.py index 28eccc96f691..f1f2964de614 100644 --- a/py-polars/polars/expr/expr.py +++ b/py-polars/polars/expr/expr.py @@ -3363,10 +3363,11 @@ def cut( self._pyexpr.cut(breaks, labels, left_closed, include_breaks) ) - @deprecate_renamed_parameter("probs", "q", version="0.18.8") + @deprecate_renamed_parameter("probs", "quantiles", version="0.18.8") + @deprecate_renamed_parameter("q", "quantiles", version="0.18.12") def qcut( self, - q: list[float] | int, + quantiles: list[float] | int, labels: list[str] | None = None, left_closed: bool = False, allow_duplicates: bool = False, @@ -3377,7 +3378,7 @@ def qcut( Parameters ---------- - q + quantiles Either a list of quantile probabilities between 0 and 1 or a positive integer determining the number of evenly spaced probabilities to use. labels @@ -3393,7 +3394,6 @@ def qcut( Include the the right endpoint of the bin each observation falls in. If True, the resulting column will be a Struct. - Examples -------- >>> g = pl.repeat("a", 5, eager=True).append(pl.repeat("b", 5, eager=True)) @@ -3484,9 +3484,13 @@ def qcut( │ b ┆ 9 ┆ {inf,"(4.5, inf]"} │ └─────┴─────┴───────────────────────┘ """ - expr_f = self._pyexpr.qcut_uniform if isinstance(q, int) else self._pyexpr.qcut + expr_f = ( + self._pyexpr.qcut_uniform + if isinstance(quantiles, int) + else self._pyexpr.qcut + ) return self._from_pyexpr( - expr_f(q, labels, left_closed, allow_duplicates, include_breaks) + expr_f(quantiles, labels, left_closed, allow_duplicates, include_breaks) ) def rle(self) -> Self: diff --git a/py-polars/polars/series/series.py b/py-polars/polars/series/series.py index 67c5c6160331..cbbb7a7437fe 100644 --- a/py-polars/polars/series/series.py +++ b/py-polars/polars/series/series.py @@ -1740,10 +1740,10 @@ def cut( return res.struct.rename_fields([break_point_label, category_label]) return res - @deprecate_renamed_parameter("quantiles", "q", version="0.18.8") + @deprecate_renamed_parameter("q", "quantiles", version="0.18.12") def qcut( self, - q: list[float] | int, + quantiles: list[float] | int, *, labels: list[str] | None = None, break_point_label: str = "break_point", @@ -1758,7 +1758,7 @@ def qcut( Parameters ---------- - q + quantiles Either a list of quantile probabilities between 0 and 1 or a positive integer determining the number of evenly spaced probabilities to use. labels @@ -1857,7 +1857,7 @@ def qcut( self.to_frame() .with_columns( F.col(n) - .qcut(q, labels, left_closed, allow_duplicates, True) + .qcut(quantiles, labels, left_closed, allow_duplicates, True) .alias(n + "_bin") ) .unnest(n + "_bin") @@ -1866,7 +1866,9 @@ def qcut( res = ( self.to_frame() .select( - F.col(n).qcut(q, labels, left_closed, allow_duplicates, include_breaks) + F.col(n).qcut( + quantiles, labels, left_closed, allow_duplicates, include_breaks + ) ) .to_series() )