CLN: Centralised _check_percentile

pandas/core/algorithms.py

@@ -3,7 +3,7 @@
 intended for public consumption
 """
 from textwrap import dedent
-from typing import Dict
+from typing import Dict, Iterable, Union
 from warnings import catch_warnings, simplefilter, warn
 
 import numpy as np
@@ -1102,6 +1102,37 @@ def _get_score(at):
         return result
 
 
+def check_percentile(q: Union[float, Iterable[float]]) -> np.ndarray:
+    """
+    Validate percentiles (used by describe and quantile).
+
+    This function checks if the given float oriterable of floats is a valid percentile otherwise raises a ValueError.
+
+    Args
+    ----
+    q: float or iterable of floats
+        A single percentile or an iterable of percentiles.
+
+    Returns
+    -------
+    ndarray
+        An ndarray of the percentiles if valid.
+
+    Raises
+    ------
+    ValueError if percentiles are not in given interval([0, 1]).
+    """
+    msg = "percentiles should all be in the interval [0, 1]. " "Try {0} instead."
+    q_arr = np.asarray(q)
+    if q_arr.ndim == 0:
+        if not 0 <= q_arr <= 1:
+            raise ValueError(msg.format(q_arr / 100.0))
+    else:
+        if not all(0 <= qs <= 1 for qs in q_arr):
+            raise ValueError(msg.format(q_arr / 100.0))
+    return q_arr
+
+
 # --------------- #
 # select n        #
 # --------------- #

pandas/core/frame.py

@@ -8225,7 +8225,7 @@ def quantile(self, q=0.5, axis=0, numeric_only=True, interpolation="linear"):
         C        1 days 12:00:00
         Name: 0.5, dtype: object
         """
-        self._check_percentile(q)
+        algorithms.check_percentile(q)
 
         data = self._get_numeric_data() if numeric_only else self
         axis = self._get_axis_number(axis)

pandas/core/generic.py

@@ -10169,7 +10169,7 @@ def describe(self, percentiles=None, include=None, exclude=None):
             percentiles = list(percentiles)
 
             # get them all to be in [0, 1]
-            self._check_percentile(percentiles)
+            algos.check_percentile(percentiles)
 
             # median should always be included
             if 0.5 not in percentiles:
@@ -10273,21 +10273,6 @@ def describe_1d(data):
         d.columns = data.columns.copy()
         return d
 
-    def _check_percentile(self, q):
-        """
-        Validate percentiles (used by describe and quantile).
-        """
-
-        msg = "percentiles should all be in the interval [0, 1]. Try {0} instead."
-        q = np.asarray(q)
-        if q.ndim == 0:
-            if not 0 <= q <= 1:
-                raise ValueError(msg.format(q / 100.0))
-        else:
-            if not all(0 <= qs <= 1 for qs in q):
-                raise ValueError(msg.format(q / 100.0))
-        return q
-
     _shared_docs[
         "pct_change"
     ] = """

pandas/core/series.py

@@ -2353,7 +2353,7 @@ def quantile(self, q=0.5, interpolation="linear"):
         dtype: float64
         """
 
-        self._check_percentile(q)
+        algorithms.check_percentile(q)
 
         # We dispatch to DataFrame so that core.internals only has to worry
         #  about 2D cases.