API: Deprecate renamae_axis and reindex_axis #17842

TomAugspurger · 2017-10-10T19:49:31Z

Closes #17833

Some notes:

the positional argument for rename_axis is mapper, which isn't really descriptive of what it does now. Oh well
Added a TODO in https://github.com/pandas-dev/pandas/compare/master...TomAugspurger:depr-rename_axis?expand=1#diff-492dc2a862db88ec1f1d80589ce8a7d6R92. That will (presumably) break in the future when we remove reindex_axis. I haven't attempted to understand what's going on there yet. Maybe it'll be easy

Closes pandas-dev#17833

TomAugspurger · 2017-10-10T20:38:01Z

Hmm, looks like I'll have to give Panel.reindex a similar treatment as DataFrame.reindex in #17800

This sets us up to re-use it for Panel reindex

jorisvandenbossche · 2017-10-10T21:42:08Z

Hmm, looks like I'll have to give Panel.reindex a similar treatment as DataFrame.reindex in #17800

I really wouldn't bother with that. Panel is deprecated, and IMO there is no need in making Panel's functions consistent.

TomAugspurger · 2017-10-10T21:48:33Z

I really wouldn't bother with that. Panel is deprecated, and IMO there is no need in making Panel's functions consistent.

I wish I had that option :) It seems to be unavoidable though since some generic methods used reindex_axis on frame / panel. Changing those to reindex(foo, axis=axis) caused failures.

I have it working for Panel. Working on Panel4D now, hopefully not much longer.

TomAugspurger · 2017-10-10T21:49:25Z

We're getting the refactoring of _validate_axis_style_args you and Jeff asked for though ;)

jorisvandenbossche · 2017-10-10T21:50:27Z

Another option is to just make a _reindex_axis for now that has the actual implementation and is not deprecated, and use that where reindex_axis is used now internally, and we can get rid of it once Panel/Panel4D is gone.
Again, personally I wouldn't loose more time on it than necessary :-)

jorisvandenbossche

some doc comments

jorisvandenbossche · 2017-10-10T21:45:45Z

doc/source/whatsnew/v0.21.0.txt

@@ -810,6 +810,8 @@ Deprecations
 - ``.get_value`` and ``.set_value`` on ``Series``, ``DataFrame``, ``Panel``, ``SparseSeries``, and ``SparseDataFrame`` are deprecated in favor of using ``.iat[]`` or ``.at[]`` accessors (:issue:`15269`)
 - Passing a non-existent column in ``.to_excel(..., columns=)`` is deprecated and will raise a ``KeyError`` in the future (:issue:`17295`)
 - ``raise_on_error`` parameter to :func:`Series.where`, :func:`Series.mask`, :func:`DataFrame.where`, :func:`DataFrame.mask` is deprecated, in favor of ``errors=`` (:issue:`14968`)
+- Using :meth:`DataFrame.rename_axis` and :meth:`Series.rename_axis` to alter index or column *labels* is now deprecated in favor of using ``.rename``. ``rename_axis`` may still be used to alter the name of the index or columns (:issue:`17833`).
+- :meth:`~NDFrame.reindex_axis` has been deprecated in favor of :meth:`~NDFrame.reindex`. See :ref`here` <whatsnew_0210.enhancements.rename_reindex_axis> for more (:issue:`17833`).


'NDFrame' is not something that exists in the documentation. You can just use DataFrame (it will not be shown because of the ~, and the docstrings are the same for series/dataframe)

jorisvandenbossche · 2017-10-10T21:47:32Z

pandas/core/computation/align.py

@@ -89,6 +89,7 @@ def _align_core(terms):
        for axis, items in zip(range(ndim), axes):
            ti = terms[i].value

+            # TODO: handle this for when reindex_axis is removed...
            if hasattr(ti, 'reindex_axis'):


and using 'reindex' instead of 'reindex_axis' is not good enough?

jorisvandenbossche · 2017-10-10T21:52:53Z

pandas/core/generic.py

+        the axis *labels* by passing a mapping or scalar. This behavior is
+        deprecated and will be removed in a future version. Use ``rename``
+        instead.
+
        See Also
        --------
        pandas.NDFrame.rename


sidenote: this is useless (does not make a link). Unless you want to start with shared docstring/substitution, I would just explicitly add both for series/frame: pandas.Series.rename, pandas.DataFrame.rename

TomAugspurger · 2017-10-10T22:36:28Z

pandas/core/panel.py

+        axes = self._validate_axis_style_args(
+            labels, 'labels', axes=[items, major_axis, minor_axis],
+            axis=axis, method_name='reindex')
+        if self.ndim >= 4:


I got a bit annoyed with PanelND :) I think this is acceptable until we remove it.

TomAugspurger · 2017-10-10T22:37:31Z

pandas/tests/reshape/test_pivot.py

@@ -116,7 +116,9 @@ def test_pivot_table_dropna_categoricals(self):

        result_false = df.pivot_table(index='B', columns='A', values='C',
                                      dropna=False)
-        expected_columns = Series(['a', 'b', 'c', 'd'], name='A')
+        expected_columns = (


I wanted to flag this change in the tests. AFAICT, this is actually the desired behavior? Looking for issues about this now.

jorisvandenbossche

The support for Panel(nd) makes it much less readable .., but since you already did the hard work, it's ok for me :-)
Added some more comments.

jorisvandenbossche · 2017-10-10T22:42:48Z

pandas/core/generic.py

+            axis = self._get_axis_name(axis)
+            if any(x is not None for x in axes):
+                msg = (
+                    "Can't specify both 'axis' and {aliases}"


add ". " at the end of this string? (point + space)

jorisvandenbossche · 2017-10-10T22:45:25Z

pandas/core/groupby.py

@@ -4580,7 +4580,7 @@ def _get_sorted_data(self):

        # this is sort of wasteful but...
        sorted_axis = data.axes[self.axis].take(self.sort_idx)
-        sorted_data = data.reindex(sorted_axis, axis=self.axis)
+        sorted_data = data.reindex_axis(sorted_axis, axis=self.axis)


This won't cause a deprecation warning in our own code?

data here is a BlockManager (I incorrectly changed this in an earlier commit)

jorisvandenbossche · 2017-10-10T22:45:47Z

pandas/core/generic.py

+
+        elif _all_not_none(arg, *axes):
+            msg = (
+                "Cannot specify all of '{arg_name}', {aliases}"


also missing ". "

jorisvandenbossche · 2017-10-10T22:47:17Z

pandas/core/generic.py

+                    "Can't specify both 'axis' and {aliases}"
+                    "Specify either\n"
+                    "\t.{method_name}({arg_name}, axis=axis), or\n"
+                    "\t.{method_name}(index=index, columns=columns)"  # TODO


does your 'todo' point to the fact that "index=index, columns=columns" is not generic for all NDFrame types ? (like Panels) If that is the case, I personally wouldn't care.

Yep, I'll happily ignore :)

jorisvandenbossche · 2017-10-10T22:49:44Z

pandas/tests/reshape/test_pivot.py

-        expected_columns = Series(['a', 'b', 'c', 'd'], name='A')
+        expected_columns = (
+            Series(['a', 'b', 'c', 'd'], name='A').astype('category')
+        )


how is this change related?

Not sure :) The fact that it's only not a CategoricalIndex when in the columns and dropna=True seems like a bug on master.

# This is on master In [7]: df.pivot_table(index="B", columns="A", values="C", dropna=False).columns Out[7]: Index(['a', 'b', 'c', 'd'], dtype='object', name='A') In [8]: df.pivot_table(index="A", columns="B", values="C", dropna=False).index Out[8]: CategoricalIndex(['a', 'b', 'c', 'd'], categories=['a', 'b', 'c', 'd'], ordered=False, name='A', dtype='category')

I've added a whatsnew.

codecov · 2017-10-11T00:05:54Z

Codecov Report

Merging #17842 into master will decrease coverage by 0.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master   #17842      +/-   ##
==========================================
- Coverage   91.22%   91.21%   -0.02%     
==========================================
  Files         163      163              
  Lines       50014    50033      +19     
==========================================
+ Hits        45627    45637      +10     
- Misses       4387     4396       +9

Flag	Coverage Δ
#multiple	`89.02% <98.38%> (ø)`	⬆️
#single	`40.26% <62.9%> (-0.04%)`	⬇️

Impacted Files	Coverage Δ
pandas/core/panel4d.py	`100% <100%> (ø)`	⬆️
pandas/core/panel.py	`96.96% <100%> (+0.01%)`	⬆️
pandas/core/series.py	`94.99% <100%> (ø)`	⬆️
pandas/plotting/_core.py	`82.45% <100%> (ø)`	⬆️
pandas/core/generic.py	`92.2% <100%> (+0.11%)`	⬆️
pandas/core/sparse/scipy_sparse.py	`97.05% <100%> (ø)`	⬆️
pandas/core/computation/align.py	`97.89% <100%> (-0.05%)`	⬇️
pandas/core/frame.py	`97.75% <100%> (-0.12%)`	⬇️
pandas/io/pytables.py	`92.79% <100%> (ø)`	⬆️
pandas/core/internals.py	`94.38% <100%> (ø)`	⬆️
... and 5 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 727ea20...c780537. Read the comment docs.

codecov · 2017-10-11T00:06:05Z

Codecov Report

Merging #17842 into master will decrease coverage by 0.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master   #17842      +/-   ##
==========================================
- Coverage   91.22%   91.21%   -0.02%     
==========================================
  Files         163      163              
  Lines       50014    50033      +19     
==========================================
+ Hits        45627    45637      +10     
- Misses       4387     4396       +9

Flag	Coverage Δ
#multiple	`89.02% <98.38%> (ø)`	⬆️
#single	`40.26% <62.9%> (-0.04%)`	⬇️

Impacted Files	Coverage Δ
pandas/core/frame.py	`97.75% <100%> (-0.12%)`	⬇️
pandas/io/pytables.py	`92.79% <100%> (ø)`	⬆️
pandas/core/indexing.py	`93% <100%> (ø)`	⬆️
pandas/core/internals.py	`94.38% <100%> (ø)`	⬆️
pandas/core/groupby.py	`91.99% <100%> (ø)`	⬆️
pandas/core/reshape/pivot.py	`96.38% <100%> (ø)`	⬆️
pandas/core/panel4d.py	`100% <100%> (ø)`	⬆️
pandas/core/series.py	`94.99% <100%> (ø)`	⬆️
pandas/core/panel.py	`96.96% <100%> (+0.01%)`	⬆️
pandas/core/computation/align.py	`97.89% <100%> (-0.05%)`	⬇️
... and 5 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 727ea20...c780537. Read the comment docs.

jreback · 2017-10-14T15:53:47Z

https://travis-ci.org/pandas-dev/pandas/jobs/287943551

@TomAugspurger some deprecation warnings still in test_panel I think. can you fix.

* API: Deprecate renamae_axis and reindex_axis Closes pandas-dev#17833 * REF: Refactor axis style validator to generic This sets us up to re-use it for Panel reindex * fixup! API: Deprecate renamae_axis and reindex_axis * fixup! API: Deprecate renamae_axis and reindex_axis * fixup! API: Deprecate renamae_axis and reindex_axis * fixup! API: Deprecate renamae_axis and reindex_axis * Ugh * fixup! API: Deprecate renamae_axis and reindex_axis * Fixup

API: Deprecate renamae_axis and reindex_axis

8c54f26

Closes pandas-dev#17833

TomAugspurger added API Design Deprecate Functionality to remove in pandas labels Oct 10, 2017

TomAugspurger added this to the 0.21.0 milestone Oct 10, 2017

jsexauer mentioned this pull request Oct 10, 2017

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

Closed

1 task

REF: Refactor axis style validator to generic

9776ada

This sets us up to re-use it for Panel reindex

jorisvandenbossche reviewed Oct 10, 2017

View reviewed changes

TomAugspurger added 5 commits October 10, 2017 17:08

fixup! API: Deprecate renamae_axis and reindex_axis

d4baabf

fixup! API: Deprecate renamae_axis and reindex_axis

f40875b

fixup! API: Deprecate renamae_axis and reindex_axis

1d1c269

fixup! API: Deprecate renamae_axis and reindex_axis

9e915f9

Ugh

50499e4

TomAugspurger commented Oct 10, 2017

View reviewed changes

jorisvandenbossche reviewed Oct 10, 2017

View reviewed changes

TomAugspurger added 2 commits October 10, 2017 17:53

fixup! API: Deprecate renamae_axis and reindex_axis

a92f492

Fixup

c780537

jorisvandenbossche approved these changes Oct 11, 2017

View reviewed changes

TomAugspurger merged commit 3544394 into pandas-dev:master Oct 11, 2017

TomAugspurger deleted the depr-rename_axis branch October 11, 2017 15:18

jorisvandenbossche mentioned this pull request Oct 13, 2017

ENH: Harmonize drop and rename API #12392

Closed

jreback mentioned this pull request Jun 29, 2019

DEPR: deprecations log for removed issues #13777

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

API: Deprecate renamae_axis and reindex_axis #17842

API: Deprecate renamae_axis and reindex_axis #17842

TomAugspurger commented Oct 10, 2017

TomAugspurger commented Oct 10, 2017

jorisvandenbossche commented Oct 10, 2017

TomAugspurger commented Oct 10, 2017 •

edited

Loading

TomAugspurger commented Oct 10, 2017

jorisvandenbossche commented Oct 10, 2017

jorisvandenbossche left a comment

jorisvandenbossche Oct 10, 2017

jorisvandenbossche Oct 10, 2017

jorisvandenbossche Oct 10, 2017

TomAugspurger Oct 10, 2017

TomAugspurger Oct 10, 2017

jorisvandenbossche left a comment

jorisvandenbossche Oct 10, 2017

jorisvandenbossche Oct 10, 2017

TomAugspurger Oct 10, 2017

jorisvandenbossche Oct 10, 2017

jorisvandenbossche Oct 10, 2017

TomAugspurger Oct 11, 2017

jorisvandenbossche Oct 10, 2017

TomAugspurger Oct 11, 2017

codecov bot commented Oct 11, 2017

codecov bot commented Oct 11, 2017 •

edited

Loading

jreback commented Oct 14, 2017

API: Deprecate renamae_axis and reindex_axis #17842

API: Deprecate renamae_axis and reindex_axis #17842

Conversation

TomAugspurger commented Oct 10, 2017

TomAugspurger commented Oct 10, 2017

jorisvandenbossche commented Oct 10, 2017

TomAugspurger commented Oct 10, 2017 • edited Loading

TomAugspurger commented Oct 10, 2017

jorisvandenbossche commented Oct 10, 2017

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

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

codecov bot commented Oct 11, 2017

Codecov Report

codecov bot commented Oct 11, 2017 • edited Loading

Codecov Report

jreback commented Oct 14, 2017

TomAugspurger commented Oct 10, 2017 •

edited

Loading

codecov bot commented Oct 11, 2017 •

edited

Loading