scruby 0.15.1__py3-none-any.whl → 0.16.0__py3-none-any.whl

scruby/db.py

@@ -18,6 +18,10 @@ from anyio import Path, to_thread
 from pydantic import BaseModel
 
 from scruby import constants
+from scruby.errors import (
+    KeyAlreadyExistsError,
+    KeyNotExistsError,
+)
 
 logger = logging.getLogger(__name__)
 
@@ -175,36 +179,75 @@ class Scruby[T]:
         leaf_path: Path = Path(*(branch_path, "leaf.json"))
         return leaf_path
 
-    async def set_key(
+    async def add_key(
         self,
         key: str,
         value: T,
     ) -> None:
-        """Asynchronous method for adding and updating keys to collection.
+        """Asynchronous method for adding key to collection.
 
         Args:
-            key: Key name.
-            value: Value of key.
+            key: Key name. Type `str`.
+            value: Value of key. Type `BaseModel`.
 
         Returns:
             None.
         """
-        # The path to the database cell.
+        # The path to cell of collection.
         leaf_path: Path = await self._get_leaf_path(key)
         value_json: str = value.model_dump_json()
-        # Write key-value to the database.
+        # Write key-value to collection.
         if await leaf_path.exists():
-            # Add new key or update existing.
+            # Add new key.
             data_json: bytes = await leaf_path.read_bytes()
             data: dict = orjson.loads(data_json) or {}
-            if data.get(key) is None:
-                await self._counter_documents(1)
-            data[key] = value_json
-            await leaf_path.write_bytes(orjson.dumps(data))
+            try:
+                data[key]
+            except KeyError:
+                data[key] = value_json
+                await leaf_path.write_bytes(orjson.dumps(data))
+            else:
+                err = KeyAlreadyExistsError()
+                logger.error(err.message)
+                raise err
         else:
             # Add new key to a blank leaf.
             await leaf_path.write_bytes(orjson.dumps({key: value_json}))
-            await self._counter_documents(1)
+        await self._counter_documents(1)
+
+    async def update_key(
+        self,
+        key: str,
+        value: T,
+    ) -> None:
+        """Asynchronous method for updating key to collection.
+
+        Args:
+            key: Key name. Type `str`.
+            value: Value of key. Type `BaseModel`.
+
+        Returns:
+            None.
+        """
+        # The path to cell of collection.
+        leaf_path: Path = await self._get_leaf_path(key)
+        value_json: str = value.model_dump_json()
+        # Update the existing key.
+        if await leaf_path.exists():
+            # Update the existing key.
+            data_json: bytes = await leaf_path.read_bytes()
+            data: dict = orjson.loads(data_json) or {}
+            try:
+                data[key]
+                data[key] = value_json
+                await leaf_path.write_bytes(orjson.dumps(data))
+            except KeyError:
+                err = KeyNotExistsError()
+                logger.error(err.message)
+                raise err from None
+        else:
+            logger.error("The key not exists.")
+            raise KeyError()
 
     async def get_key(self, key: str) -> T:
         """Asynchronous method for getting value of key from collection.
@@ -236,7 +279,7 @@ class Scruby[T]:
         Returns:
             True, if the key is present.
         """
-        # The path to the database cell.
+        # Get path to cell of collection.
         leaf_path: Path = await self._get_leaf_path(key)
         # Checking whether there is a key.
         if await leaf_path.exists():

scruby/errors.py

@@ -21,3 +21,19 @@ class MetadataValueError(ScrubyException):
     def __init__(self, message: str) -> None:  # noqa: D107
         self.message = message
         super().__init__(self.message)
+
+
+class KeyAlreadyExistsError(ScrubyException):
+    """Exception is raised if the key already exists."""
+
+    def __init__(self) -> None:
+        self.message = "The key already exists."
+        super().__init__(self.message)
+
+
+class KeyNotExistsError(ScrubyException):
+    """Exception is raised If the key is not exists."""
+
+    def __init__(self) -> None:
+        self.message = "The key not exists."
+        super().__init__(self.message)

{scruby-0.15.1.dist-info → scruby-0.16.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scruby
-Version: 0.15.1
+Version: 0.16.0
 Summary: A fast key-value storage library.
 Project-URL: Homepage, https://github.com/kebasyaty/scruby
 Project-URL: Repository, https://github.com/kebasyaty/scruby
@@ -143,7 +143,9 @@ async def main() -> None:
         phone="+447986123456",
     )
 
-    await user_coll.set_key("+447986123456", user)
+    await user_coll.add_key(user.phone, user)
+
+    await user_coll.update_key(user.phone, user)
 
     await user_coll.get_key("+447986123456")  # => user
     await user_coll.get_key("key missing")  # => KeyError
@@ -209,7 +211,7 @@ async def main() -> None:
     )
 
     # Add user to collection.
-    await user_coll.set_key("+447986123456", user)
+    await user_coll.add_key(user.phone, user)
 
     # Find user by email.
     user_details: User | None = user_coll.find_one(
@@ -282,7 +284,7 @@ async def main() -> None:
             email=f"John_Smith_{num}@gmail.com",
             phone=f"+44798612345{num}",
         )
-        await db.set_key(f"+44798612345{num}", user)
+        await user_coll.add_key(user.phone, user)
 
     # Find users by email.
     users: list[User] | None = user_coll.find_many(

scruby-0.16.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+scruby/__init__.py,sha256=GOVcjXmcOEDBbJQJDJlQq-x3M-VGJaMSN278EXsl2po,884
+scruby/aggregation.py,sha256=_SUo9gL9yrtr94F-BNaBpuMkEfxtxtcvuOUqw7Ryygs,3466
+scruby/constants.py,sha256=3LZfcxcuRqwzoB0-iogLMjKBZRdxfWJmTbyPwVRhQgY,1007
+scruby/db.py,sha256=Oanc8M5JR33ffMS_MF5QebMZ8npQODeDgIttvFNcK8w,27079
+scruby/errors.py,sha256=enLprEqfj_B2HcuOiU2oObZ5wUKyjY1VhGifXz84wew,1081
+scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scruby-0.16.0.dist-info/METADATA,sha256=xDv8w7suhu6nLuWzWz--4OgMK3mOKXd_CtmKdtTWkq0,10962
+scruby-0.16.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+scruby-0.16.0.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
+scruby-0.16.0.dist-info/RECORD,,

scruby-0.15.1.dist-info/RECORD

@@ -1,10 +0,0 @@
-scruby/__init__.py,sha256=GOVcjXmcOEDBbJQJDJlQq-x3M-VGJaMSN278EXsl2po,884
-scruby/aggregation.py,sha256=_SUo9gL9yrtr94F-BNaBpuMkEfxtxtcvuOUqw7Ryygs,3466
-scruby/constants.py,sha256=3LZfcxcuRqwzoB0-iogLMjKBZRdxfWJmTbyPwVRhQgY,1007
-scruby/db.py,sha256=FNW_o2JDd_RnGpOdsEfSubMH8kcO7CSoej52y9vJwnc,25769
-scruby/errors.py,sha256=aHQri4LNcFVQrSHwjyzb1fL8O49SwjYEU4QgMOo4uyA,622
-scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scruby-0.15.1.dist-info/METADATA,sha256=shka5n94xxvbJ8FHWvMryCvzpEmrWyJ6Z2xzS4A0o9g,10925
-scruby-0.15.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-scruby-0.15.1.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
-scruby-0.15.1.dist-info/RECORD,,