DEPR: rename to _consolidate and create deprecation warning

DEPR: rename to _consolidate and create deprecation warning

DEPR: renamed consolidate and created deprecation error

Author: GuessWhoSamFoo

doc/source/whatsnew/v0.20.0.txt

@@ -484,6 +484,7 @@ Deprecations
 - ``DataFrame.astype()`` has deprecated the ``raise_on_error`` parameter in favor of ``errors`` (:issue:`14878`)
 - ``Series.sortlevel`` and ``DataFrame.sortlevel`` have been deprecated in favor of ``Series.sort_index`` and ``DataFrame.sort_index`` (:issue:`15099`)
 - importing ``concat`` from ``pandas.tools.merge`` has been deprecated in favor of imports from the ``pandas`` namespace. This should only affect explict imports (:issue:`15358`)
+- ``DataFrame.consolidate()`` has been deprecated. (:issue:`15483`)
 
 .. _whatsnew_0200.prior_deprecations:
 

pandas/core/generic.py

@@ -2874,11 +2874,20 @@ def f():
 
         self._protect_consolidate(f)
 
+    def _consolidate(self, inplace=False):
+        # 15483
+        warnings.warn("consolidate is deprecated and will be removed in a "
+                      "future release.", DeprecationWarning, stacklevel=2)
+        f = lambda: self._data.consolidate()
+        cons_data = self._protect_consolidate(f)
+        return self._constructor(cons_data).__finalize__(self)
+
     def consolidate(self, inplace=False):
         """
+        DEPRECATED:
+
         Compute NDFrame with "consolidated" internals (data of each dtype
-        grouped together in a single ndarray). Mainly an internal API function,
-        but available here to the savvy user
+        grouped together in a single ndarray).
 
         Parameters
         ----------
@@ -2893,9 +2902,7 @@ def consolidate(self, inplace=False):
         if inplace:
             self._consolidate_inplace()
         else:
-            f = lambda: self._data.consolidate()
-            cons_data = self._protect_consolidate(f)
-            return self._constructor(cons_data).__finalize__(self)
+            return self._consolidate(inplace=False)
 
     @property
     def _is_mixed_type(self):