Add support for Date and DateNano types #6

Author: ivahnenkoAnna

example/__main__.py

@@ -1,17 +1,16 @@
 from cmd import Cmd
 import objectbox
-import datetime
+import time
 from example.model import *
 
 
 # objectbox expects date timestamp in milliseconds since UNIX epoch
 def now_ms() -> int:
-    seconds: float = datetime.datetime.utcnow().timestamp()
-    return round(seconds * 1000)
+    return time.time_ns() / 1000000
 
 
 def format_date(timestamp_ms: int) -> str:
-    return "" if timestamp_ms == 0 else str(datetime.datetime.fromtimestamp(timestamp_ms / 1000))
+    return "" if timestamp_ms == 0 else time.ctime(timestamp_ms / 1000)
 
 
 class TasklistCmd(Cmd):

example/model.py

@@ -6,9 +6,8 @@ class Task:
     id = Id(id=1, uid=1001)
     text = Property(str, id=2, uid=1002)
 
-    # TODO property type DATE
-    date_created = Property(int, id=3, uid=1003)
-    date_finished = Property(int, id=4, uid=1004)
+    date_created = Property(int, type=PropertyType.date, id=3, uid=1003)
+    date_finished = Property(int, type=PropertyType.date, id=4, uid=1004)
 
 
 def get_objectbox_model():

objectbox/c.py

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

objectbox/model/entity.py

@@ -15,6 +15,7 @@
 
 import flatbuffers
 import numpy as np
+from math import floor
 from objectbox.c import *
 from objectbox.model.properties import Property
 
@@ -132,6 +133,8 @@ def marshal(self, object, id: int) -> bytearray:
             else:
                 val = id if prop == self.id_property else self.get_value(
                     object, prop)
+                if prop._ob_type == OBXPropertyType_Date or prop._ob_type == OBXPropertyType_DateNano:
+                    val = floor(val)  # use floor to allow for float types
                 builder.Prepend(prop._fb_type, val)
 
             builder.Slot(prop._fb_slot)

objectbox/model/properties.py

@@ -29,7 +29,8 @@ class PropertyType(IntEnum):
     float = OBXPropertyType_Float
     double = OBXPropertyType_Double
     string = OBXPropertyType_String
-    # date = OBXPropertyType_Date
+    date = OBXPropertyType_Date
+    dateNano = OBXPropertyType_DateNano
     # relation = OBXPropertyType_Relation
     byteVector = OBXPropertyType_ByteVector
     intVector = OBXPropertyType_IntVector
@@ -49,7 +50,8 @@ class PropertyType(IntEnum):
     PropertyType.float: flatbuffers.number_types.Float32Flags,
     PropertyType.double: flatbuffers.number_types.Float64Flags,
     PropertyType.string: flatbuffers.number_types.UOffsetTFlags,
-    # PropertyType.date: flatbuffers.number_types.Int64Flags,
+    PropertyType.date: flatbuffers.number_types.Int64Flags,
+    PropertyType.dateNano: flatbuffers.number_types.Int64Flags,
     # 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(18, 1018))
+    model.entity(TestEntity, last_property_id=IdUid(20, 1020))
     model.last_entity_id = IdUid(1, 1)
 
     db_name = test_dir if len(name) == 0 else test_dir + "/" + name
@@ -40,8 +40,8 @@ def assert_equal_prop_vector(actual, expected, default):
     assert (actual == np.array(expected)).all() or (isinstance(
         expected, objectbox.model.Property) and actual == default)
 
-# compare approx values for list
-def assert_equal_prop_list(actual, expected, default):
+# compare approx values
+def assert_equal_prop_approx(actual, expected, default):
     assert pytest.approx(actual) == expected or (isinstance(
         expected, objectbox.model.Property) and actual == default)
 
@@ -59,7 +59,9 @@ def assert_equal(actual: TestEntity, expected: TestEntity):
     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_list(actual.ints_list, expected.ints_list, [])
-    assert_equal_prop_list(actual.longs_list, expected.longs_list, [])
-    assert_equal_prop_list(actual.floats_list, expected.floats_list, [])
-    assert_equal_prop_list(actual.doubles_list, expected.doubles_list, [])
+    assert_equal_prop_approx(actual.ints_list, expected.ints_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, [])
+    assert_equal_prop_approx(actual.date, expected.date, 0)
+    assert_equal_prop(actual.date_nano, expected.date_nano, 0)

tests/model.py

@@ -22,6 +22,8 @@ class TestEntity:
     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)
     transient = ""  # not "Property" so it's not stored
 
     def __init__(self, string: str = ""):

tests/test_box.py

@@ -3,6 +3,7 @@
 import numpy as np
 from tests.model import TestEntity
 from tests.common import autocleanup, load_empty_test_objectbox, assert_equal
+import time
 
 
 def test_box_basics():
@@ -38,6 +39,8 @@ def test_box_basics():
     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]
+    object.date = time.time() * 1000  # milliseconds since UNIX epoch
+    object.date_nano = time.time_ns()  # nanoseconds since UNIX epoch
     object.transient = "abcd"
 
     id = box.put(object)
@@ -54,6 +57,8 @@ def test_box_basics():
 
     # update
     object.str = "bar"
+    object.date = time.time_ns() / 1000000  # check that date can also be int
+    object.date_nano = time.time() * 1000000000  # check that date_nano can also be float
     id = box.put(object)
     assert id == 5