CLN: move sort_index to core/generic.py pandas-dev#8283

Author: fangchenli

pandas/core/frame.py

@@ -5466,62 +5466,17 @@ def sort_index(
         C  3
         d  4
         """
-        # TODO: this can be combined with Series.sort_index impl as
-        # almost identical
-
-        inplace = validate_bool_kwarg(inplace, "inplace")
-
-        axis = self._get_axis_number(axis)
-        labels = self._get_axis(axis)
-        labels = ensure_key_mapped(labels, key, levels=level)
-
-        # make sure that the axis is lexsorted to start
-        # if not we need to reconstruct to get the correct indexer
-        labels = labels._sort_levels_monotonic()
-        if level is not None:
-            new_axis, indexer = labels.sortlevel(
-                level, ascending=ascending, sort_remaining=sort_remaining
-            )
-
-        elif isinstance(labels, MultiIndex):
-            from pandas.core.sorting import lexsort_indexer
-
-            indexer = lexsort_indexer(
-                labels._get_codes_for_sorting(),
-                orders=ascending,
-                na_position=na_position,
-            )
-        else:
-            from pandas.core.sorting import nargsort
-
-            # Check monotonic-ness before sort an index
-            # GH11080
-            if (ascending and labels.is_monotonic_increasing) or (
-                not ascending and labels.is_monotonic_decreasing
-            ):
-                if inplace:
-                    return
-                else:
-                    return self.copy()
-
-            indexer = nargsort(
-                labels, kind=kind, ascending=ascending, na_position=na_position
-            )
-
-        baxis = self._get_block_manager_axis(axis)
-        new_data = self._mgr.take(indexer, axis=baxis, verify=False)
-
-        # reconstruct axis if needed
-        new_data.axes[baxis] = new_data.axes[baxis]._sort_levels_monotonic()
-
-        if ignore_index:
-            new_data.axes[1] = ibase.default_index(len(indexer))
-
-        result = self._constructor(new_data)
-        if inplace:
-            return self._update_inplace(result)
-        else:
-            return result.__finalize__(self, method="sort_index")
+        return super().sort_index(
+            axis,
+            level,
+            ascending,
+            inplace,
+            kind,
+            na_position,
+            sort_remaining,
+            ignore_index,
+            key,
+        )
 
     def value_counts(
         self,

pandas/core/generic.py

@@ -40,6 +40,7 @@
     CompressionOptions,
     FilePathOrBuffer,
     FrameOrSeries,
+    IndexKeyFunc,
     JSONSerializable,
     Label,
     Level,
@@ -68,6 +69,7 @@
 from pandas.core.dtypes.common import (
     ensure_int64,
     ensure_object,
+    ensure_platform_int,
     ensure_str,
     is_bool,
     is_bool_dtype,
@@ -96,6 +98,7 @@
 import pandas.core.common as com
 from pandas.core.construction import create_series_with_explicit_dtype
 from pandas.core.flags import Flags
+from pandas.core.indexes import base as ibase
 from pandas.core.indexes.api import Index, MultiIndex, RangeIndex, ensure_index
 from pandas.core.indexes.datetimes import DatetimeIndex
 from pandas.core.indexes.period import Period, PeriodIndex
@@ -104,6 +107,7 @@
 from pandas.core.missing import find_valid_index
 from pandas.core.ops import _align_method_FRAME
 from pandas.core.shared_docs import _shared_docs
+from pandas.core.sorting import ensure_key_mapped
 from pandas.core.window import Expanding, ExponentialMovingWindow, Rolling, Window
 
 from pandas.io.formats import format as fmt
@@ -4418,6 +4422,95 @@ def sort_values(
         """
         raise AbstractMethodError(self)
 
+    def sort_index(
+        self,
+        axis=0,
+        level=None,
+        ascending: bool_t = True,
+        inplace: bool_t = False,
+        kind: str = "quicksort",
+        na_position: str = "last",
+        sort_remaining: bool_t = True,
+        ignore_index: bool_t = False,
+        key: IndexKeyFunc = None,
+    ):
+
+        inplace = validate_bool_kwarg(inplace, "inplace")
+
+        is_dataframe = isinstance(self, ABCDataFrame)
+        if is_dataframe:
+            axis = self._get_axis_number(axis)
+            labels = self._get_axis(axis)
+            labels = ensure_key_mapped(labels, key, levels=level)
+            labels = labels._sort_levels_monotonic()
+            target = labels
+        else:
+            _ = self._get_axis_number(axis)
+            index = ensure_key_mapped(self.index, key, levels=level)
+            target = index
+
+        if level is not None:
+            new_index, indexer = target.sortlevel(
+                level, ascending=ascending, sort_remaining=sort_remaining
+            )
+
+        elif isinstance(target, MultiIndex):
+            from pandas.core.sorting import lexsort_indexer
+
+            if not is_dataframe:
+                target = target._sort_levels_monotonic()
+
+            indexer = lexsort_indexer(
+                target._get_codes_for_sorting(),
+                orders=ascending,
+                na_position=na_position,
+            )
+
+        else:
+            from pandas.core.sorting import nargsort
+
+            # Check monotonic-ness before sort an index
+            # GH11080
+            if (ascending and target.is_monotonic_increasing) or (
+                not ascending and target.is_monotonic_decreasing
+            ):
+                if inplace:
+                    return
+                else:
+                    return self.copy()
+
+            indexer = nargsort(
+                target, kind=kind, ascending=ascending, na_position=na_position
+            )
+
+        if is_dataframe:
+            baxis = self._get_block_manager_axis(axis)
+            new_data = self._mgr.take(indexer, axis=baxis, verify=False)
+
+            # reconstruct axis if needed
+            new_data.axes[baxis] = new_data.axes[baxis]._sort_levels_monotonic()
+
+            if ignore_index:
+                new_data.axes[1] = ibase.default_index(len(indexer))
+
+            result = self._constructor(new_data)
+
+        else:
+            indexer = ensure_platform_int(indexer)
+            new_index = self.index.take(indexer)
+            new_index = new_index._sort_levels_monotonic()
+
+            new_values = self._values.take(indexer)
+            result = self._constructor(new_values, index=new_index)
+
+            if ignore_index:
+                result.index = ibase.default_index(len(result))
+
+        if inplace:
+            return self._update_inplace(result)
+        else:
+            return result.__finalize__(self, method="sort_index")
+
     @doc(
         klass=_shared_doc_kwargs["klass"],
         axes=_shared_doc_kwargs["axes"],

pandas/core/series.py

@@ -3462,59 +3462,17 @@ def sort_index(
         dtype: int64
         """
 
-        # TODO: this can be combined with DataFrame.sort_index impl as
-        # almost identical
-        inplace = validate_bool_kwarg(inplace, "inplace")
-        # Validate the axis parameter
-        self._get_axis_number(axis)
-        index = ensure_key_mapped(self.index, key, levels=level)
-
-        if level is not None:
-            new_index, indexer = index.sortlevel(
-                level, ascending=ascending, sort_remaining=sort_remaining
-            )
-
-        elif isinstance(index, MultiIndex):
-            from pandas.core.sorting import lexsort_indexer
-
-            labels = index._sort_levels_monotonic()
-
-            indexer = lexsort_indexer(
-                labels._get_codes_for_sorting(),
-                orders=ascending,
-                na_position=na_position,
-            )
-        else:
-            from pandas.core.sorting import nargsort
-
-            # Check monotonic-ness before sort an index
-            # GH11080
-            if (ascending and index.is_monotonic_increasing) or (
-                not ascending and index.is_monotonic_decreasing
-            ):
-                if inplace:
-                    return
-                else:
-                    return self.copy()
-
-            indexer = nargsort(
-                index, kind=kind, ascending=ascending, na_position=na_position
-            )
-
-        indexer = ensure_platform_int(indexer)
-        new_index = self.index.take(indexer)
-        new_index = new_index._sort_levels_monotonic()
-
-        new_values = self._values.take(indexer)
-        result = self._constructor(new_values, index=new_index)
-
-        if ignore_index:
-            result.index = ibase.default_index(len(result))
-
-        if inplace:
-            self._update_inplace(result)
-        else:
-            return result.__finalize__(self, method="sort_index")
+        return super().sort_index(
+            axis,
+            level,
+            ascending,
+            inplace,
+            kind,
+            na_position,
+            sort_remaining,
+            ignore_index,
+            key,
+        )
 
     def argsort(self, axis=0, kind="quicksort", order=None) -> "Series":
         """