Add support for flex types #10

Author: ivahnenkoAnna

objectbox/c.py

@@ -395,6 +395,7 @@ def c_voidp_as_bytes(voidp, size):
 OBXPropertyType_Date = 10
 OBXPropertyType_Relation = 11
 OBXPropertyType_DateNano = 12
+OBXPropertyType_Flex = 13
 OBXPropertyType_ByteVector = 23
 OBXPropertyType_IntVector = 26
 OBXPropertyType_LongVector = 27

objectbox/model/entity.py

@@ -14,6 +14,8 @@
 
 
 import flatbuffers
+import flatbuffers.flexbuffers
+from typing import Generic
 import numpy as np
 from math import floor
 from datetime import datetime
@@ -74,6 +76,7 @@ def fill_properties(self):
                     OBXPropertyType_LongVector,
                     OBXPropertyType_FloatVector,
                     OBXPropertyType_DoubleVector,
+                    OBXPropertyType_Flex,
                 ], "programming error - invalid type OB & FB type combination"
                 self.offset_properties.append(prop)
 
@@ -90,11 +93,13 @@ def get_value(self, object, prop: Property):
         if prop._py_type == np.ndarray:
             if (val == np.array(prop)).all():
                 return np.array([])
-        elif prop._py_type == datetime:
-            if val == prop:
-                return datetime.fromtimestamp(0)
         elif val == prop:
-            return prop._py_type()  # default (empty) value for the given type
+            if prop._py_type == datetime:
+                return datetime.fromtimestamp(0)
+            if prop._py_type == Generic:
+                return {}
+            else:
+                return prop._py_type()  # default (empty) value for the given type
         return val
 
     def get_object_id(self, object) -> int:
@@ -122,6 +127,9 @@ def marshal(self, object, id: int) -> bytearray:
                 offsets[prop._id] = builder.CreateNumpyVector(np.array(val, dtype=np.float32))
             elif prop._ob_type == OBXPropertyType_DoubleVector:
                 offsets[prop._id] = builder.CreateNumpyVector(np.array(val, dtype=np.float64))
+            elif prop._ob_type == OBXPropertyType_Flex:
+                buffer = flatbuffers.flexbuffers.Dumps(val)
+                offsets[prop._id] = builder.CreateByteVector(bytes(buffer))
             else:
                 assert False, "programming error - invalid type OB & FB type combination"
 
@@ -186,6 +194,13 @@ def unmarshal(self, data: bytes):
                 val = table.GetVectorAsNumpy(flatbuffers.number_types.Float32Flags, o)
             elif prop._ob_type == OBXPropertyType_DoubleVector:
                 val = table.GetVectorAsNumpy(flatbuffers.number_types.Float64Flags, o)
+            elif prop._ob_type == OBXPropertyType_Flex:
+                # access the FB byte vector information
+                start = table.Vector(o)
+                size = table.VectorLen(o)
+                # slice the vector as bytes
+                buf = table.Bytes[start:start+size]
+                val = flatbuffers.flexbuffers.Loads(buf)
             else:
                 val = table.Get(prop._fb_type, o + table.Pos)
             if prop._py_type == list:

objectbox/model/properties.py

@@ -31,6 +31,7 @@ class PropertyType(IntEnum):
     string = OBXPropertyType_String
     date = OBXPropertyType_Date
     dateNano = OBXPropertyType_DateNano
+    flex = OBXPropertyType_Flex
     # relation = OBXPropertyType_Relation
     byteVector = OBXPropertyType_ByteVector
     intVector = OBXPropertyType_IntVector
@@ -52,6 +53,7 @@ class PropertyType(IntEnum):
     PropertyType.string: flatbuffers.number_types.UOffsetTFlags,
     PropertyType.date: flatbuffers.number_types.Int64Flags,
     PropertyType.dateNano: flatbuffers.number_types.Int64Flags,
+    PropertyType.flex: flatbuffers.number_types.UOffsetTFlags,
     # PropertyType.relation: flatbuffers.number_types.Int64Flags,
     PropertyType.byteVector: flatbuffers.number_types.UOffsetTFlags,
     PropertyType.intVector: flatbuffers.number_types.UOffsetTFlags,

tests/common.py

@@ -24,7 +24,7 @@ def autocleanup():
 def load_empty_test_objectbox(name: str = "") -> objectbox.ObjectBox:
     model = objectbox.Model()
     from objectbox.model import IdUid
-    model.entity(TestEntity, last_property_id=IdUid(20, 1020))
+    model.entity(TestEntity, last_property_id=IdUid(21, 1021))
     model.last_entity_id = IdUid(2, 2)
 
     db_name = test_dir if len(name) == 0 else test_dir + "/" + name
@@ -75,4 +75,13 @@ def assert_equal(actual: TestEntity, expected: TestEntity):
     assert_equal_prop_approx(actual.floats_list, expected.floats_list, [])
     assert_equal_prop_approx(actual.doubles_list, expected.doubles_list, [])
     assert_equal_prop_approx(actual.date, expected.date, 0)
-    assert_equal_prop(actual.date_nano, expected.date_nano, 0)
+    assert_equal_prop(actual.date_nano, expected.date_nano, 0)
+    assert_equal_prop(actual.flex, expected.flex, {})
+
+
+def put_flex(object, box, property):
+    object.flex = property
+    id = box.put(object)
+    assert id == object.id
+    read = box.get(object.id)
+    assert read.flex == object.flex

tests/model.py

@@ -1,6 +1,7 @@
 from objectbox.model import *
 import numpy as np
 from datetime import datetime
+from typing import Generic
 
 
 @Entity(id=1, uid=1)
@@ -25,6 +26,7 @@ class TestEntity:
     doubles_list = Property(list, type=PropertyType.doubleVector, id=18, uid=1018)
     date = Property(int, type=PropertyType.date, id=19, uid=1019)
     date_nano = Property(int, type=PropertyType.dateNano, id=20, uid=1020)
+    flex = Property(Generic, type=PropertyType.flex, id=21, uid=1021)
     transient = ""  # not "Property" so it's not stored
 
     def __init__(self, string: str = ""):

tests/test_box.py

@@ -6,6 +6,7 @@
     load_empty_test_objectbox,
     load_empty_test_datetime,
     assert_equal,
+    put_flex,
 )
 import numpy as np
 from datetime import datetime
@@ -48,6 +49,7 @@ def test_box_basics():
     object.doubles_list = [99.1999, 88.2888, 77.3777, 66.4666, 55.6597555]
     object.date = time.time() * 1000  # milliseconds since UNIX epoch
     object.date_nano = time.time_ns()  # nanoseconds since UNIX epoch
+    object.flex = dict(a=1, b=2, c=3)
     object.transient = "abcd"
 
     id = box.put(object)
@@ -174,3 +176,35 @@ def test_datetime():
         box.get(1)
 
     ob.close()
+
+
+def test_flex():
+    ob = load_empty_test_objectbox()
+    box = objectbox.Box(ob, TestEntity)
+    object = TestEntity()
+
+    # Put a None type first
+    put_flex(object, box, None)
+
+    # Update to int
+    put_flex(object, box, 1)
+
+    # Update to float
+    put_flex(object, box, 1.2)
+
+    # Update to string
+    put_flex(object, box, "foo")
+
+    # Update to int list
+    put_flex(object, box, [1, 2, 3])
+
+    # Update to float list
+    put_flex(object, box, [1.1, 2.2, 3.3])
+
+    # Update to dict
+    put_flex(object, box, {"a": 1, "b": 2})
+    
+    # Update to bool
+    put_flex(object, box, True)
+
+    ob.close()