scruby 0.5.1__py3-none-any.whl → 0.6.0__py3-none-any.whl

scruby/__init__.py

@@ -3,11 +3,13 @@
 Scruby is a fast key-value storage library that provides an ordered mapping from string keys to string values.
 The library uses fractal-tree addressing.
 
-The maximum size of the database is 16**32=340282366920938463463374607431768211456 branches,
+The database consists of collections.
+The maximum size of the one collection is 16**8=4294967296 branches,
 each branch can store one or more keys.
 
-The value of any key can be obtained in 32 steps, thereby achieving high performance.
-There is no need to iterate through all the keys in search of the desired value.
+The value of any key in collection can be obtained in 8 steps, thereby achieving high performance.
+
+In the future, to search by value of key, the use of a quantum loop is supposed.
 """
 
 from __future__ import annotations

scruby/db.py

@@ -4,7 +4,8 @@ from __future__ import annotations
 
 __all__ = ("Scruby",)
 
-import hashlib
+import contextlib
+import zlib
 from shutil import rmtree
 from typing import TypeVar
 
@@ -29,19 +30,31 @@ class Scruby[T]:
     ) -> None:
         self.__class_model = class_model
 
+    def check_key(self, key: str) -> None:
+        """Check the key."""
+        if not isinstance(key, str):
+            raise KeyError("The key is not a type of `str`.")
+        if len(key) == 0:
+            raise KeyError("The key should not be empty.")
+
     async def get_leaf_path(self, key: str) -> Path:
         """Get the path to the database cell by key.
 
         Args:
             key: Key name.
         """
-        # Key to md5 sum.
-        key_md5: str = hashlib.md5(key.encode("utf-8")).hexdigest()  # noqa: S324
-        # Convert md5 sum in the segment of path.
-        separated_md5: str = "/".join(list(key_md5))
+        self.check_key(key)
+        # Key to crc32 sum.
+        key_crc32: str = f"{zlib.crc32(key.encode('utf-8')):08x}"
+        # Convert crc32 sum in the segment of path.
+        separated_crc32: str = "/".join(list(key_crc32))
         # The path of the branch to the database.
         branch_path: Path = Path(
-            *(constants.DB_ROOT, self.__class_model.__name__, separated_md5),
+            *(
+                constants.DB_ROOT,
+                self.__class_model.__name__,
+                separated_crc32,
+            ),
         )
         # If the branch does not exist, need to create it.
         if not await branch_path.exists():
@@ -127,7 +140,8 @@ class Scruby[T]:
             return
         raise KeyError()
 
-    async def napalm(self) -> None:
+    @classmethod
+    async def napalm(cls) -> None:
         """Asynchronous method for full database deletion (Arg: db_name).
 
         The main purpose is tests.
@@ -135,5 +149,6 @@ class Scruby[T]:
         Warning:
             - `Be careful, this will remove all keys.`
         """
-        await to_thread.run_sync(rmtree, constants.DB_ROOT)
+        with contextlib.suppress(FileNotFoundError):
+            await to_thread.run_sync(rmtree, constants.DB_ROOT)
         return

{scruby-0.5.1.dist-info → scruby-0.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scruby
-Version: 0.5.1
+Version: 0.6.0
 Summary: A fast key-value storage library.
 Project-URL: Homepage, https://github.com/kebasyaty/scruby
 Project-URL: Repository, https://github.com/kebasyaty/scruby
@@ -66,15 +66,15 @@ Description-Content-Type: text/markdown
     </p>
     <p align="center">
       Scruby is a fast key-value storage library that provides an ordered mapping from string keys to string values.
-      <br>
       The library uses fractal-tree addressing.
       <br>
-      The maximum size of the database is 16**32=340282366920938463463374607431768211456 branches,
+      The database consists of collections.
+      The maximum size of the one collection is 16**8=4294967296 branches,
       each branch can store one or more keys.
       <br>
-      The value of any key can be obtained in 32 steps, thereby achieving high performance.
+      The value of any key in collection can be obtained in 8 steps, thereby achieving high performance.
       <br>
-      There is no need to iterate through all the keys in search of the desired value.
+      In the future, to search by value of key, the use of a quantum loop is supposed.
     </p>
   </p>
 </div>
@@ -106,7 +106,6 @@ constants.DB_ROOT = "ScrubyDB"  # By default = "ScrubyDB"
 
 class User(BaseModel):
     """Model of User."""
-
     first_name: str
     last_name: str
     birthday: datetime.datetime
@@ -115,7 +114,8 @@ class User(BaseModel):
 
 async def main() -> None:
     """Example."""
-    db = Scruby(User)
+    # Get collection of `User`.
+    user_coll = Scruby(User)
 
     user = User(
         first_name="John",
@@ -125,23 +125,21 @@ async def main() -> None:
         phone="+447986123456",
     )
 
-    await db.set_key("+447986123456", user)
+    await user_coll.set_key("+447986123456", user)
 
-    await db.get_key("+447986123456")  # => user
-    await db.get_key("key missing")  # => KeyError
+    await user_coll.get_key("+447986123456")  # => user
+    await user_coll.get_key("key missing")  # => KeyError
 
-    await db.has_key("+447986123456")  # => True
-    await db.has_key("key missing")  # => False
+    await user_coll.has_key("+447986123456")  # => True
+    await user_coll.has_key("key missing")  # => False
 
-    await db.delete_key("+447986123456")
-    await db.delete_key("+447986123456")  # => KeyError
-    await db.delete_key("key missing")  # => KeyError
+    await user_coll.delete_key("+447986123456")
+    await user_coll.delete_key("+447986123456")  # => KeyError
+    await user_coll.delete_key("key missing")  # => KeyError
 
     # Full database deletion.
     # Hint: The main purpose is tests.
-    await db.napalm()
-    await db.napalm()  # => FileNotFoundError
-
+    await Scruby.napalm()
 
 if __name__ == "__main__":
     anyio.run(main)

scruby-0.6.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+scruby/__init__.py,sha256=Mvy-90k-kNUAlYA7xuCEIT1uC8u5pepuDxGy6DglCxU,689
+scruby/constants.py,sha256=kwF0FIbeChBxsNxOCQhMsDEn1lakD7MIQKJ-PHYeSAo,328
+scruby/db.py,sha256=Xn7AWXly8nubvWqsRrJYpvozUHB1CXNineizVK6GNEw,4854
+scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scruby-0.6.0.dist-info/METADATA,sha256=2mxPkFwKcU2V-Mw6nz_fru7xo-TVdugS5XUPNYoJONg,6751
+scruby-0.6.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+scruby-0.6.0.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
+scruby-0.6.0.dist-info/RECORD,,

scruby-0.5.1.dist-info/RECORD

@@ -1,8 +0,0 @@
-scruby/__init__.py,sha256=LnHBN1pIOtT89baSQoknQwYI1cy-hmN1Lo0k8o1Ms48,659
-scruby/constants.py,sha256=kwF0FIbeChBxsNxOCQhMsDEn1lakD7MIQKJ-PHYeSAo,328
-scruby/db.py,sha256=iG1D4-ncVrVysp7OXH-eZksnNacjNna4_8nUbMkWnSE,4409
-scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scruby-0.5.1.dist-info/METADATA,sha256=47mNNYczCbwwTVMyJRoNIn03fQ2bnVNh8ynuVCm-P00,6678
-scruby-0.5.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-scruby-0.5.1.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
-scruby-0.5.1.dist-info/RECORD,,