fastquadtree 1.1.1__cp38-abi3-win_amd64.whl → 1.2.0__cp38-abi3-win_amd64.whl

fastquadtree/_base_quadtree.py

@@ -1,6 +1,7 @@
 # _abc_quadtree.py
 from __future__ import annotations
 
+import pickle
 from abc import ABC, abstractmethod
 from typing import (
     TYPE_CHECKING,
@@ -58,8 +59,9 @@ class _BaseQuadTree(Generic[G, HitT, ItemType], ABC):
     def _new_native(self, bounds: Bounds, capacity: int, max_depth: int | None) -> Any:
         """Create the native engine instance."""
 
+    @staticmethod
     @abstractmethod
-    def _make_item(self, id_: int, geom: G, obj: Any | None) -> ItemType:
+    def _make_item(id_: int, geom: G, obj: Any | None) -> ItemType:
         """Build an ItemType from id, geometry, and optional object."""
 
     # ---- ctor ----
@@ -84,6 +86,71 @@ class _BaseQuadTree(Generic[G, HitT, ItemType], ABC):
         self._next_id = 0
         self._count = 0
 
+    # ---- serialization ----
+
+    def to_dict(self) -> dict[str, Any]:
+        """
+        Serialize the quadtree to a dict suitable for JSON or other serialization.
+
+        Returns:
+            Includes a binary 'core' key for the native engine state, plus other metadata such as bounds and capacity and the obj store if tracking is enabled.
+        """
+
+        core_bytes = self._native.to_bytes()
+
+        return {
+            "core": core_bytes,
+            "store": self._store.to_dict() if self._store is not None else None,
+            "bounds": self._bounds,
+            "capacity": self._capacity,
+            "max_depth": self._max_depth,
+            "track_objects": self._track_objects,
+            "next_id": self._next_id,
+            "count": self._count,
+        }
+
+    def to_bytes(self) -> bytes:
+        """
+        Serialize the quadtree to bytes.
+
+        Returns:
+            Bytes representing the serialized quadtree. Can be saved as a file or loaded with `from_bytes()`.
+        """
+        return pickle.dumps(self.to_dict())
+
+    @classmethod
+    def from_bytes(cls, data: bytes) -> _BaseQuadTree[G, HitT, ItemType]:
+        """
+        Deserialize a quadtree from bytes.
+
+        Args:
+            data: Bytes representing the serialized quadtree from `to_bytes()`.
+
+        Returns:
+            A new quadtree instance with the same state as when serialized.
+        """
+        in_dict = pickle.loads(data)
+        core_bytes = in_dict["core"]
+        store_dict = in_dict["store"]
+
+        qt = cls.__new__(cls)  # type: ignore[call-arg]
+        qt._native = cls._new_native_from_bytes(core_bytes)
+
+        if store_dict is not None:
+            qt._store = ObjStore.from_dict(store_dict, qt._make_item)
+        else:
+            qt._store = None
+
+        # Extract bounds, capacity, max_depth from native
+        qt._bounds = in_dict["bounds"]
+        qt._capacity = in_dict["capacity"]
+        qt._max_depth = in_dict["max_depth"]
+        qt._next_id = in_dict["next_id"]
+        qt._count = in_dict["count"]
+        qt._track_objects = in_dict["track_objects"]
+
+        return qt
+
     # ---- internal helper ----
 
     def _ids_to_objects(self, ids: Iterable[int]) -> list[Any]:

fastquadtree/_item.py

@@ -27,6 +27,35 @@ class Item:
         self.geom: Point | Bounds = geom
         self.obj: Any | None = obj
 
+    def to_dict(self) -> dict[str, Any]:
+        """
+        Serialize the item to a dictionary.
+
+        Returns:
+            A dictionary with 'id', 'geom', and 'obj' keys.
+        """
+        return {
+            "id": self.id_,
+            "geom": self.geom,
+            "obj": self.obj,
+        }
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any]) -> Item:
+        """
+        Deserialize an item from a dictionary.
+
+        Args:
+            data: A dictionary with 'id', 'geom', and 'obj' keys.
+
+        Returns:
+            An Item instance populated with the deserialized data.
+        """
+        id_ = data["id"]
+        geom = data["geom"]
+        obj = data["obj"]
+        return cls(id_, geom, obj)
+
 
 class PointItem(Item):
     """

fastquadtree/_obj_store.py

@@ -35,11 +35,40 @@ class ObjStore(Generic[TItem]):
 
         if items:
             for it in items:
-                self.add(it)
+                self.add(it, handle_out_of_order=True)
+
+    # ---- Serialization ----
+    def to_dict(self) -> dict[str, Any]:
+        """
+        Serialize to a dict suitable for JSON or other serialization.
+
+        Returns:
+            A dict with 'items' key containing list of serialized items.
+        """
+        items = [it.to_dict() for it in self._arr if it is not None]
+        return {"items": items}
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any], item_factory: Any) -> ObjStore[TItem]:
+        """
+        Deserialize from a dict.
+
+        Args:
+            data: A dict with 'items' key containing list of serialized items.
+            item_factory: A callable that takes (id, obj) and returns an Item.
+
+        Returns:
+            An ObjStore instance populated with the deserialized items.
+        """
+        items = []
+        for item_data in data.get("items", []):
+            item = Item.from_dict(item_data)
+            items.append(item_factory(item.id_, item.geom, item.obj))
+        return cls(items)
 
     # -------- core --------
 
-    def add(self, item: TItem) -> None:
+    def add(self, item: TItem, handle_out_of_order: bool = False) -> None:
         """
         Insert or replace the mapping at item.id_. Reverse map updated so obj points to id.
         """
@@ -48,9 +77,14 @@ class ObjStore(Generic[TItem]):
 
         # ids must be dense and assigned by the caller
         if id_ > len(self._arr):
-            raise AssertionError(
-                "ObjStore.add received an out-of-order id, use alloc_id() to get the next available id"
-            )
+            if not handle_out_of_order:
+                raise AssertionError(
+                    "ObjStore.add received an out-of-order id, use alloc_id() to get the next available id"
+                )
+            # fill holes with None
+            while len(self._arr) < id_:
+                self._arr.append(None)
+                self._objs.append(None)
 
         if id_ == len(self._arr):
             # append

fastquadtree/point_quadtree.py

@@ -49,6 +49,18 @@ class QuadTree(_BaseQuadTree[Point, _IdCoord, PointItem]):
             track_objects=track_objects,
         )
 
+    @classmethod
+    def from_bytes(cls, data: bytes) -> QuadTree:
+        """
+        Create a QuadTree instance from serialized bytes.
+
+        Args:
+            data: Serialized byte data from `to_bytes()`.
+        Returns:
+            A QuadTree instance.
+        """
+        return super().from_bytes(data)
+
     @overload
     def query(
         self, rect: Bounds, *, as_items: Literal[False] = ...
@@ -145,5 +157,11 @@ class QuadTree(_BaseQuadTree[Point, _IdCoord, PointItem]):
             return _RustQuadTree(bounds, capacity)
         return _RustQuadTree(bounds, capacity, max_depth=max_depth)
 
-    def _make_item(self, id_: int, geom: Point, obj: Any | None) -> PointItem:
+    @classmethod
+    def _new_native_from_bytes(cls, data: bytes) -> Any:
+        """Create a new native engine instance from serialized bytes."""
+        return _RustQuadTree.from_bytes(data)
+
+    @staticmethod
+    def _make_item(id_: int, geom: Point, obj: Any | None) -> PointItem:
         return PointItem(id_, geom, obj)

fastquadtree/pyqtree.py

@@ -122,6 +122,9 @@ class Index:
         - **item**: The item to insert into the index, which will be returned by the intersection method
         - **bbox**: The spatial bounding box tuple of the item, with four members (xmin,ymin,xmax,ymax)
         """
+        if type(bbox) is list:  # Handle list input
+            bbox = tuple(bbox)
+
         if self._free:
             rid = self._free.pop()
             self._objects[rid] = item
@@ -141,6 +144,9 @@ class Index:
 
         Both parameters need to exactly match the parameters provided to the insert method.
         """
+        if type(bbox) is list:  # Handle list input
+            bbox = tuple(bbox)
+
         rid = self._item_to_id.pop(id(item))
         self._qt.delete(rid, bbox)
         self._objects[rid] = None

fastquadtree/rect_quadtree.py

@@ -50,6 +50,18 @@ class RectQuadTree(_BaseQuadTree[Bounds, _IdRect, RectItem]):
             track_objects=track_objects,
         )
 
+    @classmethod
+    def from_bytes(cls, data: bytes) -> RectQuadTree:
+        """
+        Create a RectQuadTree instance from serialized bytes.
+
+        Args:
+            data: Serialized byte data from `to_bytes()`.
+        Returns:
+            A RectQuadTree instance.
+        """
+        return super().from_bytes(data)
+
     @overload
     def query(
         self, rect: Bounds, *, as_items: Literal[False] = ...
@@ -81,5 +93,11 @@ class RectQuadTree(_BaseQuadTree[Bounds, _IdRect, RectItem]):
             return _RustRectQuadTree(bounds, capacity)
         return _RustRectQuadTree(bounds, capacity, max_depth=max_depth)
 
-    def _make_item(self, id_: int, geom: Bounds, obj: Any | None) -> RectItem:
+    @classmethod
+    def _new_native_from_bytes(cls, data: bytes) -> Any:
+        """Create a new native engine instance from serialized bytes."""
+        return _RustRectQuadTree.from_bytes(data)
+
+    @staticmethod
+    def _make_item(id_: int, geom: Bounds, obj: Any | None) -> RectItem:
         return RectItem(id_, geom, obj)

{fastquadtree-1.1.1.dist-info → fastquadtree-1.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastquadtree
-Version: 1.1.1
+Version: 1.2.0
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Rust
@@ -70,6 +70,7 @@ Rust-optimized quadtree with a clean Python API
 - Support for [inserting bounding boxes](https://elan456.github.io/fastquadtree/api/rect_quadtree/) or points
 - Fast KNN and range queries
 - Optional object tracking for id ↔ object mapping
+- Fast [serialization](https://elan456.github.io/fastquadtree/benchmark/#serialization-vs-rebuild) to/from bytes
 - [100% test coverage](https://codecov.io/gh/Elan456/fastquadtree) and CI on GitHub Actions
 - Offers a drop-in [pyqtree shim](https://elan456.github.io/fastquadtree/benchmark/#pyqtree-drop-in-shim-performance-gains) that is 6.567x faster while keeping the same API
 

fastquadtree-1.2.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+fastquadtree-1.2.0.dist-info/METADATA,sha256=lLyIIqULosQRzzWzbaCn8icIa2dEeaCneAIV--od--k,9773
+fastquadtree-1.2.0.dist-info/WHEEL,sha256=CG8OzNtm0LMpJ2zhrjswlO8N-965OeMLklsQAG-nMvQ,94
+fastquadtree-1.2.0.dist-info/licenses/LICENSE,sha256=46IVFhoCIwMo-ocq4olyEB1eBvvtaKic5yGLeKXnDuc,1092
+fastquadtree/__init__.py,sha256=jy7uimnd7QDllmNOgnRByKom1aONIKOWhCvCJxndsnM,200
+fastquadtree/_base_quadtree.py,sha256=g0xpc_RfdCJscNlt04RmTIETYIMjmQtCR3_yg3di2pg,12416
+fastquadtree/_item.py,sha256=hlA71tvmLUQey42VokaZ7AmorIA8yZoGlvZWW9G4l4k,2496
+fastquadtree/_native.pyd,sha256=_VmaB34V0tbtcS7yi-VBKRkYlKZazbjdkcWeUWjyUlw,338944
+fastquadtree/_obj_store.py,sha256=e164LT01nU5KqPX0udMzcJtpONAohDMEw-c9zEqh7uo,6723
+fastquadtree/point_quadtree.py,sha256=nzYu48-XN0CVDE7zPOxfW4wVpVlxHDObXhjitkzqNzI,5864
+fastquadtree/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fastquadtree/pyqtree.py,sha256=Evu-MKHKrs_xNVWChukD4hJLyIc-u7iuQ4hA_zvJtu4,6246
+fastquadtree/rect_quadtree.py,sha256=73lL6gz51j_WNTnvgRr38ZpMrPPiLM9UW977pD8vzy8,3662
+fastquadtree-1.2.0.dist-info/RECORD,,

fastquadtree-1.1.1.dist-info/RECORD

@@ -1,13 +0,0 @@
-fastquadtree-1.1.1.dist-info/METADATA,sha256=vT-1Ozgx_xPB0ixOsf0ZE97kjLT1bMSshXqhe9AFupA,9659
-fastquadtree-1.1.1.dist-info/WHEEL,sha256=CG8OzNtm0LMpJ2zhrjswlO8N-965OeMLklsQAG-nMvQ,94
-fastquadtree-1.1.1.dist-info/licenses/LICENSE,sha256=46IVFhoCIwMo-ocq4olyEB1eBvvtaKic5yGLeKXnDuc,1092
-fastquadtree/__init__.py,sha256=jy7uimnd7QDllmNOgnRByKom1aONIKOWhCvCJxndsnM,200
-fastquadtree/_base_quadtree.py,sha256=wICOB-CHpneZ00OvPZzQpoUGKVvTRhLScnFxMY4i9Do,10205
-fastquadtree/_item.py,sha256=42sGn--Bcq8NrgNBcoKzJClJjjAHK6ntesyf31qz5yM,1741
-fastquadtree/_native.pyd,sha256=H36CeF-_KGgdO5ZlAPM_3ao6mO4dTtWALZacxyMjtS0,303104
-fastquadtree/_obj_store.py,sha256=NVBGB8XsSiWFzoBgeVE2ScSuL7K9nXaggsp6nXqSGyc,5434
-fastquadtree/point_quadtree.py,sha256=v_iNQZfLOPDKwTwIPMMinSfRCn1im3P0gWEsOnK6qpY,5327
-fastquadtree/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fastquadtree/pyqtree.py,sha256=5FgKVQidHnzPsS9KwWLiliJoOcv0VtMFvMP3jr2uHm8,6072
-fastquadtree/rect_quadtree.py,sha256=ZrOj5dNVg4B2lhuKZ9EMOoYeQNbD3Vbz8S3TxCVCj_c,3109
-fastquadtree-1.1.1.dist-info/RECORD,,