Skip to content

COMPAT-18589: Supporting axis in Series.rename #18923

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 14, 2018
Merged

COMPAT-18589: Supporting axis in Series.rename #18923

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a51336d
COMPAT-18589: Supporting axis in Series.rename
AaronCritchley Dec 23, 2017
24edb55
PR Comments
AaronCritchley Dec 23, 2017
da45cf7
Raising when axis is invalid
AaronCritchley Feb 8, 2018
5f5df4e
Merge branch 'master' into COMPAT-18589-rename-axis
AaronCritchley Feb 12, 2018
1794b98
Whatsnew, moving test, assigning axis
AaronCritchley Feb 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -862,6 +862,8 @@ def rename(self, *args, **kwargs):
copy = kwargs.pop('copy', True)
inplace = kwargs.pop('inplace', False)
level = kwargs.pop('level', None)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there is an issue about explicity listing the signatures in pandas/core/series and pandas/core/frame, for rename. would take that in this PR as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, happy to do so, just to clarify, you'd like to me to implement them as specific kwargs rather than **kwargs, and default them to None?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

defaults should be to what they actually default now, these are passed as kwargs to the generic routine, this is mainly to have a nice signature.

# Axis supported for compatibility, detailed in GH-18589
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you don't need this comment

kwargs.pop('axis', None)

if kwargs:
raise TypeError('rename() got an unexpected keyword '
Expand Down
5 changes: 5 additions & 0 deletions pandas/tests/generic/test_series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,3 +227,8 @@ def test_valid_deprecated(self):
# GH18800
with tm.assert_produces_warning(FutureWarning):
pd.Series([]).valid()

def test_axis_supported(self):
# Supporting axis for compatibility, detailed in GH-18589
s = Series(range(5))
s.rename({}, axis=0)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

test with axis > 0, which will raise

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

move to pandas/tests/series/test_alter_axes.py with other rename tests.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved tests, can you clarify on the comment about axis > 0 raising?
I added a test but it doesn't raise, we're popping it and never using it - did you mean that it should raise an error? I can implement if that's intended.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there should a call of
_getaxis_number
somewhere if not that’s an error

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's no call to that here, as we're not using the argument anywhere.
Would you still like me to add this (and test that the addition is working as intended) despite the argument not being used?