Merge branch '6-date-types' into 'main'

Add support for Date and DateNano types #6

Closes #6

See merge request objectbox/objectbox-python!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,13 +6,12 @@ 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():
     m = Model()
     m.entity(Task, last_property_id=IdUid(4, 1004))
-    m.last_entity_id = IdUid(1, 1)
+    m.last_entity_id = IdUid(2, 2)
     return m

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,8 @@
 
 import flatbuffers
 import numpy as np
+from math import floor
+from datetime import datetime
 from objectbox.c import *
 from objectbox.model.properties import Property
 
@@ -88,8 +90,11 @@ 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
+            return prop._py_type()  # default (empty) value for the given type
         return val
 
     def get_object_id(self, object) -> int:
@@ -130,8 +135,15 @@ def marshal(self, object, id: int) -> bytearray:
                 if val:
                     builder.PrependUOffsetTRelative(val)
             else:
-                val = id if prop == self.id_property else self.get_value(
-                    object, prop)
+                val = id if prop == self.id_property else self.get_value(object, prop)
+                if prop._ob_type == OBXPropertyType_Date:
+                    if prop._py_type == datetime:
+                        val = val.timestamp() * 1000  # timestamp returns seconds, convert to milliseconds
+                    val = floor(val)  # use floor to allow for float types
+                elif prop._ob_type == OBXPropertyType_DateNano:
+                    if prop._py_type == datetime:
+                        val = val.timestamp() * 1000000000  # convert to nanoseconds
+                    val = floor(val)  # use floor to allow for float types
                 builder.Prepend(prop._fb_type, val)
 
             builder.Slot(prop._fb_slot)
@@ -160,6 +172,12 @@ def unmarshal(self, data: bytes):
                 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_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
+            elif prop._ob_type == OBXPropertyType_DateNano and prop._py_type == datetime:
+                table_val = table.Get(prop._fb_type, o + table.Pos)
+                val = datetime.fromtimestamp(table_val/1000000000) if table_val != 0 else datetime.fromtimestamp(0)  # default timestamp
             elif prop._ob_type == OBXPropertyType_IntVector:
                 val = table.GetVectorAsNumpy(flatbuffers.number_types.Int32Flags, o)
             elif prop._ob_type == OBXPropertyType_LongVector:

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,

objectbox/objectbox.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2021 ObjectBox Ltd. All rights reserved.
+# Copyright 2019-2023 ObjectBox Ltd. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -22,10 +22,16 @@ def __init__(self, c_store: OBX_store_p):
         self._c_store = c_store
 
     def __del__(self):
-        obx_store_close(self._c_store)
+        self.close()
 
     def read_tx(self):
         return objectbox.transaction.read(self)
 
     def write_tx(self):
         return objectbox.transaction.write(self)
+
+    def close(self):
+        c_store_to_close = self._c_store
+        if c_store_to_close:
+            self._c_store = None
+            obx_store_close(c_store_to_close)

tests/common.py

@@ -2,7 +2,7 @@
 import os
 import shutil
 import pytest
-from tests.model import TestEntity
+from tests.model import TestEntity, TestEntityDatetime
 import numpy as np
 
 test_dir = 'testdata'
@@ -24,8 +24,19 @@ 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.last_entity_id = IdUid(1, 1)
+    model.entity(TestEntity, last_property_id=IdUid(20, 1020))
+    model.last_entity_id = IdUid(2, 2)
+
+    db_name = test_dir if len(name) == 0 else test_dir + "/" + name
+
+    return objectbox.Builder().model(model).directory(db_name).build()
+
+
+def load_empty_test_datetime(name: str = "") -> objectbox.ObjectBox:
+    model = objectbox.Model()
+    from objectbox.model import IdUid
+    model.entity(TestEntityDatetime, last_property_id=IdUid(3, 2003))
+    model.last_entity_id = IdUid(2, 2)
 
     db_name = test_dir if len(name) == 0 else test_dir + "/" + name
 
@@ -40,8 +51,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 +70,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

@@ -1,5 +1,6 @@
 from objectbox.model import *
 import numpy as np
+from datetime import datetime
 
 
 @Entity(id=1, uid=1)
@@ -22,7 +23,18 @@ 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 = ""):
         self.str = string
+
+@Entity(id=2, uid=2)
+class TestEntityDatetime:
+    id = Id(id=1, uid=2001)
+    date = Property(datetime, type=PropertyType.date, id=2, uid=2002)
+    date_nano = Property(datetime, type=PropertyType.dateNano, id=3, uid=2003)
+
+    def __init__(self, string: str = ""):
+        self.str = string

tests/test_basics.py

@@ -1,5 +1,5 @@
 import objectbox
-from tests.common import autocleanup, load_empty_test_objectbox, assert_equal
+from tests.common import load_empty_test_objectbox
 
 
 def test_version():

tests/test_box.py

@@ -1,8 +1,16 @@
 import pytest
 import objectbox
+from tests.model import TestEntity, TestEntityDatetime
+from tests.common import (
+    autocleanup,
+    load_empty_test_objectbox,
+    load_empty_test_datetime,
+    assert_equal,
+)
 import numpy as np
-from tests.model import TestEntity
-from tests.common import autocleanup, load_empty_test_objectbox, assert_equal
+from datetime import datetime
+import time
+from math import floor
 
 
 def test_box_basics():
@@ -38,6 +46,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 +64,8 @@ def test_box_basics():
 
     # update
     object.str = "bar"
+    object.date = floor(time.time_ns() / 1000000)  # check that date can also be int
+    object.date_nano = float(time.time() * 1000000000)  # check that date_nano can also be float
     id = box.put(object)
     assert id == 5
 
@@ -72,6 +84,8 @@ def test_box_basics():
     with pytest.raises(objectbox.NotFoundException):
         box.get(1)
 
+    ob.close()
+
 
 def test_box_bulk():
     ob = load_empty_test_objectbox()
@@ -104,3 +118,59 @@ def test_box_bulk():
     removed = box.remove_all()
     assert removed == 4
     assert box.count() == 0
+
+    ob.close()
+
+
+def test_datetime():
+    ob = load_empty_test_datetime()
+    box = objectbox.Box(ob, TestEntityDatetime)
+
+    assert box.is_empty()
+    assert box.count() == 0
+
+    # creat - deferred for now, as there is an issue with 0 timestamp on Windows
+    # object = TestEntityDatetime()
+    # id = box.put(object)
+    # assert id == 1
+    # assert id == object.id
+
+    # create with a given ID and some data
+    object = TestEntityDatetime()
+    object.id = 5
+    object.date = datetime.utcnow()  # milliseconds since UNIX epoch
+    object.date_nano = datetime.utcnow()  # nanoseconds since UNIX epoch
+
+    id = box.put(object)
+    assert id == 5
+    assert id == object.id
+    # check the count
+    assert not box.is_empty()
+    assert box.count() == 1
+
+    # read
+    read = box.get(object.id)
+    assert pytest.approx(read.date.timestamp()) == object.date.timestamp()
+
+    # update
+    object.str = "bar"
+    object.date = datetime.utcnow()
+    object.date_nano = datetime.utcnow()
+    id = box.put(object)
+    assert id == 5
+
+    # read again
+    read = box.get(object.id)
+    assert pytest.approx(read.date.timestamp()) == object.date.timestamp()
+
+    # remove
+    box.remove(object)
+
+    # check they're gone
+    assert box.count() == 0
+    with pytest.raises(objectbox.NotFoundException):
+        box.get(object.id)
+    with pytest.raises(objectbox.NotFoundException):
+        box.get(1)
+
+    ob.close()