DEPR: rename to _consolidate and create deprecation warning #15501

GuessWhoSamFoo · 2017-02-25T04:51:58Z

closes DEPR: .consolidate() should be non-public #15483
tests added / passed
passes git diff upstream/master | flake8 --diff
whatsnew entry

Test output:

running: pytest --skip-slow --skip-network pandas
============================= test session starts ==============================
platform linux2 -- Python 2.7.13, pytest-3.0.6, py-1.4.32, pluggy-0.4.0
rootdir: /home/sfoo/pandas, inifile: setup.cfg
collected 11882 items / 4 skipped

 10147 passed, 1662 skipped, 77 xfailed, 2084 pytest-warnings in 407.18 seconds

jorisvandenbossche · 2017-02-25T10:51:30Z

@GuessWhoSamFoo We would like to have it the other way around. Have the deprecation warning in consolidate and not in _consolidate (so this last one can be used internally without warning). So you can leave the existing consolidate intact like it is now, apart from renaming it to _consolidate, and then add a new consolidate that has the deprecation warning and just calls _consolidate (not adding a new _consolidate like you did now).
Further, you will also have to replace internal usage in the pandas codebase of consolidate to _consolidate to avoid raising the deprecation warning (that is the reason for the test failures).

GuessWhoSamFoo · 2017-02-26T14:32:11Z

==================================== test session starts =====================================
platform linux2 -- Python 2.7.13, pytest-3.0.6, py-1.4.32, pluggy-0.4.0
rootdir: /home/sfoo/pandas, inifile: setup.cfg
collected 11882 items / 4 skipped 

======= 10147 passed, 1662 skipped, 77 xfailed, 2084 pytest-warnings in 419.22 seconds =======

The original consolidate has been left intact except for a line taken out of the docstring. Then I've changed instances of consolidate to _consolidate (even in tests) but still have the same number of failed tests/warnings. Am I missing something here?

jorisvandenbossche · 2017-02-26T14:55:49Z

pandas/io/pytables.py

@@ -2861,7 +2861,7 @@ def write(self, obj, **kwargs):
        super(BlockManagerFixed, self).write(obj, **kwargs)
        data = obj._data
        if not data.is_consolidated():
-            data = data.consolidate()
+            data = data._consolidate()


Here, data is not a DataFrame, but a BlockManager, so this should be left as consolidate (that's the reason for the test failures)

jreback · 2017-02-26T23:56:54Z

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`)


say Series/DataFrame/Panel.consolidate() it affects everything

say has been deprecated as a public method as

jreback · 2017-02-26T23:57:14Z

pandas/core/generic.py

        """
+        DEPRECATED:


this is not deprecated though.

can you add a doc-string

jreback · 2017-02-26T23:57:30Z

pandas/core/generic.py

@@ -2897,6 +2898,12 @@ def consolidate(self, inplace=False):
            cons_data = self._protect_consolidate(f)
            return self._constructor(cons_data).__finalize__(self)

+    def consolidate(self, inplace=False):
+        # 15483


here is where the DEPRECATED goes (in the doc-string)

jreback · 2017-02-26T23:59:59Z

pandas/tests/frame/test_block_internals.py

@@ -40,17 +40,17 @@ def test_cast_internals(self):

    def test_consolidate(self):


can you add a single test (test_consolidate_deprecation), which uses assert_produces_warning(FutureWarning)

jreback · 2017-02-27T00:00:07Z

pandas/core/generic.py

+    def consolidate(self, inplace=False):
+        # 15483
+        warnings.warn("consolidate is deprecated and will be removed in a "
+                      "future release.", DeprecationWarning)


use FutureWarning

Changed internal references to consolidate and updated tests Updated per review comments

GuessWhoSamFoo · 2017-02-27T23:37:22Z

Squashed the last two commits with the changes from the feedback. Thank you for the guidance!

codecov-io · 2017-02-28T04:16:58Z

Codecov Report

Merging #15501 into master will increase coverage by 0.71%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master   #15501      +/-   ##
==========================================
+ Coverage   90.36%   91.08%   +0.71%     
==========================================
  Files         136      136              
  Lines       49552    49102     -450     
==========================================
- Hits        44780    44725      -55     
+ Misses       4772     4377     -395

Impacted Files	Coverage Δ
pandas/core/groupby.py	`95% <100%> (+0.01%)`	✅
pandas/tseries/resample.py	`94.47% <100%> (ø)`	✅
pandas/core/generic.py	`96.31% <100%> (ø)`	✅
pandas/tools/concat.py	`97.62% <100%> (ø)`	✅
pandas/io/pytables.py	`93.9% <100%> (ø)`	✅
pandas/util/decorators.py	`67.32% <0%> (-1.28%)`	❌
pandas/core/frame.py	`97.73% <0%> (-0.1%)`	❌
pandas/util/print_versions.py	`15.71% <0%> (ø)`	✅
pandas/types/cast.py	`85.65% <0%> (+0.2%)`	✅
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e0647ba...c838da8. Read the comment docs.

jorisvandenbossche · 2017-02-28T10:43:38Z

@GuessWhoSamFoo Thank you!

…ng (pandas-dev#15501)

xref pandas-devgh-15501.

xref gh-15501.

xref pandas-devgh-15501.

jorisvandenbossche reviewed Feb 26, 2017

View reviewed changes

jsexauer mentioned this pull request Feb 26, 2017

DEPR: Clean up list of deprecations from prior versions #6581

Closed

1 task

jreback added the Deprecate Functionality to remove in pandas label Feb 26, 2017

jreback requested changes Feb 27, 2017

View reviewed changes

DEPR: rename to _consolidate and create deprecation warning

4e927e6

Changed internal references to consolidate and updated tests Updated per review comments

GuessWhoSamFoo force-pushed the dep-consolidate branch from ee3ec7a to 4e927e6 Compare February 27, 2017 23:15

typo

c838da8

jorisvandenbossche merged commit 7b84eb6 into pandas-dev:master Feb 28, 2017

GuessWhoSamFoo deleted the dep-consolidate branch March 5, 2017 08:04

AnkurDedania pushed a commit to AnkurDedania/pandas that referenced this pull request Mar 21, 2017

DEPR: rename consolidate to _consolidate and create deprecation warni…

afae797

…ng (pandas-dev#15501)

gfyoung added a commit to forking-repos/pandas that referenced this pull request Oct 27, 2018

CLN: Remove the .consolidate method

2d5c6bb

xref pandas-devgh-15501.

gfyoung mentioned this pull request Oct 27, 2018

CLN: Remove the .consolidate method #23377

Merged

jreback mentioned this pull request Oct 27, 2018

DEPR: deprecations log for removed issues #13777

Closed

jreback pushed a commit that referenced this pull request Oct 28, 2018

CLN: Remove the .consolidate method (#23377)

7d6d9fd

xref gh-15501.

tm9k1 pushed a commit to tm9k1/pandas that referenced this pull request Nov 19, 2018

CLN: Remove the .consolidate method (pandas-dev#23377)

08d734f

xref pandas-devgh-15501.

Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019

CLN: Remove the .consolidate method (pandas-dev#23377)

2a91e0b

xref pandas-devgh-15501.

Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019

CLN: Remove the .consolidate method (pandas-dev#23377)

06a9727

xref pandas-devgh-15501.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DEPR: rename to _consolidate and create deprecation warning #15501

DEPR: rename to _consolidate and create deprecation warning #15501

GuessWhoSamFoo commented Feb 25, 2017

jorisvandenbossche commented Feb 25, 2017

GuessWhoSamFoo commented Feb 26, 2017 •

edited

Loading

jorisvandenbossche Feb 26, 2017 •

edited

Loading

jreback Feb 26, 2017

jreback Feb 26, 2017

jreback Feb 26, 2017

jreback Feb 26, 2017

jreback Feb 27, 2017

GuessWhoSamFoo commented Feb 27, 2017

codecov-io commented Feb 28, 2017 •

edited

Loading

jorisvandenbossche commented Feb 28, 2017

		@@ -40,17 +40,17 @@ def test_cast_internals(self):

		def test_consolidate(self):

DEPR: rename to _consolidate and create deprecation warning #15501

DEPR: rename to _consolidate and create deprecation warning #15501

Conversation

GuessWhoSamFoo commented Feb 25, 2017

jorisvandenbossche commented Feb 25, 2017

GuessWhoSamFoo commented Feb 26, 2017 • edited Loading

jorisvandenbossche Feb 26, 2017 • edited Loading

Choose a reason for hiding this comment

jreback Feb 26, 2017

Choose a reason for hiding this comment

jreback Feb 26, 2017

Choose a reason for hiding this comment

jreback Feb 26, 2017

Choose a reason for hiding this comment

jreback Feb 26, 2017

Choose a reason for hiding this comment

jreback Feb 27, 2017

Choose a reason for hiding this comment

GuessWhoSamFoo commented Feb 27, 2017

codecov-io commented Feb 28, 2017 • edited Loading

Codecov Report

jorisvandenbossche commented Feb 28, 2017

GuessWhoSamFoo commented Feb 26, 2017 •

edited

Loading

jorisvandenbossche Feb 26, 2017 •

edited

Loading

codecov-io commented Feb 28, 2017 •

edited

Loading