Add inplace support for rename_axis #16505

hendrikmakait · 2017-05-25T21:14:54Z

closes rename_axis inplace=True #15704
tests added / passed
passes git diff upstream/master --name-only -- '*.py' | flake8 --diff

codecov · 2017-05-26T01:32:55Z

Codecov Report

Merging #16505 into master will increase coverage by <.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master   #16505      +/-   ##
==========================================
+ Coverage   90.43%   90.43%   +<.01%     
==========================================
  Files         161      161              
  Lines       51045    51047       +2     
==========================================
+ Hits        46161    46163       +2     
  Misses       4884     4884

Flag	Coverage Δ
#multiple	`88.27% <100%> (ø)`	⬆️
#single	`40.16% <16.66%> (-0.01%)`	⬇️

Impacted Files	Coverage Δ
pandas/core/generic.py	`92.17% <100%> (ø)`	⬆️

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 e81f3cc...7011067. Read the comment docs.

codecov · 2017-05-26T01:32:58Z

Codecov Report

Merging #16505 into master will decrease coverage by 0.02%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master   #16505      +/-   ##
==========================================
- Coverage   90.95%   90.92%   -0.03%     
==========================================
  Files         161      161              
  Lines       49276    49278       +2     
==========================================
- Hits        44817    44807      -10     
- Misses       4459     4471      +12

Flag	Coverage Δ
#multiple	`88.68% <100%> (-0.03%)`	⬇️
#single	`40.18% <16.66%> (-0.01%)`	⬇️

Impacted Files	Coverage Δ
pandas/core/generic.py	`92.27% <100%> (ø)`	⬆️
pandas/plotting/_converter.py	`63.23% <0%> (-1.82%)`	⬇️

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 344cec7...01eaba1. Read the comment docs.

jreback · 2017-05-26T12:06:30Z

pandas/core/generic.py


        Parameters
        ----------
        name : str or list of str
            Name for the Index, or list of names for the MultiIndex
        axis : int or str
           0 or 'index' for the index; 1 or 'columns' for the columns
+        inplace : bool
+            whether to modify `self` directly or return a copy


versionadded tag

Which version should I specify?

Specified 0.20.2

move to 0.21.0

jreback · 2017-05-26T12:07:20Z

pandas/core/generic.py

@@ -831,9 +833,11 @@ def _set_axis_name(self, name, axis=0):
        axis = self._get_axis_number(axis)
        idx = self._get_axis(axis).set_names(name)

-        renamed = self.copy(deep=True)
+        inplace = validate_bool_kwarg(inplace, 'inplace')
+        renamed = self if inplace else self.copy(deep=True)


deep=True is the default so can remove that

jreback · 2017-06-01T10:28:01Z

pandas/core/generic.py


        Parameters
        ----------
        name : str or list of str
            Name for the Index, or list of names for the MultiIndex
        axis : int or str
           0 or 'index' for the index; 1 or 'columns' for the columns
+        inplace : bool
+            whether to modify `self` directly or return a copy


move to 0.21.0

jreback · 2017-06-01T10:28:26Z

pandas/tests/frame/test_alter_axes.py

@@ -418,6 +418,13 @@ def test_rename(self):
                              pd.Index(['bar', 'foo'], name='name'))
        assert renamed.index.name == renamer.index.name

+    def test_rename_axis(self):
+        renamed = self.frame.rename_axis('foo')


add the issue number as a comment

jreback · 2017-06-01T10:28:45Z

pandas/tests/frame/test_alter_axes.py

@@ -418,6 +418,13 @@ def test_rename(self):
                              pd.Index(['bar', 'foo'], name='name'))
        assert renamed.index.name == renamer.index.name

+    def test_rename_axis(self):


test_rename_axis_inplace

jreback · 2017-06-01T10:29:43Z

pandas/tests/frame/test_alter_axes.py

+        no_return = self.frame.rename_axis('foo', inplace=True)
+        assert no_return is None
+        renamed2 = self.frame
+        assert_frame_equal(renamed, renamed2)


make this read

assert_frame_equal(result, expected) (rename things)

jorisvandenbossche · 2017-06-01T20:40:58Z

pandas/core/generic.py

@@ -831,9 +835,11 @@ def _set_axis_name(self, name, axis=0):
        axis = self._get_axis_number(axis)
        idx = self._get_axis(axis).set_names(name)

-        renamed = self.copy(deep=True)
+        inplace = validate_bool_kwarg(inplace, 'inplace')
+        renamed = self if inplace else self.copy()


Is there a reason you removed the deep=True ?

It's the default and can thus be removed (as of @jreback's request that disappeared after my rebase).
https://github.com/pandas-dev/pandas/blob/master/pandas/core/generic.py#L3523

OK, perfect! (I looked for a comment about it, but didn't find one :-))

jreback

pls add a whatnews note in other enhancements for 0.21.0. ping on green.

jreback · 2017-06-01T22:22:59Z

pandas/tests/frame/test_alter_axes.py

@@ -418,6 +418,14 @@ def test_rename(self):
                              pd.Index(['bar', 'foo'], name='name'))
        assert renamed.index.name == renamer.index.name

+    def test_rename_axis_inplace(self):


can you also add a similar test in series/test_alter_axes.py

and tests this with axis=1 as well.

hendrikmakait · 2017-06-10T17:29:20Z

doc/source/whatsnew/v0.21.0.txt

@@ -33,6 +33,7 @@ Other Enhancements
 - The ``validate`` argument for :func:`merge` function now checks whether a merge is one-to-one, one-to-many, many-to-one, or many-to-many. If a merge is found to not be an example of specified merge type, an exception of type ``MergeError`` will be raised. For more, see :ref:`here <merging.validation>` (:issue:`16270`)
 - ``Series.to_dict()`` and ``DataFrame.to_dict()`` now support an ``into`` keyword which allows you to specify the ``collections.Mapping`` subclass that you would like returned.  The default is ``dict``, which is backwards compatible. (:issue:`16122`)
 - ``RangeIndex.append`` now returns a ``RangeIndex`` object when possible (:issue:`16212`)
+- ``Series.rename_axis()`` and ``DataFrame.rename_axis()`` with ``inplace=True`` now return None while renaming the axis inplace. (:issue:`15704`)


@jreback - added

jreback · 2017-06-13T23:07:59Z

thanks @hndrkmkt

jreback requested changes May 26, 2017

View reviewed changes

hendrikmakait force-pushed the 15704-rename-axis-inplace branch 2 times, most recently from df3520d to dc8e38c Compare June 1, 2017 08:56

jreback added the API Design label Jun 1, 2017

jreback approved these changes Jun 1, 2017

View reviewed changes

hendrikmakait force-pushed the 15704-rename-axis-inplace branch from dc8e38c to 2c51767 Compare June 1, 2017 11:52

jorisvandenbossche reviewed Jun 1, 2017

View reviewed changes

jorisvandenbossche approved these changes Jun 1, 2017

View reviewed changes

jorisvandenbossche added Enhancement and removed API Design labels Jun 1, 2017

jorisvandenbossche added this to the 0.21.0 milestone Jun 1, 2017

jreback requested changes Jun 1, 2017

View reviewed changes

jreback added the Indexing Related to indexing on series/frames, not to indexes themselves label Jun 1, 2017

jreback reviewed Jun 1, 2017

View reviewed changes

hendrikmakait commented Jun 10, 2017

View reviewed changes

hendrikmakait force-pushed the 15704-rename-axis-inplace branch from 6ce4726 to 6da584b Compare June 10, 2017 22:20

hendrikmakait added 2 commits June 13, 2017 23:04

Add inplace support for rename_axis and add tests for happy case

f06f94e

Add whatsnew note and additional tests for rename_axis(inplace=True)

01eaba1

hendrikmakait force-pushed the 15704-rename-axis-inplace branch from 6da584b to 01eaba1 Compare June 13, 2017 21:06

jreback approved these changes Jun 13, 2017

View reviewed changes

jreback merged commit 466e425 into pandas-dev:master Jun 13, 2017

TomAugspurger mentioned this pull request Aug 23, 2017

inplace argument has no effect for rename_axis() #17317

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add inplace support for rename_axis #16505

Add inplace support for rename_axis #16505

hendrikmakait commented May 25, 2017

codecov bot commented May 26, 2017

codecov bot commented May 26, 2017 •

edited

Loading

jreback May 26, 2017

hendrikmakait May 31, 2017

hendrikmakait Jun 1, 2017

jreback Jun 1, 2017

jreback May 26, 2017

jreback Jun 1, 2017

jreback Jun 1, 2017

jreback Jun 1, 2017

jreback Jun 1, 2017

jorisvandenbossche Jun 1, 2017

hendrikmakait Jun 1, 2017

jorisvandenbossche Jun 1, 2017

jreback left a comment

jreback Jun 1, 2017

hendrikmakait Jun 10, 2017

jreback commented Jun 13, 2017

Add inplace support for rename_axis #16505

Add inplace support for rename_axis #16505

Conversation

hendrikmakait commented May 25, 2017

codecov bot commented May 26, 2017

Codecov Report

codecov bot commented May 26, 2017 • 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

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 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback commented Jun 13, 2017

codecov bot commented May 26, 2017 •

edited

Loading