Merge branch '44-deprecate-ObjectBox-add-Store' into 'dev'

loryruta · loryruta · commit 68fadd95cc9e · 2024-05-08T12:39:35.000Z
Resolve "Deprecate ObjectBox and add Store class"

Closes #44

See merge request objectbox/objectbox-python!30
diff --git a/benchmark.py b/benchmark.py
@@ -1,7 +1,7 @@
 import objectbox
 import time
 from tests.model import TestEntity
-from tests.common import remove_test_dir, load_empty_test_objectbox
+from tests.common import remove_test_dir, load_empty_test_default_store
 
 
 class ObjectBoxPerf:
@@ -10,7 +10,7 @@ class ObjectBoxPerf:
     """
 
     def __init__(self):
-        self.ob = load_empty_test_objectbox()
+        self.ob = load_empty_test_default_store()
         self.box = objectbox.Box(self.ob, TestEntity)
 
     def remove_all(self):
diff --git a/objectbox/__init__.py b/objectbox/__init__.py
@@ -1,4 +1,4 @@
-# Copyright 2019-2023 ObjectBox Ltd. All rights reserved.
+# Copyright 2019-2024 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.
@@ -16,6 +16,7 @@
 from objectbox.box import Box
 from objectbox.builder import Builder
 from objectbox.model import Model
+from objectbox.store import Store
 from objectbox.objectbox import ObjectBox
 from objectbox.c import NotFoundException, version_core
 from objectbox.version import Version
@@ -24,6 +25,7 @@
     'Box',
     'Builder',
     'Model',
+    'Store',
     'ObjectBox',
     'NotFoundException',
     'version',
diff --git a/objectbox/box.py b/objectbox/box.py
@@ -1,4 +1,4 @@
-# Copyright 2019-2021 ObjectBox Ltd. All rights reserved.
+# Copyright 2019-2024 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.
@@ -14,20 +14,20 @@
 
 
 from objectbox.model.entity import _Entity
-from objectbox.objectbox import ObjectBox
+from objectbox.store import Store
 from objectbox.query_builder import QueryBuilder
 from objectbox.condition import QueryCondition
 from objectbox.c import *
 
 
 class Box:
-    def __init__(self, ob: ObjectBox, entity: _Entity):
+    def __init__(self, store: Store, entity: _Entity):
         if not isinstance(entity, _Entity):
             raise Exception("Given type is not an Entity")
 
-        self._ob = ob
+        self._store = store 
         self._entity = entity
-        self._c_box = obx_box(ob._c_store, entity.id)
+        self._c_box = obx_box(store._c_store, entity.id)
 
     def is_empty(self) -> bool:
         is_empty = ctypes.c_bool()
@@ -109,7 +109,7 @@ def _put_many(self, objects) -> None:
             self._entity.set_object_id(objects[k], ids[k])
 
     def get(self, id: int):
-        with self._ob.read_tx():
+        with self._store.read_tx():
             c_data = ctypes.c_void_p()
             c_size = ctypes.c_size_t()
             code : obx_err = obx_box_get(self._c_box, id, ctypes.byref(
@@ -122,7 +122,7 @@ def get(self, id: int):
             return self._entity.unmarshal(data)
 
     def get_all(self) -> list:
-        with self._ob.read_tx():
+        with self._store.read_tx():
             # OBX_bytes_array*
             c_bytes_array_p = obx_box_get_all(self._c_box)
 
@@ -166,7 +166,7 @@ def query(self, condition: Optional[QueryCondition] = None) -> QueryBuilder:
             Useful for a user-friendly API design; for example:
                 ``box.query(name_property.equals("Johnny")).build()``
         """
-        qb = QueryBuilder(self._ob, self)
+        qb = QueryBuilder(self._store, self)
         if condition is not None:
             condition.apply(qb)
         return qb
diff --git a/objectbox/builder.py b/objectbox/builder.py
@@ -1,4 +1,4 @@
-# Copyright 2019-2021 ObjectBox Ltd. All rights reserved.
+# Copyright 2019-2024 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.
@@ -15,7 +15,7 @@
 
 from objectbox.c import *
 from objectbox.model import Model
-from objectbox.objectbox import ObjectBox
+from objectbox.store import Store
 from objectbox.store_options import StoreOptions
 
 
@@ -38,7 +38,7 @@ def model(self, model: Model) -> 'Builder':
         self._model._finish()
         return self
 
-    def build(self) -> 'ObjectBox':
+    def build(self) -> 'Store':
         options = StoreOptions()
         try:
             if self._directory:
@@ -50,4 +50,4 @@ def build(self) -> 'ObjectBox':
             options._free()
             raise
         c_store = obx_store_open(options._c_handle)
-        return ObjectBox(c_store)
+        return Store(c_store)
diff --git a/objectbox/c.py b/objectbox/c.py
@@ -1,4 +1,4 @@
-# Copyright 2019-2021 ObjectBox Ltd. All rights reserved.
+# Copyright 2019-2024 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.
diff --git a/objectbox/model/__init__.py b/objectbox/model/__init__.py
@@ -1,4 +1,4 @@
-# Copyright 2019-2021 ObjectBox Ltd. All rights reserved.
+# Copyright 2019-2024 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.
diff --git a/objectbox/model/entity.py b/objectbox/model/entity.py
@@ -1,4 +1,4 @@
-# Copyright 2019-2023 ObjectBox Ltd. All rights reserved.
+# Copyright 2019-2024 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.
diff --git a/objectbox/model/model.py b/objectbox/model/model.py
@@ -1,4 +1,4 @@
-# Copyright 2019-2021 ObjectBox Ltd. All rights reserved.
+# Copyright 2019-2024 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.
diff --git a/objectbox/model/properties.py b/objectbox/model/properties.py
@@ -1,4 +1,4 @@
-# Copyright 2019-2023 ObjectBox Ltd. All rights reserved.
+# Copyright 2019-2024 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.
diff --git a/objectbox/objectbox.py b/objectbox/objectbox.py
@@ -1,4 +1,4 @@
-# Copyright 2019-2023 ObjectBox Ltd. All rights reserved.
+# Copyright 2019-2024 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.
@@ -13,25 +13,11 @@
 # limitations under the License.
 
 
-from objectbox.c import *
-import objectbox.transaction
+import objectbox.store
+from warnings import warn
 
-
-class ObjectBox:
-    def __init__(self, c_store: OBX_store_p):
-        self._c_store = c_store
-
-    def __del__(self):
-        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)
+class ObjectBox(objectbox.store.Store):
+    def __init__(self, *args, **kwargs):
+        """This throws a deprecation warning on initialization."""
+        warn(f'{self.__class__.__name__} will be deprecated, use Store from objectbox.store.', DeprecationWarning, stacklevel=2)
+        super().__init__(*args, **kwargs)
diff --git a/objectbox/query.py b/objectbox/query.py
@@ -1,4 +1,4 @@
-# Copyright 2019-2023 ObjectBox Ltd. All rights reserved.
+# Copyright 2019-2024 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.
@@ -20,11 +20,11 @@ def __init__(self, c_query, box: 'Box'):
         self._c_query = c_query
         self._box = box
         self._entity = self._box._entity
-        self._ob = box._ob
+        self._store = box._store
 
     def find(self) -> list:
         """ Finds a list of objects matching query. """
-        with self._ob.read_tx():
+        with self._store.read_tx():
             # OBX_bytes_array*
             c_bytes_array_p = obx_query_find(self._c_query)
             try:
diff --git a/objectbox/query_builder.py b/objectbox/query_builder.py
@@ -4,16 +4,16 @@
 
 from objectbox.c import *
 from objectbox.model.properties import Property
-from objectbox.objectbox import ObjectBox
+from objectbox.store import Store
 from objectbox.query import Query
 from objectbox.utils import check_float_vector
 
 
 class QueryBuilder:
-    def __init__(self, ob: ObjectBox, box: 'Box'):
+    def __init__(self, store: Store, box: 'Box'):
         self._box = box
         self._entity = box._entity
-        self._c_builder = obx_query_builder(ob._c_store, box._entity.id)
+        self._c_builder = obx_query_builder(store._c_store, box._entity.id)
 
     def close(self) -> int:
         return obx_qb_close(self._c_builder)
diff --git a/objectbox/store.py b/objectbox/store.py
@@ -0,0 +1,37 @@
+# Copyright 2019-2024 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.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+from objectbox.c import *
+import objectbox.transaction
+
+
+class Store:
+    def __init__(self, c_store: OBX_store_p):
+        self._c_store = c_store
+
+    def __del__(self):
+        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)
diff --git a/objectbox/transaction.py b/objectbox/transaction.py
@@ -1,4 +1,4 @@
-# Copyright 2019-2023 ObjectBox Ltd. All rights reserved.
+# Copyright 2019-2024 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.
@@ -17,17 +17,17 @@
 
 
 @contextmanager
-def read(ob: 'ObjectBox'):
-    tx = obx_txn_read(ob._c_store)
+def read(store: 'Store'):
+    tx = obx_txn_read(store._c_store)
     try:
         yield
     finally:
         obx_txn_close(tx)
 
 
 @contextmanager
-def write(ob: 'ObjectBox'):
-    tx = obx_txn_write(ob._c_store)
+def write(store: 'Store'):
+    tx = obx_txn_write(store._c_store)
     try:
         yield
         obx_txn_success(tx)
diff --git a/objectbox/version.py b/objectbox/version.py
@@ -1,4 +1,4 @@
-# Copyright 2019-2021 ObjectBox Ltd. All rights reserved.
+# Copyright 2019-2024 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.
diff --git a/tests/common.py b/tests/common.py
@@ -9,17 +9,18 @@
 
 test_dir = 'testdata'
 
-
-def load_empty_test_objectbox(db_name: str = test_dir) -> objectbox.ObjectBox:
+def create_default_model() -> objectbox.Model:
     model = objectbox.Model()
     model.entity(TestEntity, last_property_id=IdUid(27, 1027))
     model.last_entity_id = IdUid(2, 2)
     model.last_index_id = IdUid(2, 10002)
+    return model
 
+def load_empty_test_default_store(db_name: str = test_dir) -> objectbox.Store:
+    model = create_default_model()
     return objectbox.Builder().model(model).directory(db_name).build()
 
-
-def load_empty_test_datetime(name: str = "") -> objectbox.ObjectBox:
+def load_empty_test_datetime_store(name: str = "") -> objectbox.Store:
     model = objectbox.Model()
     model.entity(TestEntityDatetime, last_property_id=IdUid(4, 2004))
     model.last_entity_id = IdUid(2, 2)
@@ -29,7 +30,7 @@ def load_empty_test_datetime(name: str = "") -> objectbox.ObjectBox:
     return objectbox.Builder().model(model).directory(db_name).build()
 
 
-def load_empty_test_flex(name: str = "") -> objectbox.ObjectBox:
+def load_empty_test_flex_store(name: str = "") -> objectbox.Store:
     model = objectbox.Model()
     model.entity(TestEntityFlex, last_property_id=IdUid(2, 3002))
     model.last_entity_id = IdUid(3, 3)
@@ -39,8 +40,8 @@ def load_empty_test_flex(name: str = "") -> objectbox.ObjectBox:
     return objectbox.Builder().model(model).directory(db_name).build()
 
 
-def create_test_objectbox(db_name: Optional[str] = None, clear_db: bool = True) -> objectbox.ObjectBox:
-    """ Creates an ObjectBox instance with all entities. """
+def create_test_store(db_name: Optional[str] = None, clear_db: bool = True) -> objectbox.Store:
+    """ Creates a Store instance with all entities. """
 
     db_path = test_dir if db_name is None else path.join(test_dir, db_name)
     print(f"DB path: \"{db_path}\"")
diff --git a/tests/test_basics.py b/tests/test_basics.py
@@ -12,7 +12,7 @@
 # limitations under the License.
 
 import objectbox
-from tests.common import load_empty_test_objectbox
+from tests.common import load_empty_test_default_store
 
 
 def test_version():
@@ -30,4 +30,4 @@ def test_version():
 
 
 def test_open():
-    load_empty_test_objectbox()
+    load_empty_test_default_store()
diff --git a/tests/test_box.py b/tests/test_box.py
diff --git a/tests/test_deprecated.py b/tests/test_deprecated.py
diff --git a/tests/test_hnsw.py b/tests/test_hnsw.py
diff --git a/tests/test_index.py b/tests/test_index.py
diff --git a/tests/test_inmemory.py b/tests/test_inmemory.py
diff --git a/tests/test_query.py b/tests/test_query.py
diff --git a/tests/test_transactions.py b/tests/test_transactions.py

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Copyright 2019-2021 ObjectBox Ltd. All rights reserved.`
	`1`	`+# Copyright 2019-2024 ObjectBox Ltd. All rights reserved.`
`2`	`2`	`#`
`3`	`3`	`# Licensed under the Apache License, Version 2.0 (the "License");`
`4`	`4`	`# you may not use this file except in compliance with the License.`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Copyright 2019-2023 ObjectBox Ltd. All rights reserved.`
	`1`	`+# Copyright 2019-2024 ObjectBox Ltd. All rights reserved.`
`2`	`2`	`#`
`3`	`3`	`# Licensed under the Apache License, Version 2.0 (the "License");`
`4`	`4`	`# you may not use this file except in compliance with the License.`