Don't raise rename warning if it is a no operation (pydata#8266)

* Don't raise rename warning if it is a no operation

* xr.Dataset -> Dataset

* Remove pytest.warns

* Add whatsnew

doc/whats-new.rst

@@ -41,6 +41,9 @@ Deprecations
 
 Bug fixes
 ~~~~~~~~~
+- :py:meth:`DataArray.rename` & :py:meth:`Dataset.rename` would emit a warning
+  when the operation was a no-op. (:issue:`8266`)
+  By `Simon Hansen <https://github.com/hoxbro>`_.
 
 
 Documentation

xarray/core/dataset.py

@@ -4167,6 +4167,9 @@ def _rename(
             create_dim_coord = False
             new_k = name_dict[k]
 
+            if k == new_k:
+                continue  # Same name, nothing to do
+
             if k in self.dims and new_k in self._coord_names:
                 coord_dims = self._variables[name_dict[k]].dims
                 if coord_dims == (k,):

xarray/tests/test_dataarray.py

@@ -1883,6 +1883,16 @@ def test_rename_dimension_coord_warnings(self) -> None:
         ):
             da.rename(x="y")
 
+        # No operation should not raise a warning
+        da = xr.DataArray(
+            data=np.ones((2, 3)),
+            dims=["x", "y"],
+            coords={"x": range(2), "y": range(3), "a": ("x", [3, 4])},
+        )
+        with warnings.catch_warnings():
+            warnings.simplefilter("error")
+            da.rename(x="x")
+
     def test_init_value(self) -> None:
         expected = DataArray(
             np.full((3, 4), 3), dims=["x", "y"], coords=[range(3), range(4)]

xarray/tests/test_dataset.py

@@ -3032,8 +3032,7 @@ def test_rename_old_name(self) -> None:
     def test_rename_same_name(self) -> None:
         data = create_test_data()
         newnames = {"var1": "var1", "dim2": "dim2"}
-        with pytest.warns(UserWarning, match="does not create an index anymore"):
-            renamed = data.rename(newnames)
+        renamed = data.rename(newnames)
         assert_identical(renamed, data)
 
     def test_rename_dims(self) -> None:
@@ -3103,6 +3102,15 @@ def test_rename_dimension_coord_warnings(self) -> None:
         ):
             ds.rename(x="y")
 
+        # No operation should not raise a warning
+        ds = Dataset(
+            data_vars={"data": (("x", "y"), np.ones((2, 3)))},
+            coords={"x": range(2), "y": range(3), "a": ("x", [3, 4])},
+        )
+        with warnings.catch_warnings():
+            warnings.simplefilter("error")
+            ds.rename(x="x")
+
     def test_rename_multiindex(self) -> None:
         midx = pd.MultiIndex.from_tuples([([1, 2]), ([3, 4])], names=["a", "b"])
         midx_coords = Coordinates.from_pandas_multiindex(midx, "x")