Refactor transform logic to make it column name based

Signed-off-by: martinRenou <[email protected]>
jupyter-widgets · May 30, 2024 · 8901472 · 8901472
1 parent c74797b
commit 8901472
Show file tree

Hide file tree

Showing 27 changed files with 274 additions and 229 deletions.
diff --git a/examples/DataGrid.ipynb b/examples/DataGrid.ipynb
@@ -156,10 +156,10 @@
     "        {\n",
     "            \"type\": \"filter\",\n",
     "            \"operator\": \"=\",\n",
-    "            \"columnIndex\": 7,\n",
+    "            \"column\": \"Origin\",\n",
     "            \"value\": \"Europe\",\n",
     "        },\n",
-    "        {\"type\": \"sort\", \"columnIndex\": 3, \"desc\": True},\n",
+    "        {\"type\": \"sort\", \"column\": \"Horsepower\", \"desc\": True},\n",
     "    ]\n",
     ")"
    ]
@@ -181,9 +181,9 @@
    "source": [
     "datagrid.transform(\n",
     "    [\n",
-    "        {\"type\": \"filter\", \"operator\": \"=\", \"columnIndex\": 7, \"value\": \"USA\"},\n",
-    "        {\"type\": \"filter\", \"operator\": \"<\", \"columnIndex\": 1, \"value\": 13},\n",
-    "        {\"type\": \"sort\", \"columnIndex\": 1},\n",
+    "        {\"type\": \"filter\", \"operator\": \"=\", \"column\": \"Origin\", \"value\": \"USA\"},\n",
+    "        {\"type\": \"filter\", \"operator\": \"<\", \"column\": \"Horsepower\", \"value\": 130},\n",
+    "        {\"type\": \"sort\", \"column\": \"Acceleration\"},\n",
     "    ]\n",
     ")"
    ]
@@ -372,7 +372,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.1"
+   "version": "3.12.3"
   }
  },
  "nbformat": 4,

diff --git a/examples/Nested Hierarchies.ipynb b/examples/Nested Hierarchies.ipynb
@@ -64,11 +64,19 @@
     "\n",
     "nested_grid"
    ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "23f007f4-bcce-4ecd-b68c-aa9b96c82f82",
+   "metadata": {},
+   "outputs": [],
+   "source": []
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -82,7 +90,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.5"
+   "version": "3.12.3"
   }
  },
  "nbformat": 4,

diff --git a/examples/Pandas.ipynb b/examples/Pandas.ipynb
@@ -55,7 +55,7 @@
     "}\n",
     "\n",
     "grid = DataGrid(df, base_row_size=30, base_column_size=300, renderers=renderers)\n",
-    "grid.transform([{\"type\": \"sort\", \"columnIndex\": 2, \"desc\": True}])\n",
+    "grid.transform([{\"type\": \"sort\", \"column\": \"Dates\", \"desc\": True}])\n",
     "grid"
    ]
   },
@@ -69,7 +69,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -83,7 +83,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.6.6"
+   "version": "3.12.3"
   }
  },
  "nbformat": 4,

diff --git a/examples/Trees_paris.ipynb b/examples/Trees_paris.ipynb
@@ -130,28 +130,21 @@
    "source": [
     "datagrid.transform(\n",
     "    [\n",
-    "        {\"type\": \"sort\", \"columnIndex\": 5},\n",
+    "        {\"type\": \"sort\", \"column\": \"Height_m\"},\n",
     "        {\n",
     "            \"type\": \"filter\",\n",
     "            \"operator\": \"=\",\n",
-    "            \"columnIndex\": 4,\n",
-    "            \"value\": \"Platane\",\n",
+    "            \"column\": \"Kind\",\n",
+    "            \"value\": \"Platanus\",\n",
     "        },\n",
     "    ]\n",
     ")"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -165,7 +158,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.6.6"
+   "version": "3.12.3"
   }
  },
  "nbformat": 4,

diff --git a/ipydatagrid/datagrid.py b/ipydatagrid/datagrid.py
@@ -3,6 +3,7 @@
 
 import datetime
 import decimal
+import warnings
 from collections.abc import Iterator
 from copy import deepcopy
 from math import floor
@@ -825,8 +826,22 @@ def _validate_transforms(self, proposal):
         transforms = proposal["value"]
         field_len = len(self._data["schema"]["fields"])
         for transform in transforms:
-            if transform["columnIndex"] > field_len:
-                raise ValueError("Column index is out of bounds.")
+            if "columnIndex" in transform:
+                warnings.warn(
+                    "Applying transforms on columnIndex is deprecated, "
+                    "please provide the column name instead",
+                    DeprecationWarning,
+                    stacklevel=4,
+                )
+
+                if "column" not in transform:
+                    transform["column"] = self._data["schema"]["fields"][
+                        transform["columnIndex"]
+                    ]["name"]
+
+                if transform["columnIndex"] > field_len:
+                    raise ValueError("Column index is out of bounds.")
+
         return transforms
 
     @validate("_data")