depr(api): deprecate Table.relabel in favor of Table.rename

jcrist · Aug 30, 2023 · ea4d559 · ea4d559
1 parent e856438
commit ea4d559
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 5 deletions.
diff --git a/ibis/expr/types/relations.py b/ibis/expr/types/relations.py
@@ -1722,6 +1722,13 @@ def select(
 
     projection = select
 
+    @util.deprecated(
+        as_of="7.0",
+        instead=(
+            "use `Table.rename` instead (if passing a mapping, note the meaning "
+            "of keys and values are swapped in Table.rename)."
+        ),
+    )
     def relabel(
         self,
         substitutions: Mapping[str, str]

diff --git a/ibis/tests/expr/test_table.py b/ibis/tests/expr/test_table.py
@@ -378,22 +378,26 @@ def test_relabel():
     table = api.table({"x": "int32", "y": "string", "z": "double"})
 
     # Using a mapping
-    res = table.relabel({"x": "x_1", "y": "y_1"}).schema()
+    with pytest.warns(FutureWarning, match="Table.rename"):
+        res = table.relabel({"x": "x_1", "y": "y_1"}).schema()
     sol = sch.schema({"x_1": "int32", "y_1": "string", "z": "double"})
     assert_equal(res, sol)
 
     # Using a function
-    res = table.relabel(lambda x: None if x == "z" else f"{x}_1").schema()
+    with pytest.warns(FutureWarning, match="Table.rename"):
+        res = table.relabel(lambda x: None if x == "z" else f"{x}_1").schema()
     assert_equal(res, sol)
 
     # Using a format string
-    res = table.relabel("_{name}_")
-    sol = table.relabel({"x": "_x_", "y": "_y_", "z": "_z_"})
+    with pytest.warns(FutureWarning, match="Table.rename"):
+        res = table.relabel("_{name}_")
+        sol = table.relabel({"x": "_x_", "y": "_y_", "z": "_z_"})
     assert_equal(res, sol)
 
     # Mapping with unknown columns errors
     with pytest.raises(com.IbisTypeError, match="'missing' is not found in table"):
-        table.relabel({"missing": "oops"})
+        with pytest.warns(FutureWarning, match="Table.rename"):
+            table.relabel({"missing": "oops"})
 
 
 def test_rename():