scruby 0.6.1__py3-none-any.whl → 0.6.3__py3-none-any.whl

scruby/__init__.py

@@ -16,10 +16,6 @@ In the future, to search by value of key, the use of a quantum loop is supposed.
 
 from __future__ import annotations
 
-__all__ = (
-    "Scruby",
-    "constants",
-)
+__all__ = ("Scruby",)
 
-from scruby import constants
 from scruby.db import Scruby

scruby/constants.py

@@ -2,10 +2,31 @@
 
 The module contains the following variables:
 
-- `DB_ROOT` - Path to root directory of database. By default = "ScrubyDB" (in root of project).
+- `DB_ROOT` - Path to root directory of database. `By default = "ScrubyDB"` (*in root of project*).
+- `LENGTH_SEPARATED_HASH` - Length of separated hash for create path inside collection.
+    - `2` - 256 branches (main purpose is tests).
+    - `4` - 65536 branches.
+    - `6` - 16777216 branches.
+    - `8` - 4294967296 branches (by default).
 """
 
 from __future__ import annotations
 
-# Path to root directory of database. By default = "ScrubyDB" (in root of project).
+__all__ = (
+    "DB_ROOT",
+    "LENGTH_SEPARATED_HASH",
+)
+
+from typing import Literal
+
+# Path to root directory of database
+# By default = "ScrubyDB" (in root of project).
 DB_ROOT: str = "ScrubyDB"
+
+# Length of separated hash for create path inside collection.
+# By default = 8
+# 2 = 256 branches (main purpose is tests).
+# 4 = 65536 branches.
+# 6 = 16777216 branches.
+# 8 = 4294967296 branches (by default).
+LENGTH_SEPARATED_HASH: Literal[2, 4, 6, 8] = 8

scruby/db.py

@@ -18,7 +18,7 @@ T = TypeVar("T")
 
 
 class Scruby[T]:
-    """Creation and management of the database.
+    """Creation and management of database.
 
     Args:
         class_model: Class of Model (Pydantic).
@@ -31,7 +31,7 @@ class Scruby[T]:
         self.__class_model = class_model
 
     async def get_leaf_path(self, key: str) -> Path:
-        """Get the path to the database cell by key.
+        """Asynchronous method for getting path to collection cell by key.
 
         Args:
             key: Key name.
@@ -40,16 +40,18 @@ class Scruby[T]:
             raise KeyError("The key is not a type of `str`.")
         if len(key) == 0:
             raise KeyError("The key should not be empty.")
-        # Key to adler32 sum.
-        key_adler32: str = f"{zlib.adler32(key.encode('utf-8')):08x}"
-        # Convert adler32 sum in the segment of path.
-        separated_adler32: str = "/".join(list(key_adler32))
+        # Get length of hash.
+        length_hash = constants.LENGTH_SEPARATED_HASH
+        # Key to crc32 sum.
+        key_as_hash: str = f"{zlib.crc32(key.encode('utf-8')):08x}"[0:length_hash]
+        # Convert crc32 sum in the segment of path.
+        separated_hash: str = "/".join(list(key_as_hash))
         # The path of the branch to the database.
         branch_path: Path = Path(
             *(
                 constants.DB_ROOT,
                 self.__class_model.__name__,
-                separated_adler32,
+                separated_hash,
             ),
         )
         # If the branch does not exist, need to create it.
@@ -64,7 +66,7 @@ class Scruby[T]:
         key: str,
         value: T,
     ) -> None:
-        """Asynchronous method for adding and updating keys to database.
+        """Asynchronous method for adding and updating keys to collection.
 
         Args:
             key: Key name.
@@ -85,7 +87,7 @@ class Scruby[T]:
             await leaf_path.write_bytes(orjson.dumps({key: value_json}))
 
     async def get_key(self, key: str) -> T:
-        """Asynchronous method for getting key from database.
+        """Asynchronous method for getting value of key from collection.
 
         Args:
             key: Key name.
@@ -101,7 +103,7 @@ class Scruby[T]:
         raise KeyError()
 
     async def has_key(self, key: str) -> bool:
-        """Asynchronous method for checking presence of  key in database.
+        """Asynchronous method for checking presence of key in collection.
 
         Args:
             key: Key name.
@@ -120,7 +122,7 @@ class Scruby[T]:
         return False
 
     async def delete_key(self, key: str) -> None:
-        """Asynchronous method for deleting key from database.
+        """Asynchronous method for deleting key from collection.
 
         Args:
             key: Key name.
@@ -138,7 +140,7 @@ class Scruby[T]:
 
     @classmethod
     async def napalm(cls) -> None:
-        """Asynchronous method for full database deletion (Arg: db_name).
+        """Asynchronous method for full database deletion.
 
         The main purpose is tests.
 

{scruby-0.6.1.dist-info → scruby-0.6.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scruby
-Version: 0.6.1
+Version: 0.6.3
 Summary: A fast key-value storage library.
 Project-URL: Homepage, https://github.com/kebasyaty/scruby
 Project-URL: Repository, https://github.com/kebasyaty/scruby
@@ -36,7 +36,7 @@ Description-Content-Type: text/markdown
   <p align="center">
     <a href="https://github.com/kebasyaty/scruby">
       <img
-        height="90"
+        height="80"
         alt="Logo"
         src="https://raw.githubusercontent.com/kebasyaty/scruby/main/assets/logo.svg">
     </a>
@@ -65,7 +65,9 @@ Description-Content-Type: text/markdown
       <a href="https://github.com/kebasyaty/scruby/releases/" alt="GitHub release"><img src="https://img.shields.io/github/release/kebasyaty/scruby" alt="GitHub release"></a>
     </p>
     <p align="center">
-      Scruby is a fast key-value storage asynchronous library that provides an ordered mapping from string keys to string values.
+      Scruby is a fast key-value storage asynchronous library that provides an
+      <br>
+      ordered mapping from string keys to string values.
       <br>
       The library uses fractal-tree addressing.
       <br>
@@ -81,6 +83,10 @@ Description-Content-Type: text/markdown
   </p>
 </div>
 
+##
+
+<br>
+
 ## Documentation
 
 Online browsable documentation is available at [https://kebasyaty.github.io/scruby/](https://kebasyaty.github.io/scruby/ "Documentation").

scruby-0.6.3.dist-info/RECORD

@@ -0,0 +1,8 @@
+scruby/__init__.py,sha256=myX7sG-7oAQZGdgfZtTGXYCCraTeuwi7SjBoltftpnM,648
+scruby/constants.py,sha256=7Px7BDQozlvfSKSAN4Rme4uJHLY_OsT3H0Wq6A_810k,942
+scruby/db.py,sha256=Rt9YDe0lSJwtREHFiqdQ6CQ664FL6YRyczbgKFhpsa4,4871
+scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scruby-0.6.3.dist-info/METADATA,sha256=8TTKyS4FsDr9PEvL7U5DKtAuRSxUR-s_cMiJ9F7Wwzw,6813
+scruby-0.6.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+scruby-0.6.3.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
+scruby-0.6.3.dist-info/RECORD,,

scruby-0.6.1.dist-info/RECORD

@@ -1,8 +0,0 @@
-scruby/__init__.py,sha256=Bhg7pIV6u0YM7Dipr7vH7ka931bVuBoJugiYNd73HQ4,704
-scruby/constants.py,sha256=kwF0FIbeChBxsNxOCQhMsDEn1lakD7MIQKJ-PHYeSAo,328
-scruby/db.py,sha256=qhVoSMu-MDiIdPK4M3ruEZDXxcvKBPu-AS-J_xSNZE4,4763
-scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scruby-0.6.1.dist-info/METADATA,sha256=qzdPamjqOufrJ7hibG37MaiUV27RAIcPikn9idMIYzg,6786
-scruby-0.6.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-scruby-0.6.1.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
-scruby-0.6.1.dist-info/RECORD,,