scruby 0.4.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

@@ -6,33 +6,28 @@ __all__ = ("Scruby",)
 
 import hashlib
 from shutil import rmtree
-from typing import Generic, TypeVar
+from typing import TypeVar
 
 import orjson
 from anyio import Path, to_thread
 
+from scruby import constants
+
 T = TypeVar("T")
 
 
-class Scruby(Generic[T]):  # noqa: UP046
+class Scruby[T]:
     """Creation and management of the database.
 
     Args:
-        db_name: Path to root directory of databases. By default = "ScrubyDB" (in root of project)
+        class_model: Class of Model (Pydantic).
     """
 
     def __init__(  # noqa: D107
         self,
         class_model: T,
-        db_name: str = "ScrubyDB",
     ) -> None:
         self.__class_model = class_model
-        self.__db_name = db_name
-
-    @property
-    def db_name(self) -> str:
-        """Get database name."""
-        return self.__db_name
 
     async def get_leaf_path(self, key: str) -> Path:
         """Get the path to the database cell by key.
@@ -46,7 +41,7 @@ class Scruby(Generic[T]):  # noqa: UP046
         separated_md5: str = "/".join(list(key_md5))
         # The path of the branch to the database.
         branch_path: Path = Path(
-            *(self.__db_name, self.__class_model.__name__, separated_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():
@@ -135,8 +130,10 @@ class Scruby(Generic[T]):  # noqa: UP046
     async def napalm(self) -> None:
         """Asynchronous method for full database deletion (Arg: db_name).
 
+        The main purpose is tests.
+
         Warning:
             - `Be careful, this will remove all keys.`
         """
-        await to_thread.run_sync(rmtree, self.__db_name)
+        await to_thread.run_sync(rmtree, constants.DB_ROOT)
         return

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scruby
-Version: 0.4.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
@@ -97,31 +97,27 @@ uv add scruby
 import anyio
 import datetime
 from pydantic import BaseModel
-from scruby import Scruby
+from scruby import Scruby, constants
 
+constants.DB_ROOT = "ScrubyDB"  # By default = "ScrubyDB"
 
-async def main() -> None:
-    """Example."""
-
-  class User(BaseModel):
-      """User model."""
-
-      first_name: str
-      last_name: str
-      birthday: datetime.datetime
-      email: str
-      phone: str
+class User(BaseModel):
+    """Model of User."""
 
+    first_name: str
+    last_name: str
+    birthday: datetime.datetime
+    email: str
+    phone: str
 
-    db = Scruby(
-        class_model=User,
-        db_name="ScrubyDB",  # By default = "ScrubyDB"
-    )
+async def main() -> None:
+    """Example."""
+    db = Scruby(User)
 
     user = User(
         first_name="John",
         last_name="Smith",
-        birthday=datetime.datetime(1970, 1, 1),  # noqa: DTZ001
+        birthday=datetime.datetime(1970, 1, 1),
         email="John_Smith@gmail.com",
         phone="+447986123456",
     )
@@ -139,6 +135,7 @@ async def main() -> None:
     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.4.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-scruby/__init__.py,sha256=TCxUjBI5A0KZcwvfmgaBVl8ScuzzOVvALl_T4iqSR9c,603
-scruby/db.py,sha256=86e-U3IvNADoYhHv4PHGikqnH4KWVJEpu3d7oGuUc3s,4600
-scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scruby-0.4.0.dist-info/METADATA,sha256=Oi3khca39iX9qdOuF-SEMtT6rkbESwDS8Wy3Zhjo8-o,6512
-scruby-0.4.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-scruby-0.4.0.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
-scruby-0.4.0.dist-info/RECORD,,