scruby 0.3.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

scruby/__init__.py

@@ -12,6 +12,10 @@ There is no need to iterate through all the keys in search of the desired value.
 
 from __future__ import annotations
 
-__all__ = ("Scruby",)
+__all__ = (
+    "Scruby",
+    "constants",
+)
 
+from scruby import constants
 from scruby.db import Scruby

scruby/constants.py

@@ -0,0 +1,11 @@
+"""Constant variables.
+
+The module contains the following variables:
+
+- `DB_ROOT` - Path to root directory of database. By default = "ScrubyDB" (in root of project).
+"""
+
+from __future__ import annotations
+
+# Path to root directory of database. By default = "ScrubyDB" (in root of project).
+DB_ROOT: str = "ScrubyDB"

scruby/db.py

@@ -1,19 +1,4 @@
-"""Creation and management of the database.
-
-Examples:
-    >>> from scruby import Scruby
-    >>> db = Scruby()
-    >>> await db.set_key("key name", "Some text")
-    None
-    >>> await db.get_key("key name")
-    "Some text"
-    >>> await db.has_key("key name")
-    True
-    >>> await db.delete_key("key name")
-    None
-    >>> await db.napalm()
-    None
-"""
+"""Creation and management of the database."""
 
 from __future__ import annotations
 
@@ -21,46 +6,28 @@ __all__ = ("Scruby",)
 
 import hashlib
 from shutil import rmtree
-from typing import Literal
+from typing import TypeVar
 
 import orjson
 from anyio import Path, to_thread
 
-type ValueOfKey = str | int | float | list | dict | Literal[True] | Literal[False] | None
+from scruby import constants
 
+T = TypeVar("T")
 
-class Scruby:
-    """Creation and management of the database.
 
-    Examples:
-        >>> from scruby import Scruby
-        >>> db = Scruby()
-        >>> await db.set_key("key name", "Some text")
-        None
-        >>> await db.get_key("key name")
-        "Some text"
-        >>> await db.has_key("key name")
-        True
-        >>> await db.delete_key("key name")
-        None
-        >>> await db.napalm()
-        None
+class Scruby[T]:
+    """Creation and management of the database.
 
     Args:
-        db_path: Path to root directory of databases. Defaule by = "ScrubyDB" (in root of project)
+        class_model: Class of Model (Pydantic).
     """
 
     def __init__(  # noqa: D107
         self,
-        db_path: str = "ScrubyDB",
+        class_model: T,
     ) -> None:
-        super().__init__()
-        self.__db_path = db_path
-
-    @property
-    def db_path(self) -> str:
-        """Get database name."""
-        return self.__db_path
+        self.__class_model = class_model
 
     async def get_leaf_path(self, key: str) -> Path:
         """Get the path to the database cell by key.
@@ -71,10 +38,10 @@ class Scruby:
         # Key to md5 sum.
         key_md5: str = hashlib.md5(key.encode("utf-8")).hexdigest()  # noqa: S324
         # Convert md5 sum in the segment of path.
-        segment_path_md5: str = "/".join(list(key_md5))
+        separated_md5: str = "/".join(list(key_md5))
         # The path of the branch to the database.
         branch_path: Path = Path(
-            *(self.__db_path, segment_path_md5),
+            *(constants.DB_ROOT, self.__class_model.__name__, separated_md5),
         )
         # If the branch does not exist, need to create it.
         if not await branch_path.exists():
@@ -86,46 +53,31 @@ class Scruby:
     async def set_key(
         self,
         key: str,
-        value: ValueOfKey,
+        value: T,
     ) -> None:
         """Asynchronous method for adding and updating keys to database.
 
-        Examples:
-            >>> from scruby import Scruby
-            >>> db = Scruby()
-            >>> await db.set_key("key name", "Some text")
-            None
-
         Args:
             key: Key name.
             value: Value of key.
         """
         # The path to the database cell.
         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 {}
-            data[key] = value
+            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(data=orjson.dumps({key: value}))
+            await leaf_path.write_bytes(orjson.dumps({key: value_json}))
 
-    async def get_key(self, key: str) -> ValueOfKey:
+    async def get_key(self, key: str) -> T:
         """Asynchronous method for getting key from database.
 
-        Examples:
-            >>> from scruby import Scruby
-            >>> db = Scruby()
-            >>> await db.set_key("key name", "Some text")
-            None
-            >>> await db.get_key("key name")
-            "Some text"
-            >>> await db.get_key("key missing")
-            KeyError
-
         Args:
             key: Key name.
         """
@@ -135,22 +87,13 @@ class Scruby:
         if await leaf_path.exists():
             data_json: bytes = await leaf_path.read_bytes()
             data: dict = orjson.loads(data_json) or {}
-            return data[key]
+            obj: T = self.__class_model.model_validate_json(data[key])
+            return obj
         raise KeyError()
 
     async def has_key(self, key: str) -> bool:
         """Asynchronous method for checking presence of  key in database.
 
-        Examples:
-            >>> from scruby import Scruby
-            >>> db = Scruby()
-            >>> await db.set_key("key name", "Some text")
-            None
-            >>> await db.has_key("key name")
-            True
-            >>> await db.has_key("key missing")
-            False
-
         Args:
             key: Key name.
         """
@@ -170,16 +113,6 @@ class Scruby:
     async def delete_key(self, key: str) -> None:
         """Asynchronous method for deleting key from database.
 
-        Examples:
-            >>> from scruby import Scruby
-            >>> db = Scruby()
-            >>> await db.set_key("key name", "Some text")
-            None
-            >>> await db.delete_key("key name")
-            None
-            >>> await db.delete_key("key missing")
-            KeyError
-
         Args:
             key: Key name.
         """
@@ -195,20 +128,12 @@ class Scruby:
         raise KeyError()
 
     async def napalm(self) -> None:
-        """Asynchronous method for full database deletion (Arg: db_path).
+        """Asynchronous method for full database deletion (Arg: db_name).
+
+        The main purpose is tests.
 
         Warning:
             - `Be careful, this will remove all keys.`
-
-        Examples:
-            >>> from scruby import Scruby
-            >>> db = Scruby()
-            >>> await db.set_key("key name", "Some text")
-            None
-            >>> await db.napalm()
-            None
-            >>> await db.napalm()
-            FileNotFoundError
         """
-        await to_thread.run_sync(rmtree, self.__db_path)
+        await to_thread.run_sync(rmtree, constants.DB_ROOT)
         return

{scruby-0.3.0.dist-info → scruby-0.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scruby
-Version: 0.3.0
+Version: 0.5.0
 Summary: A fast key-value storage library.
 Project-URL: Homepage, https://github.com/kebasyaty/scruby
 Project-URL: Repository, https://github.com/kebasyaty/scruby
@@ -11,7 +11,7 @@ Author-email: kebasyaty <kebasyaty@gmail.com>
 License-Expression: MIT
 License-File: LICENSE
 Keywords: database,db,scruby,store
-Classifier: Development Status :: 5 - Production/Stable
+Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: MacOS :: MacOS X
@@ -26,7 +26,8 @@ Classifier: Topic :: Database
 Classifier: Typing :: Typed
 Requires-Python: <4.0,>=3.12
 Requires-Dist: anyio>=4.10.0
-Requires-Dist: orjson>=3.11.2
+Requires-Dist: orjson>=3.11.3
+Requires-Dist: pydantic>=2.11.7
 Description-Content-Type: text/markdown
 
 <div align="center">
@@ -94,36 +95,47 @@ uv add scruby
 
 ```python
 import anyio
-from scruby import Scruby
+import datetime
+from pydantic import BaseModel
+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: str
+    phone: str
 
 async def main() -> None:
     """Example."""
+    db = Scruby(User)
 
-    db = Scruby()
-    await db.set_key("key name", "Some text")
-    # Update key
-    await db.set_key("key name", "Some new text")
+    user = User(
+        first_name="John",
+        last_name="Smith",
+        birthday=datetime.datetime(1970, 1, 1),
+        email="John_Smith@gmail.com",
+        phone="+447986123456",
+    )
 
-    user_details = {
-        "first name": "John",
-        "last name": "Smith",
-        "email": "John_Smith@gmail.com",
-        "phone": "+447986123456",
-    }
-    await db.set_key("+447986123456", user_details)
+    await db.set_key("+447986123456", user)
 
-    await db.get_key("key name")  # => "Some text"
+    await db.get_key("+447986123456")  # => user
     await db.get_key("key missing")  # => KeyError
 
-    await db.has_key("key name")  # => True
+    await db.has_key("+447986123456")  # => True
     await db.has_key("key missing")  # => False
 
-    await db.delete_key("key name")
-    await db.delete_key("key name")  # => KeyError
+    await db.delete_key("+447986123456")
+    await db.delete_key("+447986123456")  # => KeyError
     await db.delete_key("key missing")  # => KeyError
 
     # Full database deletion.
+    # Hint: The main purpose is tests.
     await db.napalm()
     await db.napalm()  # => FileNotFoundError
 

scruby-0.5.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+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.0.dist-info/METADATA,sha256=6V1NV3KWNRsc2Gb2cZbBQ4VsLYbIDMWkCiM9CjkJyxo,6509
+scruby-0.5.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+scruby-0.5.0.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
+scruby-0.5.0.dist-info/RECORD,,

scruby-0.3.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-scruby/__init__.py,sha256=TCxUjBI5A0KZcwvfmgaBVl8ScuzzOVvALl_T4iqSR9c,603
-scruby/db.py,sha256=otENL-t7ie_8Fgzcteh2WsXFPu9pM4DBUdO_2GB1vwk,6565
-scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scruby-0.3.0.dist-info/METADATA,sha256=Dkz32lF7SmIWBEdXNhuhHQkYunAas6A84cEaVu08bYM,6256
-scruby-0.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-scruby-0.3.0.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
-scruby-0.3.0.dist-info/RECORD,,