CLN: Deprecate Index.summary (GH18217) #20028

GGordonGordon · 2018-03-07T03:04:48Z

closes Deprecate Index.summary #18217
tests added / passed
passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

jreback · 2018-03-07T12:53:14Z

pandas/core/frame.py

@@ -2185,7 +2185,7 @@ def __getitem__(self, key):
        try:
            if key in self.columns and not is_mi_columns:
                return self._getitem_column(key)
-        except:
+        except Exception:


either leave these (IOW the linter is not actually failing these on CI), or catch a specific exception

I had added Exception here so that they were PEP8 compliant. (no empty except). I can change this back if we're not concerned about these failing the flake8 / PEP8 check.

they r not PEP compliant but we have this particular check turned off ATM because otherwise a large number of these would fail

they need fixing but generally want to catch specific exceptions rather than Exception (if we can help it)

jreback · 2018-03-07T12:54:07Z

pandas/core/indexes/datetimelike.py

@@ -963,6 +963,15 @@ def summary(self, name=None):
        result = result.replace("'", "")
        return result

+    def summary(self, name=None):


you only need to deprecate in base class one (the sub-class is the same)

jreback · 2018-03-07T12:55:00Z

pandas/core/indexes/datetimelike.py

@@ -941,7 +941,7 @@ def where(self, cond, other=None):
        return self._shallow_copy(result,
                                  **self._get_attributes_dict())

-    def summary(self, name=None):
+    def _summary(self, name=None):
        """


can you update the doc-strings here (and in the base class)

@jreback - What specific updates were you referring to? Do the sphinx tags need to be added here?

don't need deprecated in the _summary doc-strings

jreback · 2018-03-07T12:55:34Z

pandas/tests/indexes/timedeltas/test_formats.py

@@ -67,6 +69,11 @@ def test_representation_to_series(self):
                result = repr(pd.Series(idx))
                assert result == expected

+    def test_summary_deprecated(self):


this is not necessary

GGordonGordon · 2018-03-08T01:19:27Z

pandas/tests/indexes/period/test_formats.py

            assert result == expected
+
+    def test_summary_deprecated(self):
+        # GH18217


@jreback - Should this be removed as well since the timedeltas version is being removed and it should be taken care of in the base test case?

jreback · 2018-03-13T23:25:00Z

can you rebase and update according to comments.

Review code changes

codecov · 2018-03-14T05:20:39Z

Codecov Report

Merging #20028 into master will increase coverage by 0.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master   #20028      +/-   ##
==========================================
+ Coverage   91.76%   91.77%   +0.01%     
==========================================
  Files         150      152       +2     
  Lines       49151    49178      +27     
==========================================
+ Hits        45102    45133      +31     
+ Misses       4049     4045       -4

Flag	Coverage Δ
#multiple	`90.16% <100%> (+0.01%)`	⬆️
#single	`41.84% <33.33%> (-0.07%)`	⬇️

Impacted Files	Coverage Δ
pandas/core/frame.py	`97.18% <100%> (ø)`	⬆️
pandas/core/indexes/base.py	`96.67% <100%> (ø)`	⬆️
pandas/core/indexes/datetimelike.py	`96.72% <100%> (ø)`	⬆️
pandas/util/testing.py	`83.74% <0%> (-0.21%)`	⬇️
pandas/core/base.py	`96.77% <0%> (-0.02%)`	⬇️
pandas/core/window.py	`96.29% <0%> (-0.02%)`	⬇️
pandas/core/indexes/category.py	`97.3% <0%> (-0.01%)`	⬇️
pandas/core/series.py	`93.84% <0%> (-0.01%)`	⬇️
pandas/core/indexes/multi.py	`95.05% <0%> (-0.01%)`	⬇️
... and 13 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 3783ccc...ccb33cb. Read the comment docs.

jreback · 2018-03-14T10:57:38Z

pandas/core/indexes/base.py

-    def summary(self, name=None):
+    def _summary(self, name=None):
+        """
+        Return a summarized representation


you don't need a deprecated tag on the _summary methods

jreback · 2018-03-14T10:57:50Z

pandas/core/indexes/base.py

@@ -1404,6 +1409,16 @@ def summary(self, name=None):
            name = type(self).__name__
        return '%s: %s entries%s' % (name, len(self), index_summary)

+    def summary(self, name=None):
+        """
+        Return a summarized representation


can you add a Parameters & Returns section

jreback · 2018-03-14T10:58:17Z

pandas/core/indexes/datetimelike.py

@@ -941,7 +941,7 @@ def where(self, cond, other=None):
        return self._shallow_copy(result,
                                  **self._get_attributes_dict())

-    def summary(self, name=None):
+    def _summary(self, name=None):
        """


don't need deprecated in the _summary doc-strings

Update docstrings

jreback · 2018-03-15T10:39:29Z

minor comment. ping when pushed.

jreback · 2018-03-15T10:38:50Z

pandas/core/indexes/base.py

+        """
+        Return a summarized representation
+        .. deprecated:: 0.23.0
+           No longer supported


you don't need the 'No longer supported'

@jreback - This has been removed per your request. Update has been pushed.

Minor docstring tweaks

jreback · 2018-03-16T10:27:24Z

thanks @GGordonGordon

jreback requested changes Mar 7, 2018

View reviewed changes

jreback added Output-Formatting __repr__ of pandas objects, to_string Deprecate Functionality to remove in pandas labels Mar 7, 2018

GGordonGordon commented Mar 8, 2018

View reviewed changes

GGordonGordon added 2 commits March 13, 2018 21:02

CLN: Deprecate Index.summary (GH18217)

f4c52e4

CLN: Deprecate Index.summary (GH18217)

9be7985

Review code changes

GGordonGordon force-pushed the GH18217_deprecate_index_summary branch from 5a2d31b to 9be7985 Compare March 14, 2018 01:09

jreback requested changes Mar 14, 2018

View reviewed changes

CLN: Deprecate Index.summary (GH18217)

c280bed

Update docstrings

jreback added this to the 0.23.0 milestone Mar 15, 2018

jreback requested changes Mar 15, 2018

View reviewed changes

CLN: Deprecate Index.summary (GH18217)

ccb33cb

Minor docstring tweaks

jorisvandenbossche approved these changes Mar 16, 2018

View reviewed changes

jreback approved these changes Mar 16, 2018

View reviewed changes

jreback merged commit bd70e75 into pandas-dev:master Mar 16, 2018

GGordonGordon deleted the GH18217_deprecate_index_summary branch March 17, 2018 23:52

bcolsen mentioned this pull request Jun 19, 2018

Spyder (Python 3.6) + Pandas 0.23 - Future Warning spyder-ide/spyder#7312

Closed

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CLN: Deprecate Index.summary (GH18217) #20028

CLN: Deprecate Index.summary (GH18217) #20028

GGordonGordon commented Mar 7, 2018 •

edited

Loading

jreback Mar 7, 2018

GGordonGordon Mar 8, 2018

jreback Mar 8, 2018

jreback Mar 7, 2018

jreback Mar 7, 2018

GGordonGordon Mar 8, 2018

jreback Mar 14, 2018

jreback Mar 7, 2018

GGordonGordon Mar 8, 2018

jreback commented Mar 13, 2018

codecov bot commented Mar 14, 2018 •

edited

Loading

jreback Mar 14, 2018

jreback Mar 14, 2018

jreback Mar 14, 2018

jreback commented Mar 15, 2018

jreback Mar 15, 2018

GGordonGordon Mar 15, 2018

jreback commented Mar 16, 2018

CLN: Deprecate Index.summary (GH18217) #20028

CLN: Deprecate Index.summary (GH18217) #20028

Conversation

GGordonGordon commented Mar 7, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback commented Mar 13, 2018

codecov bot commented Mar 14, 2018 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback commented Mar 15, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback commented Mar 16, 2018

GGordonGordon commented Mar 7, 2018 •

edited

Loading

codecov bot commented Mar 14, 2018 •

edited

Loading