Deprecate center on df.expanding

doc/source/whatsnew/v1.1.0.rst

@@ -820,6 +820,9 @@ Deprecations
   precision through the ``rtol``, and ``atol`` parameters, thus deprecating the
   ``check_less_precise`` parameter. (:issue:`13357`).
 - :func:`DataFrame.melt` accepting a value_name that already exists is deprecated, and will be removed in a future version (:issue:`34731`)
+- the ``center`` keyword in the :meth:`DataFrame.expanding`  function is deprecated and will be removed in a future version (:issue:`20647`)
+
+
 
 .. ---------------------------------------------------------------------------
 

pandas/core/base.py

@@ -5,6 +5,7 @@
 import builtins
 import textwrap
 from typing import Any, Dict, FrozenSet, List, Optional, Union
+import warnings
 
 import numpy as np
 
@@ -581,12 +582,17 @@ def _shallow_copy(self, obj, **kwargs):
         """
         return a new object with the replacement attributes
         """
-        if isinstance(obj, self._constructor):
-            obj = obj.obj
-        for attr in self._attributes:
-            if attr not in kwargs:
-                kwargs[attr] = getattr(self, attr)
-        return self._constructor(obj, **kwargs)
+        with warnings.catch_warnings():
+            warnings.filterwarnings(
+                "ignore",
+                "The `center` argument on `expanding` will be removed in the future",
+            )
+            if isinstance(obj, self._constructor):
+                obj = obj.obj
+            for attr in self._attributes:
+                if attr not in kwargs:
+                    kwargs[attr] = getattr(self, attr)
+            return self._constructor(obj, **kwargs)
 
 
 class IndexOpsMixin:

pandas/core/generic.py

@@ -10501,7 +10501,7 @@ def rolling(
         cls.rolling = rolling
 
         @doc(Expanding)
-        def expanding(self, min_periods=1, center=False, axis=0):
+        def expanding(self, min_periods=1, center=None, axis=0):
             axis = self._get_axis_number(axis)
             return Expanding(self, min_periods=min_periods, center=center, axis=axis)
 

pandas/core/groupby/base.py

@@ -4,6 +4,7 @@
 SeriesGroupBy and the DataFrameGroupBy objects.
 """
 import collections
+import warnings
 
 from pandas.core.dtypes.common import is_list_like, is_scalar
 
@@ -40,8 +41,12 @@ def _gotitem(self, key, ndim, subset=None):
             groupby = self._groupby[key]
         except IndexError:
             groupby = self._groupby
-
-        self = type(self)(subset, groupby=groupby, parent=self, **kwargs)
+        with warnings.catch_warnings():
+            warnings.filterwarnings(
+                "ignore",
+                "The `center` argument on `expanding` will be removed in the future",
+            )
+            self = type(self)(subset, groupby=groupby, parent=self, **kwargs)
         self._reset_cache()
         if subset.ndim == 2:
             if is_scalar(key) and key in subset or is_list_like(key):

pandas/core/window/expanding.py

@@ -1,5 +1,6 @@
 from textwrap import dedent
 from typing import Dict, Optional
+import warnings
 
 from pandas.compat.numpy import function as nv
 from pandas.util._decorators import Appender, Substitution, doc
@@ -57,7 +58,15 @@ class Expanding(_Rolling_and_Expanding):
 
     _attributes = ["min_periods", "center", "axis"]
 
-    def __init__(self, obj, min_periods=1, center=False, axis=0, **kwargs):
+    def __init__(self, obj, min_periods=1, center=None, axis=0, **kwargs):
+        if center is not None:
+            warnings.warn(
+                "The `center` argument on `expanding` will be removed in the future",
+                FutureWarning,
+                stacklevel=3,
+            )
+        else:
+            center = False
         super().__init__(obj=obj, min_periods=min_periods, center=center, axis=axis)
 
     @property
@@ -129,7 +138,12 @@ def aggregate(self, func, *args, **kwargs):
     @Substitution(name="expanding")
     @Appender(_shared_docs["count"])
     def count(self, **kwargs):
-        return super().count(**kwargs)
+        with warnings.catch_warnings():
+            warnings.filterwarnings(
+                "ignore",
+                "The `center` argument on `expanding` will be removed in the future",
+            )
+            return super().count(**kwargs)
 
     @Substitution(name="expanding")
     @Appender(_shared_docs["apply"])

pandas/tests/window/moments/test_moments_consistency_expanding.py

@@ -119,8 +119,8 @@ def test_expanding_corr_pairwise(frame):
     ids=["sum", "mean", "max", "min"],
 )
 def test_expanding_func(func, static_comp, has_min_periods, series, frame, nan_locs):
-    def expanding_func(x, min_periods=1, center=False, axis=0):
-        exp = x.expanding(min_periods=min_periods, center=center, axis=axis)
+    def expanding_func(x, min_periods=1, axis=0):
+        exp = x.expanding(min_periods=min_periods, axis=axis)
         return getattr(exp, func)()
 
     _check_expanding(
@@ -166,7 +166,7 @@ def test_expanding_apply_consistency(
 
     with warnings.catch_warnings():
         warnings.filterwarnings(
-            "ignore", message=".*(empty slice|0 for slice).*", category=RuntimeWarning,
+            "ignore", message=".*(empty slice|0 for slice).*", category=RuntimeWarning
         )
         # test consistency between expanding_xyz() and either (a)
         # expanding_apply of Series.xyz(), or (b) expanding_apply of
@@ -267,7 +267,7 @@ def test_expanding_consistency(consistency_data, min_periods):
     # with empty/0-length Series/DataFrames
     with warnings.catch_warnings():
         warnings.filterwarnings(
-            "ignore", message=".*(empty slice|0 for slice).*", category=RuntimeWarning,
+            "ignore", message=".*(empty slice|0 for slice).*", category=RuntimeWarning
         )
 
         # test consistency between different expanding_* moments
@@ -454,7 +454,7 @@ def test_expanding_cov_pairwise_diff_length():
 def test_expanding_corr_pairwise_diff_length():
     # GH 7512
     df1 = DataFrame(
-        [[1, 2], [3, 2], [3, 4]], columns=["A", "B"], index=Index(range(3), name="bar"),
+        [[1, 2], [3, 2], [3, 4]], columns=["A", "B"], index=Index(range(3), name="bar")
     )
     df1a = DataFrame(
         [[1, 2], [3, 4]], index=Index([0, 2], name="bar"), columns=["A", "B"]

pandas/tests/window/test_api.py

@@ -107,10 +107,7 @@ def test_agg():
 
     with pytest.raises(SpecificationError, match=msg):
         r.aggregate(
-            {
-                "A": {"mean": "mean", "sum": "sum"},
-                "B": {"mean2": "mean", "sum2": "sum"},
-            }
+            {"A": {"mean": "mean", "sum": "sum"}, "B": {"mean2": "mean", "sum2": "sum"}}
         )
 
     result = r.aggregate({"A": ["mean", "std"], "B": ["mean", "std"]})
@@ -191,11 +188,7 @@ def test_count_nonnumeric_types():
         "dt_nat",
         "periods_nat",
     ]
-    dt_nat_col = [
-        Timestamp("20170101"),
-        Timestamp("20170203"),
-        Timestamp(None),
-    ]
+    dt_nat_col = [Timestamp("20170101"), Timestamp("20170203"), Timestamp(None)]
 
     df = DataFrame(
         {

pandas/tests/window/test_expanding.py

@@ -18,24 +18,17 @@ def test_doc_string():
 
 def test_constructor(which):
     # GH 12669
-
     c = which.expanding
 
     # valid
     c(min_periods=1)
-    c(min_periods=1, center=True)
-    c(min_periods=1, center=False)
 
     # not valid
     for w in [2.0, "foo", np.array([2])]:
         msg = "min_periods must be an integer"
         with pytest.raises(ValueError, match=msg):
             c(min_periods=w)
 
-        msg = "center must be a boolean"
-        with pytest.raises(ValueError, match=msg):
-            c(min_periods=1, center=w)
-
 
 @pytest.mark.parametrize("method", ["std", "mean", "sum", "max", "min", "var"])
 def test_numpy_compat(method):
@@ -213,3 +206,16 @@ def test_iter_expanding_series(ser, expected, min_periods):
 
     for (expected, actual) in zip(expected, ser.expanding(min_periods)):
         tm.assert_series_equal(actual, expected)
+
+
+def test_center_deprecate_warning():
+    # GH 20647
+    df = pd.DataFrame()
+    with tm.assert_produces_warning(FutureWarning):
+        df.expanding(center=True)
+
+    with tm.assert_produces_warning(FutureWarning):
+        df.expanding(center=False)
+
+    with tm.assert_produces_warning(None):
+        df.expanding()