Box: remove insert, update takes ID from object #64

- Remove Box.insert(): IDs shall not be managed by the user
- Box.update(obj) uses the object's ID; raises ValueError if it has none
- Fix obx_box_remove_many binding missing the box argument
- Tests: check object IDs, failed update does not re-create the object

Author: greenrobot

objectbox/box.py

@@ -118,25 +118,15 @@ def _put_many(self, objects) -> None:
         for k in new.keys():
             self._entity._set_object_id(objects[k], ids[k])
 
-    def insert(self, object_id: int, object_):
-        """Inserts an object with the given ID.
+    def update(self, object_):
+        """Updates the existing object having the same ID as the given object.
 
-        Raises if the ID already exists.
-        """
-        object_.id = object_id
-        data = self._entity._marshal(object_, object_id)
-        obx_box_insert(self._c_box, object_id, bytes(data), len(data))
-        if object_id != self._entity._get_object_id(object_):
-            self._entity._set_object_id(object_, object_id)
-
-    def update(self, object_id: int, object_):
-        """Updates an existing object given by its ID, with the given object.
-
-        Raises if the ID doesn't match any object."""
+        Raises if the object has no ID (i.e. it was never put) or the ID doesn't match any stored object."""
+        object_id = self._entity._get_object_id(object_)
+        if not object_id:
+            raise ValueError("Cannot update an object without an ID; use put() for new objects")
         data = self._entity._marshal(object_, object_id)
         obx_box_update(self._c_box, object_id, bytes(data), len(data))
-        if object_id != self._entity._get_object_id(object_):
-            self._entity._set_object_id(object_, object_id)
 
     def get(self, id: int):
         """Get object by given Id or None if not found."""
@@ -162,11 +152,8 @@ def get_many(self, id_array: List[int]) -> list:
         if not id_array:  # Empty
             return []
 
-        c_ids = (ctypes.c_uint64 * len(id_array))(*id_array)
-
-        c_id_array = OBX_id_array()
-        c_id_array.ids = ctypes.cast(c_ids, ctypes.POINTER(obx_id))
-        c_id_array.count = len(id_array)
+        c_ids = (obx_id * len(id_array))(*id_array)
+        c_id_array = OBX_id_array(ctypes.cast(c_ids, ctypes.POINTER(obx_id)), len(id_array))
 
         with self._store.read_tx():
             c_bytes_array_p = obx_box_get_many(self._c_box, ctypes.byref(c_id_array))

objectbox/c.py

@@ -671,7 +671,7 @@ def c_array_pointer(py_list: Union[List[Any], np.ndarray], c_type):
 obx_box_remove = c_fn_nocheck('obx_box_remove', obx_err, [OBX_box_p, obx_id])
 
 # OBX_C_API obx_err obx_box_remove_many(OBX_box* box, const OBX_id_array* ids, uint64_t* out_count);
-obx_box_remove_many = c_fn_rc('obx_box_remove_many', [OBX_id_array_p, ctypes.POINTER(ctypes.c_uint64)])
+obx_box_remove_many = c_fn_rc('obx_box_remove_many', [OBX_box_p, OBX_id_array_p, ctypes.POINTER(ctypes.c_uint64)])
 
 # OBX_C_API obx_err obx_box_remove_all(OBX_box* box, uint64_t* out_count);
 obx_box_remove_all = c_fn_rc('obx_box_remove_all', [OBX_box_p, ctypes.POINTER(ctypes.c_uint64)])

tests/test_box.py

@@ -298,30 +298,10 @@ def test_contains(test_store):
     assert not box.contains(4)
     assert not box.contains(3248)
 
-    with pytest.raises(IllegalArgumentError, match="Illegal ID value: 0") as e:
+    with pytest.raises(IllegalArgumentError, match="Illegal ID value: 0"):
         box.contains(0)
 
 
-def test_insert(test_store):
-    box = test_store.box(TestEntity)
-
-    box.insert(38, TestEntity(str="Object 38"))
-    box.insert(2, TestEntity(str="Object 2"))
-    box.insert(98, TestEntity(str="Object 98"))
-    assert box.count() == 3
-
-    with pytest.raises(IdAlreadyExistsError, match="Insert failed, given ID already exists: 98") as e:
-        box.insert(98, TestEntity(str="Object 98"))
-
-    assert box.put(TestEntity(str="Object 1")) == 1
-    assert box.count() == 4
-
-    assert box.get(2).str == "Object 2"
-    assert box.put(TestEntity(str="Object 2 (updated)")) == 2
-    assert box.get(2).str == "Object 2 (updated)"
-    assert box.count() == 4
-
-
 def test_update(test_store):
     box = test_store.box(TestEntity)
 
@@ -330,20 +310,23 @@ def test_update(test_store):
     box.put(TestEntity(str="Object 3"))
     assert box.count() == 3
 
-    assert box.get(1).str == "Object 1"
-    assert box.get(2).str == "Object 2"
-    assert box.get(3).str == "Object 3"
-
-    box.update(1, TestEntity(str="Object 1 (updated)"))
-    box.update(2, TestEntity(str="Object 2 (updated)"))
-    box.update(3, TestEntity(str="Object 3 (updated)"))
+    for obj in box.get_all():
+        obj.str += " (updated)"
+        box.update(obj)
 
     assert box.get(1).str == "Object 1 (updated)"
     assert box.get(2).str == "Object 2 (updated)"
     assert box.get(3).str == "Object 3 (updated)"
+    assert box.count() == 3
+
+    with pytest.raises(ValueError, match="without an ID"):
+        box.update(TestEntity(str="New object"))
 
-    with pytest.raises(IdNotFoundError, match="Update failed, given ID doesn't exist: 100") as e:
-        box.update(100, TestEntity(str="Object 100 (updated)"))
+    obj = box.get(1)
+    box.remove(1)
+    with pytest.raises(IdNotFoundError, match="Update failed, given ID doesn't exist: 1"):
+        box.update(obj)
+    assert not box.contains(1)  # Failed update must not re-create the object
 
 
 def test_get_many(test_store):