Merge branch '32-get-remove-should-return-values-instead-of-raising-exceptions-on-not-found' into 'dev'

Resolve "get/remove should return values instead of raising exceptions on not found"

Closes #32

See merge request objectbox/objectbox-python!22

Author: dan-obx

objectbox/box.py

@@ -112,9 +112,12 @@ def get(self, id: int):
         with self._ob.read_tx():
             c_data = ctypes.c_void_p()
             c_size = ctypes.c_size_t()
-            obx_box_get(self._c_box, id, ctypes.byref(
-                c_data), ctypes.byref(c_size))
-
+            code : obx_err = obx_box_get(self._c_box, id, ctypes.byref(
+                    c_data), ctypes.byref(c_size))
+            if code == 404:
+                return None
+            elif code != 0:
+                raise CoreException(code)
             data = c_voidp_as_bytes(c_data, c_size.value)
             return self._entity.unmarshal(data)
 
@@ -143,7 +146,12 @@ def remove(self, id_or_object):
             id = self._entity.get_object_id(id_or_object)
         else:
             id = id_or_object
-        obx_box_remove(self._c_box, id)
+        code : obx_err = obx_box_remove(self._c_box, id)
+        if code == 404:
+            return False
+        elif code != 0:
+            raise CoreException(code)
+        return True
 
     def remove_all(self) -> int:
         count = ctypes.c_uint64()

objectbox/c.py

@@ -292,6 +292,13 @@ def c_fn(name: str, restype: Optional[type], argtypes):
 
     return func
 
+# creates a global function "name" with the given restype & argtypes, calling C function with the same name.
+# no error checking is done on restype as this is defered to higher-level functions.
+def c_fn_nocheck(name: str, restype: type, argtypes):
+    func = C.__getattr__(name)
+    func.argtypes = argtypes
+    func.restype = restype
+    return func
 
 # like c_fn, but for functions returning obx_err
 def c_fn_rc(name: str, argtypes):
@@ -302,7 +309,6 @@ def c_fn_rc(name: str, argtypes):
     func.errcheck = check_obx_err
     return func
 
-
 def c_fn_qb_cond(name: str, argtypes):
     """ Like c_fn, but for functions returning obx_qb_cond (checks obx_qb_cond validity). """
     func = C.__getattr__(name)
@@ -462,7 +468,7 @@ def c_array_pointer(py_list: Union[List[Any], np.ndarray], c_type):
 obx_box = c_fn('obx_box', OBX_box_p, [OBX_store_p, obx_schema_id])
 
 # obx_err (OBX_box* box, obx_id id, const void** data, size_t* size);
-obx_box_get = c_fn_rc('obx_box_get', [
+obx_box_get = c_fn_nocheck('obx_box_get', obx_err, [
     OBX_box_p, obx_id, ctypes.POINTER(ctypes.c_void_p), ctypes.POINTER(ctypes.c_size_t)])
 
 # OBX_bytes_array* (OBX_box* box);
@@ -483,7 +489,7 @@ def c_array_pointer(py_list: Union[List[Any], np.ndarray], c_type):
     OBX_box_p, OBX_bytes_array_p, ctypes.POINTER(obx_id), OBXPutMode])
 
 # obx_err (OBX_box* box, obx_id id);
-obx_box_remove = c_fn_rc('obx_box_remove', [OBX_box_p, obx_id])
+obx_box_remove = c_fn_nocheck('obx_box_remove', obx_err, [OBX_box_p, obx_id])
 
 # obx_err (OBX_box* box, uint64_t* out_count);
 obx_box_remove_all = c_fn_rc('obx_box_remove_all', [

tests/test_box.py

@@ -77,14 +77,17 @@ def test_box_basics():
 
     # remove
     box.remove(object)
-    box.remove(1)
+    
+    # remove should return success  
+    success = box.remove(1)
+    assert success == True
+    success = box.remove(1)
+    assert success == False
 
     # check they're gone
     assert box.count() == 0
-    with pytest.raises(objectbox.NotFoundException):
-        box.get(object.id)
-    with pytest.raises(objectbox.NotFoundException):
-        box.get(1)
+    assert box.get(object.id) == None
+    assert box.get(1) == None
 
     ob.close()
 
@@ -166,14 +169,13 @@ def test_datetime():
     assert pytest.approx(read.date.timestamp()) == object.date.timestamp()
 
     # remove
-    box.remove(object)
+    success = box.remove(object)
+    assert success == True
 
     # check they're gone
     assert box.count() == 0
-    with pytest.raises(objectbox.NotFoundException):
-        box.get(object.id)
-    with pytest.raises(objectbox.NotFoundException):
-        box.get(1)
+    assert box.get(object.id) == None
+    assert box.get(1) == None
 
     ob.close()