update to c-api v0.10.0 + docs/script improvements

Author: Ivan Dlugos

download-c-lib.py

@@ -2,7 +2,10 @@
 import tarfile
 import os
 
-version = "0.6.0"  # see objectbox/c.py required_version
+# Script used to download objectbox-c shared libraries for all supported platforms. Execute by running `make get-lib`
+# on first checkout of this repo and any time after changing the objectbox-c lib version.
+
+version = "0.10.0"  # see objectbox/c.py required_version
 
 conan_repo = "https://dl.bintray.com/objectbox/conan/objectbox/objectbox-c"
 conan_channel = "testing"
@@ -11,7 +14,7 @@
 # see https://github.com/objectbox/objectbox-c/blob/main/download.sh for the hashes
 out_dir = "objectbox/lib"
 file_hashes = {
-    # objectbox.h is common for all types, get it from the linux x86_64 distributable
+    # header file is the same for all platforms, get it from the linux x86_64 distributable
     "objectbox.h": "4db1be536558d833e52e862fd84d64d75c2b3656",
 
     # linux
@@ -53,6 +56,8 @@ def download(rel_path: str):
     archived_file = archive.extractfile(archive_dir + "/" + basename)
     with open(out_path, 'wb') as file:
         file.writelines(archived_file.readlines())
+    archived_file.close()
+    archive.close()
 
 
 # execute the download for each item in the file hashes

objectbox/box.py

@@ -54,7 +54,7 @@ def _put_one(self, obj) -> int:
             id = obx_box_id_for_put(self._c_box, 0)
 
         data = self._entity.marshal(obj, id)
-        obx_box_put(self._c_box, id, bytes(data), len(data), OBXPutMode_PUT)
+        obx_box_put(self._c_box, id, bytes(data), len(data))
 
         if id != object_id:
             self._entity.set_object_id(obj, id)
@@ -82,7 +82,7 @@ def _put_many(self, objects) -> None:
 
         # allocate a C bytes array structure where we will push the object data
         # OBX_bytes_array with .count = len(objects)
-        c_bytes_array_p = obx_bytes_array_create(len(objects))
+        c_bytes_array_p = obx_bytes_array(len(objects))
 
         try:
             # we need to keep the data around until put_many is executed because obx_bytes_array_set doesn't do a copy

objectbox/c.py

@@ -18,8 +18,13 @@
 import platform
 from objectbox.version import Version
 
-# This file contains C-API bindings based on the objectbox.h, linking to the 'objectbox' shared library
-required_version = "0.6.0"  # don't forget to update download-c-lib.py when upgrading to a newer version
+# This file contains C-API bindings based on lib/objectbox.h, linking to the 'objectbox' shared library.
+# The bindings are implementing using ctypes, see https://docs.python.org/dev/library/ctypes.html for introduction.
+
+
+# Version of the library used by the binding. This version is checked at runtime to ensure binary compatibility.
+# Don't forget to update download-c-lib.py when upgrading to a newer version.
+required_version = "0.10.0"
 
 
 def shlib_name(library: str) -> str:
@@ -248,7 +253,7 @@ def c_voidp_as_bytes(voidp, size):
 
 
 # OBX_model* (void);
-obx_model_create = fn('obx_model_create', OBX_model_p, [])
+obx_model = fn('obx_model', OBX_model_p, [])
 
 # obx_err (OBX_model* model, const char* name, obx_schema_id entity_id, obx_uid entity_uid);
 obx_model_entity = fn('obx_model_entity', obx_err, [OBX_model_p, ctypes.c_char_p, obx_schema_id, obx_uid])
@@ -283,10 +288,10 @@ def c_voidp_as_bytes(voidp, size):
 obx_opt_max_db_size_in_kb = fn('obx_opt_max_db_size_in_kb', None, [OBX_store_options_p, ctypes.c_size_t])
 
 # void (OBX_store_options* opt, int file_mode);
-obx_opt_file_mode = fn('obx_opt_file_mode', None, [OBX_store_options_p, ctypes.c_int])
+obx_opt_file_mode = fn('obx_opt_file_mode', None, [OBX_store_options_p, ctypes.c_uint])
 
 # void (OBX_store_options* opt, int max_readers);
-obx_opt_max_readers = fn('obx_opt_max_readers', None, [OBX_store_options_p, ctypes.c_int])
+obx_opt_max_readers = fn('obx_opt_max_readers', None, [OBX_store_options_p, ctypes.c_uint])
 
 # obx_err (OBX_store_options* opt, OBX_model* model);
 obx_opt_model = fn('obx_opt_model', obx_err, [OBX_store_options_p, OBX_model_p])
@@ -332,7 +337,7 @@ def c_voidp_as_bytes(voidp, size):
 obx_box_ids_for_put = fn('obx_box_ids_for_put', obx_err, [OBX_box_p, ctypes.c_uint64, ctypes.POINTER(obx_id)])
 
 # obx_err (OBX_box* box, obx_id id, const void* data, size_t size, OBXPutMode mode);
-obx_box_put = fn('obx_box_put', obx_err, [OBX_box_p, obx_id, ctypes.c_void_p, ctypes.c_size_t, OBXPutMode])
+obx_box_put = fn('obx_box_put', obx_err, [OBX_box_p, obx_id, ctypes.c_void_p, ctypes.c_size_t])
 
 # obx_err (OBX_box* box, const OBX_bytes_array* objects, const obx_id* ids, OBXPutMode mode);
 obx_box_put_many = fn('obx_box_put_many', obx_err, [OBX_box_p, OBX_bytes_array_p, ctypes.POINTER(obx_id), OBXPutMode])
@@ -350,7 +355,7 @@ def c_voidp_as_bytes(voidp, size):
 obx_box_count = fn('obx_box_count', obx_err, [OBX_box_p, ctypes.c_uint64, ctypes.POINTER(ctypes.c_uint64)])
 
 # OBX_bytes_array* (size_t count);
-obx_bytes_array_create = fn('obx_bytes_array_create', OBX_bytes_array_p, [ctypes.c_size_t])
+obx_bytes_array = fn('obx_bytes_array', OBX_bytes_array_p, [ctypes.c_size_t])
 
 # obx_err (OBX_bytes_array* array, size_t index, const void* data, size_t size);
 obx_bytes_array_set = fn('obx_bytes_array_set', obx_err,

objectbox/model/model.py

@@ -31,7 +31,7 @@ def __bool__(self):
 class Model:
     def __init__(self):
         self._entities = list()
-        self._c_model = obx_model_create()
+        self._c_model = obx_model()
         self.last_entity_id = IdUid(0, 0)
         self.last_index_id = IdUid(0, 0)
         self.last_relation_id = IdUid(0, 0)