scruby 0.9.0__py3-none-any.whl → 0.9.2__py3-none-any.whl

scruby/__init__.py

@@ -18,4 +18,12 @@ from __future__ import annotations
 
 __all__ = ("Scruby",)
 
+import logging
+
 from scruby.db import Scruby
+
+logging.basicConfig(
+    level=logging.INFO,
+    datefmt="%Y-%m-%d %H:%M:%S",
+    format="[%(asctime)s.%(msecs)03d] %(module)10s:%(lineno)-3d %(levelname)-7s - %(message)s",
+)

scruby/db.py

@@ -6,6 +6,7 @@ __all__ = ("Scruby",)
 
 import concurrent.futures
 import contextlib
+import logging
 import zlib
 from collections.abc import Callable
 from pathlib import Path as SyncPath
@@ -17,6 +18,8 @@ from anyio import Path, to_thread
 
 from scruby import constants
 
+logger = logging.getLogger(__name__)
+
 T = TypeVar("T")
 
 
@@ -45,6 +48,8 @@ class Scruby[T]:
             case 6:
                 self.__max_num_keys = 256
             case _ as unreachable:
+                msg: str = f"{unreachable} - Unacceptable value for LENGTH_REDUCTION_HASH."
+                logger.critical(msg)
                 assert_never(Never(unreachable))
 
     async def get_leaf_path(self, key: str) -> Path:
@@ -54,8 +59,10 @@ class Scruby[T]:
             key: Key name.
         """
         if not isinstance(key, str):
+            logger.error("The key is not a type of `str`.")
             raise KeyError("The key is not a type of `str`.")
         if len(key) == 0:
+            logger.error("The key should not be empty.")
             raise KeyError("The key should not be empty.")
         # Key to crc32 sum.
         key_as_hash: str = f"{zlib.crc32(key.encode('utf-8')):08x}"[self.__length_reduction_hash :]
@@ -115,6 +122,8 @@ class Scruby[T]:
             data: dict = orjson.loads(data_json) or {}
             obj: T = self.__class_model.model_validate_json(data[key])
             return obj
+        msg: str = "`get_key` - The unacceptable key value."
+        logger.error(msg)
         raise KeyError()
 
     async def has_key(self, key: str) -> bool:
@@ -151,6 +160,8 @@ class Scruby[T]:
             del data[key]
             await leaf_path.write_bytes(orjson.dumps(data))
             return
+        msg: str = "`delete_key` - The unacceptable key value."
+        logger.error(msg)
         raise KeyError()
 
     @staticmethod
@@ -200,7 +211,7 @@ class Scruby[T]:
         max_workers: int | None = None,
         timeout: float | None = None,
     ) -> T | None:
-        """Find a single document.
+        """Find a single document matching the filter.
 
         The search is based on the effect of a quantum loop.
         The search effectiveness depends on the number of processor threads.
@@ -241,7 +252,7 @@ class Scruby[T]:
         max_workers: int | None = None,
         timeout: float | None = None,
     ) -> list[T] | None:
-        """Find documents.
+        """Find one or more documents matching the filter.
 
         The search is based on the effect of a quantum loop.
         The search effectiveness depends on the number of processor threads.

{scruby-0.9.0.dist-info → scruby-0.9.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scruby
-Version: 0.9.0
+Version: 0.9.2
 Summary: A fast key-value storage library.
 Project-URL: Homepage, https://github.com/kebasyaty/scruby
 Project-URL: Repository, https://github.com/kebasyaty/scruby
@@ -103,6 +103,8 @@ uv add scruby
 
 ## Usage
 
+See more examples here [https://kebasyaty.github.io/scruby/latest/pages/usage/](https://kebasyaty.github.io/scruby/latest/pages/usage/ "Examples").
+
 ```python
 """Working with keys."""
 
@@ -157,7 +159,7 @@ if __name__ == "__main__":
 ```
 
 ```python
-"""Find a single document.
+"""Find a single document matching the filter.
 
 The search is based on the effect of a quantum loop.
 The search effectiveness depends on the number of processor threads.
@@ -228,7 +230,7 @@ if __name__ == "__main__":
 ```
 
 ```python
-"""Find documents.
+"""Find one or more documents matching the filter.
 
 The search is based on the effect of a quantum loop.
 The search effectiveness depends on the number of processor threads.
@@ -288,42 +290,6 @@ if __name__ == "__main__":
     anyio.run(main)
 ```
 
-```python
-"""Get collection name."""
-
-import anyio
-import datetime
-from typing import Annotated
-from pydantic import BaseModel, EmailStr
-from pydantic_extra_types.phone_numbers import PhoneNumber, PhoneNumberValidator
-from scruby import Scruby, constants
-
-constants.DB_ROOT = "ScrubyDB"  # By default = "ScrubyDB"
-
-class User(BaseModel):
-    """Model of User."""
-    first_name: str
-    last_name: str
-    birthday: datetime.datetime
-    email: EmailStr
-    phone: Annotated[PhoneNumber, PhoneNumberValidator(number_format="E164")]
-
-async def main() -> None:
-    """Example."""
-    # Get collection of `User`.
-    user_coll = Scruby(User)
-
-    print(user_coll.collection_name())  # "User"
-    print(user_coll.collection_full_name())  # "ScrubyDB/User"
-
-    # Full database deletion.
-    # Hint: The main purpose is tests.
-    await Scruby.napalm()
-
-if __name__ == "__main__":
-    anyio.run(main)
-```
-
 ## Changelog
 
 [View the change history](https://github.com/kebasyaty/scruby/blob/v0/CHANGELOG.md "Changelog").

scruby-0.9.2.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=W3VvC3ss1NXonQnFI6Yw2MobBARMgus5Acw-k5uL3TE,10946
+scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scruby-0.9.2.dist-info/METADATA,sha256=vZab1ietT1of_GXLHEISYhIkXZJuBIp3vk_rAFGeNPA,10833
+scruby-0.9.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+scruby-0.9.2.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
+scruby-0.9.2.dist-info/RECORD,,

scruby-0.9.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-scruby/__init__.py,sha256=myX7sG-7oAQZGdgfZtTGXYCCraTeuwi7SjBoltftpnM,648
-scruby/constants.py,sha256=GbB-O0qaVdi5EHUp-zRAppFXLR-oHxpXUFVAOCpS0C8,1022
-scruby/db.py,sha256=1tfDCwoKwUx0a6DfEOpPAV8NYuifmmrX8Q9gU3K6l58,10407
-scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scruby-0.9.0.dist-info/METADATA,sha256=7Durmb2_VtJ4plz-OM-vhzfLAM8QGYkmVTRX1KFfOYY,11533
-scruby-0.9.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-scruby-0.9.0.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
-scruby-0.9.0.dist-info/RECORD,,