Add bool, short and char vectors #14

Author: ivahnenkoAnna

objectbox/c.py

@@ -396,7 +396,10 @@ def c_voidp_as_bytes(voidp, size):
 OBXPropertyType_Relation = 11
 OBXPropertyType_DateNano = 12
 OBXPropertyType_Flex = 13
+OBXPropertyType_BoolVector = 22
 OBXPropertyType_ByteVector = 23
+OBXPropertyType_ShortVector = 24
+OBXPropertyType_CharVector = 25
 OBXPropertyType_IntVector = 26
 OBXPropertyType_LongVector = 27
 OBXPropertyType_FloatVector = 28

objectbox/model/entity.py

@@ -71,7 +71,10 @@ def fill_properties(self):
             if prop._fb_type == flatbuffers.number_types.UOffsetTFlags:
                 assert prop._ob_type in [
                     OBXPropertyType_String,
+                    OBXPropertyType_BoolVector,
                     OBXPropertyType_ByteVector,
+                    OBXPropertyType_ShortVector,
+                    OBXPropertyType_CharVector,
                     OBXPropertyType_IntVector,
                     OBXPropertyType_LongVector,
                     OBXPropertyType_FloatVector,
@@ -117,8 +120,16 @@ def marshal(self, object, id: int) -> bytearray:
             val = self.get_value(object, prop)
             if prop._ob_type == OBXPropertyType_String:
                 offsets[prop._id] = builder.CreateString(val.encode('utf-8'))
+            elif prop._ob_type == OBXPropertyType_BoolVector:
+                # Using a numpy bool as it seems to be more consistent in terms of size. TBD
+                # https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.bool
+                offsets[prop._id] = builder.CreateNumpyVector(np.array(val, dtype=np.bool_))
             elif prop._ob_type == OBXPropertyType_ByteVector:
                 offsets[prop._id] = builder.CreateByteVector(val)
+            elif prop._ob_type == OBXPropertyType_ShortVector:
+                offsets[prop._id] = builder.CreateNumpyVector(np.array(val, dtype=np.int16))
+            elif prop._ob_type == OBXPropertyType_CharVector:
+                offsets[prop._id] = builder.CreateNumpyVector(np.array(val, dtype=np.uint16))
             elif prop._ob_type == OBXPropertyType_IntVector:
                 offsets[prop._id] = builder.CreateNumpyVector(np.array(val, dtype=np.int32))
             elif prop._ob_type == OBXPropertyType_LongVector:
@@ -176,12 +187,18 @@ def unmarshal(self, data: bytes):
                 val = prop._py_type()  # use default (empty) value if not present in the object
             elif prop._ob_type == OBXPropertyType_String:
                 val = table.String(o + table.Pos).decode('utf-8')
+            elif prop._ob_type == OBXPropertyType_BoolVector:
+                val = table.GetVectorAsNumpy(flatbuffers.number_types.BoolFlags, o)
             elif prop._ob_type == OBXPropertyType_ByteVector:
                 # access the FB byte vector information
                 start = table.Vector(o)
                 size = table.VectorLen(o)
                 # slice the vector as a requested type
                 val = prop._py_type(table.Bytes[start:start+size])
+            elif prop._ob_type == OBXPropertyType_ShortVector:
+                val = table.GetVectorAsNumpy(flatbuffers.number_types.Int16Flags, o)
+            elif prop._ob_type == OBXPropertyType_CharVector:
+                val = table.GetVectorAsNumpy(flatbuffers.number_types.Int16Flags, o)
             elif prop._ob_type == OBXPropertyType_Date and prop._py_type == datetime:
                 table_val = table.Get(prop._fb_type, o + table.Pos)
                 val = datetime.fromtimestamp(table_val/1000) if table_val != 0 else datetime.fromtimestamp(0)  # default timestamp

objectbox/model/properties.py

@@ -33,7 +33,10 @@ class PropertyType(IntEnum):
     dateNano = OBXPropertyType_DateNano
     flex = OBXPropertyType_Flex
     # relation = OBXPropertyType_Relation
+    boolVector = OBXPropertyType_BoolVector
     byteVector = OBXPropertyType_ByteVector
+    shortVector = OBXPropertyType_ShortVector
+    charVector = OBXPropertyType_CharVector
     intVector = OBXPropertyType_IntVector
     longVector = OBXPropertyType_LongVector
     floatVector = OBXPropertyType_FloatVector
@@ -55,7 +58,10 @@ class PropertyType(IntEnum):
     PropertyType.dateNano: flatbuffers.number_types.Int64Flags,
     PropertyType.flex: flatbuffers.number_types.UOffsetTFlags,
     # PropertyType.relation: flatbuffers.number_types.Int64Flags,
+    PropertyType.boolVector: flatbuffers.number_types.UOffsetTFlags,
     PropertyType.byteVector: flatbuffers.number_types.UOffsetTFlags,
+    PropertyType.shortVector: flatbuffers.number_types.UOffsetTFlags,
+    PropertyType.charVector: flatbuffers.number_types.UOffsetTFlags,
     PropertyType.intVector: flatbuffers.number_types.UOffsetTFlags,
     PropertyType.longVector: flatbuffers.number_types.UOffsetTFlags,
     PropertyType.floatVector: 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(21, 1021))
+    model.entity(TestEntity, last_property_id=IdUid(27, 1027))
     model.last_entity_id = IdUid(2, 2)
 
     db_name = test_dir if len(name) == 0 else test_dir + "/" + name
@@ -77,11 +77,17 @@ def assert_equal(actual: TestEntity, expected: TestEntity):
     assert_equal_prop(actual.float64, expected.float64, 0)
     assert_equal_prop(actual.float32, expected.float32, 0)
     assert_equal_prop(actual.bytes, expected.bytes, b'')
+    assert_equal_prop_vector(actual.bools, expected.bools, np.array([]))
     assert_equal_prop_vector(actual.ints, expected.ints, np.array([]))
+    assert_equal_prop_vector(actual.shorts, expected.shorts, np.array([]))
+    assert_equal_prop_vector(actual.chars, expected.chars, np.array([]))
     assert_equal_prop_vector(actual.longs, expected.longs, np.array([]))
     assert_equal_prop_vector(actual.floats, expected.floats, np.array([]))
     assert_equal_prop_vector(actual.doubles, expected.doubles, np.array([]))
+    assert_equal_prop_approx(actual.bools_list, expected.bools_list, [])
     assert_equal_prop_approx(actual.ints_list, expected.ints_list, [])
+    assert_equal_prop_approx(actual.shorts_list, expected.shorts_list, [])
+    assert_equal_prop_approx(actual.chars_list, expected.chars_list, [])
     assert_equal_prop_approx(actual.longs_list, expected.longs_list, [])
     assert_equal_prop_approx(actual.floats_list, expected.floats_list, [])
     assert_equal_prop_approx(actual.doubles_list, expected.doubles_list, [])

tests/model.py

@@ -18,18 +18,24 @@ class TestEntity:
     int8 = Property(int, type=PropertyType.byte, id=7, uid=1007)
     float64 = Property(float, type=PropertyType.double, id=8, uid=1008)
     float32 = Property(float, type=PropertyType.float, id=9, uid=1009)
-    bytes = Property(bytes, id=10, uid=1010, index_type=IndexType.hash64)
-    ints = Property(np.ndarray, type=PropertyType.intVector, id=11, uid=1011)
-    longs = Property(np.ndarray, type=PropertyType.longVector, id=12, uid=1012)
-    floats = Property(np.ndarray, type=PropertyType.floatVector, id=13, uid=1013)
-    doubles = Property(np.ndarray, type=PropertyType.doubleVector, id=14, uid=1014)
-    ints_list = Property(list, type=PropertyType.intVector, id=15, uid=1015)
-    longs_list = Property(list, type=PropertyType.longVector, id=16, uid=1016)
-    floats_list = Property(list, type=PropertyType.floatVector, id=17, uid=1017)
-    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)
+    bools = Property(np.ndarray, type=PropertyType.boolVector, id=10, uid=1010)
+    bytes = Property(bytes, id=11, uid=1011)
+    shorts = Property(np.ndarray, type=PropertyType.shortVector, id=12, uid=1012)
+    chars = Property(np.ndarray, type=PropertyType.charVector, id=13, uid=1013)
+    ints = Property(np.ndarray, type=PropertyType.intVector, id=14, uid=1014)
+    longs = Property(np.ndarray, type=PropertyType.longVector, id=15, uid=1015)
+    floats = Property(np.ndarray, type=PropertyType.floatVector, id=16, uid=1016)
+    doubles = Property(np.ndarray, type=PropertyType.doubleVector, id=17, uid=1017)
+    bools_list = Property(list, type=PropertyType.boolVector, id=18, uid=1018)
+    shorts_list = Property(list, type=PropertyType.shortVector, id=19, uid=1019)
+    chars_list = Property(list, type=PropertyType.charVector, id=20, uid=1020)
+    ints_list = Property(list, type=PropertyType.intVector, id=21, uid=1021)
+    longs_list = Property(list, type=PropertyType.longVector, id=22, uid=1022)
+    floats_list = Property(list, type=PropertyType.floatVector, id=23, uid=1023)
+    doubles_list = Property(list, type=PropertyType.doubleVector, id=24, uid=1024)
+    date = Property(int, type=PropertyType.date, id=25, uid=1025)
+    date_nano = Property(int, type=PropertyType.dateNano, id=26, uid=1026)
+    flex = Property(Generic, type=PropertyType.flex, id=27, uid=1027)
     transient = ""  # not "Property" so it's not stored
 
     def __init__(self, string: str = ""):

tests/test_box.py

@@ -39,11 +39,17 @@ def test_box_basics():
     object.float64 = 4.2
     object.float32 = 1.5
     object.bytes = bytes([1, 1, 2, 3, 5])
+    object.bools = np.array([True, False, True, True, False], dtype=np.bool_)
     object.ints = np.array([1, 2, 3, 555, 120, 222], dtype=np.int32)
-    object.longs = np.array([9182, 8273, 7364, 6455, 55462547], dtype=np.int64)
+    object.shorts = np.array([7, 8, 9, 12, 13, 22], dtype=np.int16)
+    object.chars = np.array([311, 426, 852, 927, 1025], dtype=np.uint16)
+    object.longs = np.array([4299185519, 155462547, 5019238156195], dtype=np.int64)
     object.floats = np.array([0.1, 1.2, 2.3, 3.4, 4.5], dtype=np.float32)
     object.doubles = np.array([99.99, 88.88, 77.77, 66.66, 55.595425], dtype=np.float64)
+    object.bools_list = [True, False, True, True, False]
     object.ints_list = [91, 82, 73, 64, 55]
+    object.shorts_list = [8, 2, 7, 3, 6]
+    object.chars_list = [4, 5, 43, 75, 12]
     object.longs_list = [4568, 8714, 1234, 5678, 9012240941]
     object.floats_list = [0.11, 1.22, 2.33, 3.44, 4.5595]
     object.doubles_list = [99.1999, 88.2888, 77.3777, 66.4666, 55.6597555]