scruby 0.9.3__py3-none-any.whl → 0.10.1__py3-none-any.whl

scruby/db.py

@@ -11,10 +11,11 @@ import zlib
 from collections.abc import Callable
 from pathlib import Path as SyncPath
 from shutil import rmtree
-from typing import Any, Never, TypeVar, assert_never
+from typing import Any, Literal, Never, TypeVar, assert_never
 
 import orjson
 from anyio import Path, to_thread
+from pydantic import BaseModel
 
 from scruby import constants
 
@@ -23,6 +24,12 @@ logger = logging.getLogger(__name__)
 T = TypeVar("T")
 
 
+class _Meta(BaseModel):
+    """Metadata of Collection."""
+
+    counter_documents: int
+
+
 class Scruby[T]:
     """Creation and management of database.
 
@@ -34,6 +41,7 @@ class Scruby[T]:
         self,
         class_model: T,
     ) -> None:
+        self.__meta = _Meta
         self.__class_model = class_model
         self.__db_root = constants.DB_ROOT
         self.__length_reduction_hash = constants.LENGTH_REDUCTION_HASH
@@ -51,10 +59,85 @@ class Scruby[T]:
                 msg: str = f"{unreachable} - Unacceptable value for LENGTH_REDUCTION_HASH."
                 logger.critical(msg)
                 assert_never(Never(unreachable))
+        # Create metadata if absent.
+        self._create_metadata()
+
+    def _create_metadata(self) -> None:
+        """Create metadata for collection if absent.
+
+        This method is for internal use.
+        """
+        key: int = 0
+        key_as_hash: str = f"{key:08x}"[self.__length_reduction_hash :]
+        separated_hash: str = "/".join(list(key_as_hash))
+        branch_path = SyncPath(
+            *(
+                self.__db_root,
+                self.__class_model.__name__,
+                separated_hash,
+            ),
+        )
+        if not branch_path.exists():
+            branch_path.mkdir(parents=True)
+            meta = _Meta(
+                counter_documents=0,
+            )
+            meta_json = meta.model_dump_json()
+            meta_path = SyncPath(*(branch_path, "meta.json"))
+            meta_path.write_text(meta_json, "utf-8")
+
+    async def _get_meta_path(self) -> Path:
+        """Asynchronous method for getting path to metadata of collection.
+
+        This method is for internal use.
+        """
+        key: int = 0
+        key_as_hash: str = f"{key:08x}"[self.__length_reduction_hash :]
+        separated_hash: str = "/".join(list(key_as_hash))
+        return Path(
+            *(
+                self.__db_root,
+                self.__class_model.__name__,
+                separated_hash,
+                "meta.json",
+            ),
+        )
+
+    async def _get_meta(self) -> _Meta:
+        """Asynchronous method for getting metadata of collection.
 
-    async def get_leaf_path(self, key: str) -> Path:
+        This method is for internal use.
+        """
+        meta_path = await self._get_meta_path()
+        meta_json = await meta_path.read_text()
+        meta: _Meta = self.__meta.model_validate_json(meta_json)
+        return meta
+
+    async def _set_meta(self, meta: _Meta) -> None:
+        """Asynchronous method for updating metadata of collection.
+
+        This method is for internal use.
+        """
+        meta_path = await self._get_meta_path()
+        meta_json = meta.model_dump_json()
+        await meta_path.write_text(meta_json, "utf-8")
+
+    async def _counter_documents(self, step: Literal[1, -1]) -> None:
+        """Management of documents in metadata of collection.
+
+        This method is for internal use.
+        """
+        meta = await self._get_meta()
+        meta.counter_documents += step
+        if meta.counter_documents < 0:
+            meta.counter_documents = 0
+        await self._set_meta(meta)
+
+    async def _get_leaf_path(self, key: str) -> Path:
         """Asynchronous method for getting path to collection cell by key.
 
+        This method is for internal use.
+
         Args:
             key: Key name.
         """
@@ -95,18 +178,21 @@ class Scruby[T]:
             value: Value of key.
         """
         # The path to the database cell.
-        leaf_path: Path = await self.get_leaf_path(key)
+        leaf_path: Path = await self._get_leaf_path(key)
         value_json: str = value.model_dump_json()
         # Write key-value to the database.
         if await leaf_path.exists():
             # Add new key or update existing.
             data_json: bytes = await leaf_path.read_bytes()
             data: dict = orjson.loads(data_json) or {}
+            if data.get(key) is None:
+                await self._counter_documents(1)
             data[key] = value_json
             await leaf_path.write_bytes(orjson.dumps(data))
         else:
             # Add new key to a blank leaf.
             await leaf_path.write_bytes(orjson.dumps({key: value_json}))
+            await self._counter_documents(1)
 
     async def get_key(self, key: str) -> T:
         """Asynchronous method for getting value of key from collection.
@@ -115,7 +201,7 @@ class Scruby[T]:
             key: Key name.
         """
         # The path to the database cell.
-        leaf_path: Path = await self.get_leaf_path(key)
+        leaf_path: Path = await self._get_leaf_path(key)
         # Get value of key.
         if await leaf_path.exists():
             data_json: bytes = await leaf_path.read_bytes()
@@ -133,7 +219,7 @@ class Scruby[T]:
             key: Key name.
         """
         # The path to the database cell.
-        leaf_path: Path = await self.get_leaf_path(key)
+        leaf_path: Path = await self._get_leaf_path(key)
         # Checking whether there is a key.
         if await leaf_path.exists():
             data_json: bytes = await leaf_path.read_bytes()
@@ -152,13 +238,14 @@ class Scruby[T]:
             key: Key name.
         """
         # The path to the database cell.
-        leaf_path: Path = await self.get_leaf_path(key)
+        leaf_path: Path = await self._get_leaf_path(key)
         # Deleting key.
         if await leaf_path.exists():
             data_json: bytes = await leaf_path.read_bytes()
             data: dict = orjson.loads(data_json) or {}
             del data[key]
             await leaf_path.write_bytes(orjson.dumps(data))
+            await self._counter_documents(-1)
             return
         msg: str = "`delete_key` - The unacceptable key value."
         logger.error(msg)
@@ -178,14 +265,17 @@ class Scruby[T]:
         return
 
     @staticmethod
-    def search_task(
+    def _search_task(
         key: int,
         filter_fn: Callable,
         length_reduction_hash: str,
         db_root: str,
         class_model: T,
     ) -> dict[str, Any] | None:
-        """Search task."""
+        """Task for searching for documents.
+
+        This method is for internal use.
+        """
         key_as_hash: str = f"{key:08x}"[length_reduction_hash:]
         separated_hash: str = "/".join(list(key_as_hash))
         leaf_path: SyncPath = SyncPath(
@@ -226,7 +316,7 @@ class Scruby[T]:
                      If None, then there is no limit on the wait time.
         """
         keys: range = range(1, self.__max_num_keys)
-        search_task_fn: Callable = self.search_task
+        search_task_fn: Callable = self._search_task
         length_reduction_hash: int = self.__length_reduction_hash
         db_root: str = self.__db_root
         class_model: T = self.__class_model
@@ -268,7 +358,7 @@ class Scruby[T]:
                      If None, then there is no limit on the wait time.
         """
         keys: range = range(1, self.__max_num_keys)
-        search_task_fn: Callable = self.search_task
+        search_task_fn: Callable = self._search_task
         length_reduction_hash: int = self.__length_reduction_hash
         db_root: str = self.__db_root
         class_model: T = self.__class_model
@@ -299,3 +389,8 @@ class Scruby[T]:
     def collection_full_name(self) -> str:
         """Get full name of collection."""
         return f"{self.__db_root}/{self.__class_model.__name__}"
+
+    async def estimated_document_count(self) -> int:
+        """Get an estimate of the number of documents in this collection using collection metadata."""
+        meta = await self._get_meta()
+        return meta.counter_documents

{scruby-0.9.3.dist-info → scruby-0.10.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scruby
-Version: 0.9.3
+Version: 0.10.1
 Summary: A fast key-value storage library.
 Project-URL: Homepage, https://github.com/kebasyaty/scruby
 Project-URL: Repository, https://github.com/kebasyaty/scruby

scruby-0.10.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+scruby/__init__.py,sha256=wFwUS1KcLxfIopXOVS8gPue9fNzIIU2cVj_RgK5drz4,849
+scruby/constants.py,sha256=GbB-O0qaVdi5EHUp-zRAppFXLR-oHxpXUFVAOCpS0C8,1022
+scruby/db.py,sha256=d4fVb4JhGaBU_YPxByT156UGHQPTwzSizBqOpCNhW8Y,14159
+scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scruby-0.10.1.dist-info/METADATA,sha256=k2AaJn-JijNceNIB7s13D1cB3jr4p4mW6R1z7IuXp4g,10829
+scruby-0.10.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+scruby-0.10.1.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
+scruby-0.10.1.dist-info/RECORD,,

scruby-0.9.3.dist-info/RECORD

@@ -1,8 +0,0 @@
-scruby/__init__.py,sha256=wFwUS1KcLxfIopXOVS8gPue9fNzIIU2cVj_RgK5drz4,849
-scruby/constants.py,sha256=GbB-O0qaVdi5EHUp-zRAppFXLR-oHxpXUFVAOCpS0C8,1022
-scruby/db.py,sha256=reYCZduh4GAycS17oPw8BWoFd-M9A8N7BW_uPFwUd_w,10941
-scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scruby-0.9.3.dist-info/METADATA,sha256=YBlk8IR3bDVRV-XKLKEHkpd3Bir97OF0wyOe0jFDpR0,10828
-scruby-0.9.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-scruby-0.9.3.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
-scruby-0.9.3.dist-info/RECORD,,