np

Author: ahmedibrhm

doc/source/whatsnew/v1.5.0.rst

@@ -278,7 +278,7 @@ Other enhancements
 - :meth:`DatetimeIndex.astype` now supports casting timezone-naive indexes to ``datetime64[s]``, ``datetime64[ms]``, and ``datetime64[us]``, and timezone-aware indexes to the corresponding ``datetime64[unit, tzname]`` dtypes (:issue:`47579`)
 - :class:`Series` reducers (e.g. ``min``, ``max``, ``sum``, ``mean``) will now successfully operate when the dtype is numeric and ``numeric_only=True`` is provided; previously this would raise a ``NotImplementedError`` (:issue:`47500`)
 - :meth:`RangeIndex.union` now can return a :class:`RangeIndex` instead of a :class:`Int64Index` if the resulting values are equally spaced (:issue:`47557`, :issue:`43885`)
-- :meth:`DataFrame.compare` now accepts an argument ``suffixes`` to allow the user to specify the suffixes of both left and right DataFrame which are being compared. This is by default ``'self'`` and ``'other'`` (:issue:`44354`)
+- :meth:`DataFrame.compare` now accepts an argument ``result_names`` to allow the user to specify the names of both left and right DataFrame which are being compared. This is by default ``'self'`` and ``'other'`` (:issue:`44354`)
 
 .. ---------------------------------------------------------------------------
 .. _whatsnew_150.notable_bug_fixes:

pandas/core/frame.py

@@ -7776,9 +7776,9 @@ def __rdivmod__(self, other) -> tuple[DataFrame, DataFrame]:
 0    a     c  NaN   NaN
 2  NaN   NaN  3.0   4.0
 
-Assign suffixes
+Assign result_names
 
->>> df.compare(df2, suffixes=("left", "right"))
+>>> df.compare(df2, result_names=("left", "right"))
   col1       col3
   left right left right
 0    a     c  NaN   NaN
@@ -7831,14 +7831,14 @@ def compare(
         align_axis: Axis = 1,
         keep_shape: bool = False,
         keep_equal: bool = False,
-        suffixes: Suffixes = ("self", "other"),
+        result_names: Suffixes = ("self", "other"),
     ) -> DataFrame:
         return super().compare(
             other=other,
             align_axis=align_axis,
             keep_shape=keep_shape,
             keep_equal=keep_equal,
-            suffixes=suffixes,
+            result_names=result_names,
         )
 
     def combine(

pandas/core/generic.py

@@ -8971,7 +8971,7 @@ def compare(
         align_axis: Axis = 1,
         keep_shape: bool_t = False,
         keep_equal: bool_t = False,
-        suffixes: Suffixes = ("self", "other"),
+        result_names: Suffixes = ("self", "other"),
     ):
         from pandas.core.reshape.concat import concat
 
@@ -8996,18 +8996,18 @@ def compare(
             else:
                 self = self[mask]
                 other = other[mask]
-        if not isinstance(suffixes, tuple):
+        if not isinstance(result_names, tuple):
             raise TypeError(
-                f"Passing 'suffixes' as a {type(suffixes)} is not "
-                "supported. Provide 'suffixes' as a tuple instead."
+                f"Passing 'result_names' as a {type(result_names)} is not "
+                "supported. Provide 'result_names' as a tuple instead."
             )
 
         if align_axis in (1, "columns"):  # This is needed for Series
             axis = 1
         else:
             axis = self._get_axis_number(align_axis)
 
-        diff = concat([self, other], axis=axis, keys=suffixes)
+        diff = concat([self, other], axis=axis, keys=result_names)
 
         if axis >= self.ndim:
             # No need to reorganize data if stacking on new axis

pandas/core/series.py

@@ -3237,14 +3237,14 @@ def compare(
         align_axis: Axis = 1,
         keep_shape: bool = False,
         keep_equal: bool = False,
-        suffixes: Suffixes = ("self", "other"),
+        result_names: Suffixes = ("self", "other"),
     ) -> DataFrame | Series:
         return super().compare(
             other=other,
             align_axis=align_axis,
             keep_shape=keep_shape,
             keep_equal=keep_equal,
-            suffixes=suffixes,
+            result_names=result_names,
         )
 
     def combine(self, other, func, fill_value=None) -> Series:

pandas/core/shared_docs.py

@@ -76,7 +76,7 @@
     If true, the result keeps values that are equal.
     Otherwise, equal values are shown as NaNs.
 
-suffixes : tuple, default ('self', 'other')
+result_names : tuple, default ('self', 'other')
     Set the dataframes names in the comparison.
 
     .. versionadded:: 1.5.0

pandas/tests/frame/methods/test_compare.py

@@ -182,7 +182,7 @@ def test_compare_unaligned_objects():
         df1.compare(df2)
 
 
-def test_compare_suffixes():
+def test_compare_result_names():
     # 44354
     df1 = pd.DataFrame(
         {"col1": ["a", "b", "c"], "col2": [1.0, 2.0, np.nan], "col3": [1.0, 2.0, 3.0]},
@@ -194,7 +194,7 @@ def test_compare_suffixes():
             "col3": [1.0, 2.0, np.nan],
         },
     )
-    result = df1.compare(df2, suffixes=("left", "right"))
+    result = df1.compare(df2, result_names=("left", "right"))
     expected = pd.DataFrame(
         {
             ("col1", "left"): {0: "a", 2: np.nan},