Python side API changes (#130)

* change get_cell_value

* fix comment typo

* change signature of get_cell_value and get_cell_value_by_index

* fix typo in get_cell_value_by_index

* add internal _get_cell_value_by_numerical_index function

* change set_cell_value signature

* name changes

* update example notebooks

* removed memoization, improved docstring for get_cell_calue

Author: ibdafna

examples/CellEditing.ipynb

@@ -88,8 +88,7 @@
     "def on_cell_changed(cell):\n",
     "    track_changed_cell(cell)\n",
     "    print(\"Cell at primary key {row} and column '{column}'({column_index}) changed to {value}\".format(\n",
-    "        row=cell['row'], column=cell['column'], column_index=cell['column_index'], value=cell['value']))\n",
-    "    "
+    "        row=cell['row'], column=cell['column'], column_index=cell['column_index'], value=cell['value']))"
    ]
   },
   {
@@ -139,7 +138,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "datagrid.set_cell_value_by_index(1, 3, 16)"
+    "datagrid.set_cell_value_by_index(\"Horsepower\", 3, 169)"
    ]
   },
   {
@@ -198,7 +197,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.6.6"
+   "version": "3.7.6"
   }
  },
  "nbformat": 4,

ipydatagrid/datagrid.py

@@ -86,7 +86,7 @@ def all_values(self):
         it = self.__iter__()
 
         for cell in it:
-            value = self._grid.get_cell_value_by_index(cell['c'], cell['r'])
+            value = self._grid._get_cell_value_by_numerical_index(cell['c'], cell['r'])
             values.append(value)
 
         return values
@@ -331,24 +331,23 @@ def data(self, dataframe):
                       'schema': schema,
                       'fields': [{field['name']:None} for field in schema['fields']]}
 
-    def get_cell_value(self, column, row_index):
-        """Gets the value for a single cell by column name and row index.
+    def get_cell_value(self, column_name, primary_key_value):
+        """Gets the value for a single or multiple cells by column name and index name.
 
-        Tuples should be used to index into multi-index columns.
+           Tuples should be used to index into multi-index columns."""
 
-        Note: The provided row_index should correspond to the row index in the
-        untransformed dataset."""
-
-        return self._data['data'][row_index][column]
+        row_indices = self._get_row_index_of_primary_key(primary_key_value)
+        
+        return [self._data['data'][row][column_name] for row in row_indices]
 
-    def set_cell_value(self, column, primary_key, value):
+    def set_cell_value(self, column_name, primary_key_value, new_value):
         """Sets the value for a single cell by column name and primary key.
 
         Note: This method returns a boolean to indicate if the operation
         was successful.
         """
 
-        row_indices = self._get_row_index_of_primary_key(primary_key)
+        row_indices = self._get_row_index_of_primary_key(primary_key_value)
 
         # Bail early if key could not be found
         if not row_indices:
@@ -358,9 +357,9 @@ def set_cell_value(self, column, primary_key, value):
         else:
             op_success = []
             for row_index in row_indices:
-                if column in self._data['data'][row_index] and row_index is not None:
-                    self._data['data'][row_index][column] = value
-                    self._notify_cell_change(row_index, column, value)
+                if column_name in self._data['data'][row_index] and row_index is not None:
+                    self._data['data'][row_index][column_name] = new_value
+                    self._notify_cell_change(row_index, column_name, new_value)
                     op_success.append(True)
                 else:
                     op_success.append(False)
@@ -369,26 +368,21 @@ def set_cell_value(self, column, primary_key, value):
 
         return False
 
-    def get_cell_value_by_index(self, column_index, row_index):
-        """Gets the value for a single cell by column index and row index."""
+    def get_cell_value_by_index(self, column_name, row_index):
+        """Gets the value for a single cell by column name and row index."""
 
-        column = self._column_index_to_name(column_index)
-        if column is not None:
-            return self._data['data'][row_index][column]
-
-        return None
+        return self._data['data'][row_index][column_name]
 
-    def set_cell_value_by_index(self, column_index, row_index, value):
-        """Sets the value for a single cell by column index and row index.
+    def set_cell_value_by_index(self, column_name, row_index, new_value):
+        """Sets the value for a single cell by column name and row index.
 
         Note: This method returns a boolean to indicate if the operation
         was successful.
         """
 
-        column = self._column_index_to_name(column_index)
-        if column is not None and row_index >= 0 and row_index < len(self._data['data']):
-            self._data['data'][row_index][column] = value
-            self._notify_cell_change(row_index, column, value)
+        if column_name in self._data['data'][row_index] and row_index >= 0 and row_index < len(self._data['data']):
+            self._data['data'][row_index][column_name] = new_value
+            self._notify_cell_change(row_index, column_name, new_value)
             return True
 
         return False
@@ -603,3 +597,12 @@ def _get_row_index_of_primary_key(self, value):
                 row_indices.append(i)
 
         return row_indices
+
+    def _get_cell_value_by_numerical_index(self, column_index, row_index):
+        """Gets the value for a single cell by column index and row index."""
+
+        column = self._column_index_to_name(column_index)
+        if column is not None:
+            return self._data['data'][row_index][column]
+
+        return None