process entity properties in the model

Author: Ivan Dlugos

objectbox/c.py

@@ -10,6 +10,13 @@
 obx_id = ctypes.c_uint64
 obx_qb_cond = ctypes.c_int
 
+# enums
+OBXPropertyType = ctypes.c_int
+OBXPropertyFlags = ctypes.c_int
+OBXDebugFlags = ctypes.c_int
+OBXPutMode = ctypes.c_int
+OBXOrderFlags = ctypes.c_int
+
 
 class OBX_model(ctypes.Structure):
     pass
@@ -102,22 +109,109 @@ class OBX_query(ctypes.Structure):
 OBX_query_p = ctypes.POINTER(OBX_query)
 
 
+class CError(Exception):
+    def __init__(self, code):
+        self.code = code
+        self.message = ctypes.c_char_p(C.obx_last_error_message()).value.decode("utf8")
+        super(CError, self).__init__(self.message)
+
+
+# check obx_err and raise an error
+def errcheck(code: obx_err, func, args):
+    if code != 0:
+        raise CError(code)
+
+
 # creates a global function "name" with the given restype & argtypes, calling C function with the same name
 def fn(name: str, restype: type, argtypes):
     func = C.__getattr__(name)
 
     if restype == obx_err:
-        # TODO func.errcheck
-        pass
+        func.errcheck = errcheck
     else:
         func.restype = restype
 
     func.argtypes = argtypes
     return func
 
 
-# OBX_model* obx_model_create(void);
+def c_str(string: str) -> ctypes.c_char_p:
+    return string.encode('utf-8')
+
+
+# OBX_model* (void);
 obx_model_create = fn('obx_model_create', OBX_model_p, [])
 
-# obx_err obx_model_entity(OBX_model* model, const char* name, obx_schema_id entity_id, obx_uid entity_uid);
+# 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])
+
+# obx_err (OBX_model* model, const char* name, OBXPropertyType type, obx_schema_id property_id, obx_uid property_uid);
+obx_model_property = fn('obx_model_property', obx_err,
+                        [OBX_model_p, ctypes.c_char_p, OBXPropertyType, obx_schema_id, obx_uid])
+
+OBXPropertyType_Bool = 1
+OBXPropertyType_Byte = 2
+OBXPropertyType_Short = 3
+OBXPropertyType_Char = 4
+OBXPropertyType_Int = 5
+OBXPropertyType_Long = 6
+OBXPropertyType_Float = 7
+OBXPropertyType_Double = 8
+OBXPropertyType_String = 9
+OBXPropertyType_Date = 10
+OBXPropertyType_Relation = 11
+OBXPropertyType_ByteVector = 23
+OBXPropertyType_StringVector = 30
+
+OBXPropertyFlags_ID = 1
+OBXPropertyFlags_NON_PRIMITIVE_TYPE = 2
+OBXPropertyFlags_NOT_NULL = 4
+OBXPropertyFlags_INDEXED = 8
+OBXPropertyFlags_RESERVED = 16
+OBXPropertyFlags_UNIQUE = 32
+OBXPropertyFlags_ID_MONOTONIC_SEQUENCE = 64
+OBXPropertyFlags_ID_SELF_ASSIGNABLE = 128
+OBXPropertyFlags_INDEX_PARTIAL_SKIP_NULL = 256
+OBXPropertyFlags_INDEX_PARTIAL_SKIP_ZERO = 512
+OBXPropertyFlags_VIRTUAL = 1024
+OBXPropertyFlags_INDEX_HASH = 2048
+OBXPropertyFlags_INDEX_HASH64 = 4096
+OBXPropertyFlags_UNSIGNED = 8192
+
+OBXDebugFlags_LOG_TRANSACTIONS_READ = 1,
+OBXDebugFlags_LOG_TRANSACTIONS_WRITE = 2,
+OBXDebugFlags_LOG_QUERIES = 4,
+OBXDebugFlags_LOG_QUERY_PARAMETERS = 8,
+OBXDebugFlags_LOG_ASYNC_QUEUE = 16,
+
+
+# Standard put ("insert or update")
+OBXPutMode_PUT = 1,
+
+# Put succeeds only if the entity does not exist yet.
+OBXPutMode_INSERT = 2,
+
+# Put succeeds only if the entity already exist.
+OBXPutMode_UPDATE = 3,
+
+# The given ID (non-zero) is guaranteed to be new; don't use unless you know exactly what you are doing!
+# This is primarily used internally. Wrong usage leads to inconsistent data (e.g. index data not updated)!
+OBXPutMode_PUT_ID_GUARANTEED_TO_BE_NEW = 4
+
+
+# Reverts the order from ascending (default) to descending.
+OBXOrderFlags_DESCENDING = 1,
+
+# Makes upper case letters (e.g. "Z") be sorted before lower case letters (e.g. "a").
+# If not specified, the default is case insensitive for ASCII characters.
+OBXOrderFlags_CASE_SENSITIVE = 2,
+
+# For scalars only: changes the comparison to unsigned (default is signed).
+OBXOrderFlags_UNSIGNED = 4,
+
+# null values will be put last.
+# If not specified, by default null values will be put first.
+OBXOrderFlags_NULLS_LAST = 8,
+
+# null values should be treated equal to zero (scalars only).
+OBXOrderFlags_NULLS_ZERO = 16,

objectbox/model/entity.py

@@ -1,21 +1,40 @@
+from typing import List, Dict
+
+from objectbox.model.properties import Property
+
+
 # entity decorator
 class _Entity(object):
     def __init__(self, cls, id: int, uid: int):
-        self.cls = cls
-        self.name: str = cls.__name__
-        self.id = id
-        self.uid = uid
-
         # currently, ID and UID are mandatory and are not fetched from the model.json
         if id <= 0:
             raise ValueError("invalid or no 'id; given in the @Entity annotation")
 
         if uid <= 0:
             raise ValueError("invalid or no 'uid' given in the @Entity annotation")
 
+        self.cls = cls
+        self.name: str = cls.__name__
+        self.id = id
+        self.uid = uid
+
+        self.properties: List[Property] = list()
+        self.fillProperties()
+
     def __call__(self):
         return self.cls()
 
+    def fillProperties(self):
+        # TODO allow subclassing and support entities with __slots__ defined
+        variables = dict(vars(self.cls))
+
+        # filter only subclasses of Property
+        variables = {k: v for k, v in variables.items() if issubclass(type(v), Property)}
+
+        for k, v in variables.items():
+            v.__name = k
+            self.properties.append(v)
+
 
 # wrap _Entity to allow @Entity(id=, uid=), i.e. no class argument
 def Entity(cls=None, id: int = 0, uid: int = 0):

objectbox/model/model.py

@@ -31,6 +31,7 @@ def entity(self, entity: _Entity):
             raise ValueError("Given type is not an Entity. Are you passing an instance instead of a type or did you "
                              "forget the '@Entity' annotation?")
 
-        obx_model_entity(self.__model, entity.name.encode('utf-8'), entity.id, entity.uid)
+        obx_model_entity(self.__model, c_str(entity.name), entity.id, entity.uid)
 
-        self.__entities.append(entity)
+        for v in entity.properties:
+            obx_model_property(self.__model, c_str(v._Property__name), v._Property__ob_type, v._Property__id, v._Property__uid)

objectbox/model/properties.py

@@ -1,12 +1,43 @@
-class Property:
-    __is_id: bool
-    __py_type: type
+from objectbox.c import *
+import flatbuffers.number_types
+
 
-    def __init__(self, py_type: type):
+# base property
+class Property:
+    def __init__(self, py_type: type, id: int, uid: int):
         self.__is_id = isinstance(self, Id)
         self.__py_type = py_type
+        self.__id = id
+        self.__uid = uid
+        self.__name: str = ""  # set when in Entity.fillProperties()
+
+        self.__ob_type: OBXPropertyType
+        self.__fb_type: object  # flatbuffers.number_types
+        self._set_basic_type()
+
+    def _set_basic_type(self) -> OBXPropertyType:
+        ts = self.__py_type
+        if ts == str:
+            self.__ob_type = OBXPropertyType_String
+            self.__fb_type = flatbuffers.number_types.UOffsetTFlags
+        elif ts == int:
+            self.__ob_type = OBXPropertyType_Long
+            self.__fb_type = flatbuffers.number_types.Int64Flags
+        # TODO support
+        # elif ts == bytes or ts == bytearray:
+        #     self.__ob_type = OBXPropertyType_ByteVector
+        #     self.__fb_type = flatbuffers.number_types.UOffsetTFlags
+        elif ts == float:
+            self.__ob_type = OBXPropertyType_Double
+            self.__fb_type = flatbuffers.number_types.Float64Flags
+        elif ts == bool:
+            self.__ob_type = OBXPropertyType_Bool
+            self.__fb_type = flatbuffers.number_types.BoolFlags
+        else:
+            raise TypeError("unknown property type %s" % ts)
 
 
+# ID property (primary key)
 class Id(Property):
-    def __init__(self, py_type: type = int):
-        super(Id, self).__init__(py_type)
+    def __init__(self, py_type: type = int, id: int = 0, uid: int = 0):
+        super(Id, self).__init__(py_type, id, uid)

tests/model.py

@@ -3,4 +3,4 @@
 
 @Entity(id=1, uid=1)
 class TestEntity:
-    id = Id()
+    id = Id(id=1, uid=1001)