Can store Date as datetime #6

Author: ivahnenkoAnna

objectbox/model/entity.py

@@ -16,6 +16,7 @@
 import flatbuffers
 import numpy as np
 from math import floor
+from datetime import datetime
 from objectbox.c import *
 from objectbox.model.properties import Property
 
@@ -89,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:
@@ -131,9 +135,14 @@ 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)
-                if prop._ob_type == OBXPropertyType_Date or prop._ob_type == OBXPropertyType_DateNano:
+                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)
 
@@ -163,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:

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'
@@ -32,6 +32,17 @@ def load_empty_test_objectbox(name: str = "") -> objectbox.ObjectBox:
     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, 1003))
+    model.last_entity_id = IdUid(1, 1)
+
+    db_name = test_dir if len(name) == 0 else test_dir + "/" + name
+
+    return objectbox.Builder().model(model).directory(db_name).build()
+
+
 def assert_equal_prop(actual, expected, default):
     assert actual == expected or (isinstance(
         expected, objectbox.model.Property) and actual == default)

tests/model.py

@@ -1,5 +1,6 @@
 from objectbox.model import *
 import numpy as np
+from datetime import datetime
 
 
 @Entity(id=1, uid=1)
@@ -28,3 +29,12 @@ class TestEntity:
 
     def __init__(self, string: str = ""):
         self.str = string
+
+@Entity(id=1, uid=1)
+class TestEntityDatetime:
+    id = Id(id=1, uid=1001)
+    date = Property(datetime, type=PropertyType.date, id=2, uid=1002)
+    date_nano = Property(datetime, type=PropertyType.dateNano, id=3, uid=1003)
+
+    def __init__(self, string: str = ""):
+        self.str = string

tests/test_box.py

@@ -1,8 +1,14 @@
 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
 
@@ -110,3 +116,83 @@ def test_box_bulk():
     removed = box.remove_all()
     assert removed == 4
     assert box.count() == 0
+
+
+def test_datetime():
+    ob = load_empty_test_datetime()
+    box = objectbox.Box(ob, TestEntityDatetime)
+
+    assert box.is_empty()
+    assert box.count() == 0
+
+    # create
+    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() == 2
+
+    # 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)
+    box.remove(1)
+
+    # 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)
+
+
+def test_box_bulk_datetime():
+    ob = load_empty_test_datetime()
+    box = objectbox.Box(ob, TestEntityDatetime)
+
+    box.put(TestEntityDatetime("first"))
+
+    objects = [TestEntityDatetime("second"), TestEntityDatetime("third"),
+               TestEntityDatetime("fourth"), box.get(1)]
+    box.put(objects)
+    assert box.count() == 4
+    assert objects[0].id == 2
+    assert objects[1].id == 3
+    assert objects[2].id == 4
+    assert objects[3].id == 1
+
+    objects_read = box.get_all()
+    assert len(objects_read) == 4
+    for object_read in objects_read:
+        assert object_read.date == datetime.fromtimestamp(0)
+        assert object_read.date_nano == datetime.fromtimestamp(0)
+
+    # remove all
+    removed = box.remove_all()
+    assert removed == 4
+    assert box.count() == 0