scruby 0.10.3__py3-none-any.whl → 0.24.4__py3-none-any.whl

scruby/mixins/update.py

@@ -0,0 +1,104 @@
+"""Methods for updating documents."""
+
+from __future__ import annotations
+
+__all__ = ("Update",)
+
+import concurrent.futures
+import logging
+from collections.abc import Callable
+from typing import Any, TypeVar
+
+import orjson
+from anyio import Path
+
+logger = logging.getLogger(__name__)
+
+T = TypeVar("T")
+
+
+class Update[T]:
+    """Methods for updating documents."""
+
+    @staticmethod
+    async def _task_update(
+        branch_number: int,
+        filter_fn: Callable,
+        hash_reduce_left: str,
+        db_root: str,
+        class_model: T,
+        new_data: dict[str, Any],
+    ) -> int:
+        """Task for find documents.
+
+        This method is for internal use.
+
+        Returns:
+            The number of updated documents.
+        """
+        branch_number_as_hash: str = f"{branch_number:08x}"[hash_reduce_left:]
+        separated_hash: str = "/".join(list(branch_number_as_hash))
+        leaf_path: Path = Path(
+            *(
+                db_root,
+                class_model.__name__,
+                separated_hash,
+                "leaf.json",
+            ),
+        )
+        counter: int = 0
+        if await leaf_path.exists():
+            data_json: bytes = await leaf_path.read_bytes()
+            data: dict[str, str] = orjson.loads(data_json) or {}
+            new_state: dict[str, str] = {}
+            for _, val in data.items():
+                doc = class_model.model_validate_json(val)
+                if filter_fn(doc):
+                    for key, value in new_data.items():
+                        doc.__dict__[key] = value
+                        new_state[key] = doc.model_dump_json()
+                    counter += 1
+            await leaf_path.write_bytes(orjson.dumps(new_state))
+        return counter
+
+    async def update_many(
+        self,
+        filter_fn: Callable,
+        new_data: dict[str, Any],
+        max_workers: int | None = None,
+    ) -> int:
+        """Updates one or more documents matching the filter.
+
+        The search is based on the effect of a quantum loop.
+        The search effectiveness depends on the number of processor threads.
+        Ideally, hundreds and even thousands of threads are required.
+
+        Args:
+            filter_fn: A function that execute the conditions of filtering.
+            new_data: New data for the fields that need to be updated.
+            max_workers: The maximum number of processes that can be used to
+                         execute the given calls. If None or not given then as many
+                         worker processes will be created as the machine has processors.
+
+        Returns:
+            The number of updated documents.
+        """
+        branch_numbers: range = range(1, self._max_branch_number)
+        update_task_fn: Callable = self._task_update
+        hash_reduce_left: int = self._hash_reduce_left
+        db_root: str = self._db_root
+        class_model: T = self._class_model
+        counter: int = 0
+        with concurrent.futures.ThreadPoolExecutor(max_workers) as executor:
+            for branch_number in branch_numbers:
+                future = executor.submit(
+                    update_task_fn,
+                    branch_number,
+                    filter_fn,
+                    hash_reduce_left,
+                    db_root,
+                    class_model,
+                    new_data,
+                )
+                counter += await future.result()
+        return counter

{scruby-0.10.3.dist-info → scruby-0.24.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scruby
-Version: 0.10.3
+Version: 0.24.4
 Summary: A fast key-value storage library.
 Project-URL: Homepage, https://github.com/kebasyaty/scruby
 Project-URL: Repository, https://github.com/kebasyaty/scruby
@@ -21,6 +21,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Topic :: Database
 Classifier: Typing :: Typed
@@ -43,7 +44,7 @@ Description-Content-Type: text/markdown
   </p>
   <p>
     <h1>Scruby</h1>
-    <h3>A fast key-value storage library.</h3>
+    <h3>Asynchronous library for building and managing a hybrid database,<br>by scheme of key-value.</h3>
     <p align="center">
       <a href="https://github.com/kebasyaty/scruby/actions/workflows/test.yml" alt="Build Status"><img src="https://github.com/kebasyaty/scruby/actions/workflows/test.yml/badge.svg" alt="Build Status"></a>
       <a href="https://kebasyaty.github.io/scruby/" alt="Docs"><img src="https://img.shields.io/badge/docs-available-brightgreen.svg" alt="Docs"></a>
@@ -51,34 +52,30 @@ Description-Content-Type: text/markdown
       <a href="https://pypi.python.org/pypi/scruby/" alt="PyPI status"><img src="https://img.shields.io/pypi/status/scruby.svg" alt="PyPI status"></a>
       <a href="https://pypi.python.org/pypi/scruby/" alt="PyPI version fury.io"><img src="https://badge.fury.io/py/scruby.svg" alt="PyPI version fury.io"></a>
       <br>
-      <a href="https://github.com/kebasyaty/scruby/issues"><img src="https://img.shields.io/github/issues/kebasyaty/scruby.svg" alt="GitHub issues"></a>
-      <a href="https://pepy.tech/projects/scruby"><img src="https://static.pepy.tech/badge/scruby" alt="PyPI Downloads"></a>
-      <a href="https://github.com/kebasyaty/scruby/blob/main/LICENSE" alt="GitHub license"><img src="https://img.shields.io/github/license/kebasyaty/scruby" alt="GitHub license"></a>
       <a href="https://mypy-lang.org/" alt="Types: Mypy"><img src="https://img.shields.io/badge/types-Mypy-202235.svg?color=0c7ebf" alt="Types: Mypy"></a>
       <a href="https://docs.astral.sh/ruff/" alt="Code style: Ruff"><img src="https://img.shields.io/badge/code%20style-Ruff-FDD835.svg" alt="Code style: Ruff"></a>
-      <a href="https://github.com/kebasyaty/scruby" alt="PyPI implementation"><img src="https://img.shields.io/pypi/implementation/scruby" alt="PyPI implementation"></a>
-      <br>
       <a href="https://pypi.org/project/scruby"><img src="https://img.shields.io/pypi/format/scruby" alt="Format"></a>
-      <a href="https://github.com/kebasyaty/scruby"><img src="https://img.shields.io/github/languages/top/kebasyaty/scruby" alt="Top"></a>
-      <a href="https://github.com/kebasyaty/scruby"><img src="https://img.shields.io/github/repo-size/kebasyaty/scruby" alt="Size"></a>
-      <a href="https://github.com/kebasyaty/scruby"><img src="https://img.shields.io/github/last-commit/kebasyaty/scruby/main" alt="Last commit"></a>
-      <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>
+      <a href="https://pepy.tech/projects/scruby"><img src="https://static.pepy.tech/badge/scruby" alt="PyPI Downloads"></a>
+      <a href="https://github.com/kebasyaty/scruby/blob/main/LICENSE" alt="GitHub license"><img src="https://img.shields.io/github/license/kebasyaty/scruby" alt="GitHub license"></a>
     </p>
     <p align="center">
-      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>
-      The database consists of collections.
-      <br>
-      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 in collection can be obtained in 8 steps, thereby achieving high performance.
-      <br>
-      In the future, to search by value of key, the use of a quantum loop is supposed.
+        The library uses fractal-tree addressing and
+        <br>
+        the search for documents based on the effect of a quantum loop.
+        <br>
+        The database consists of collections.
+        <br>
+        The maximum size of the one collection is 16\*\*8=4294967296 branches,
+        <br>
+        each branch can store one or more keys.
+        <br>
+        The value of any key in collection can be obtained in 8 steps,
+        <br>
+        thereby achieving high performance.
+        <br>
+        The effectiveness of the search for documents based on a quantum loop,
+        <br>
+        requires a large number of processor threads.
     </p>
   </p>
 </div>
@@ -116,6 +113,7 @@ from pydantic_extra_types.phone_numbers import PhoneNumber, PhoneNumberValidator
 from scruby import Scruby, constants
 
 constants.DB_ROOT = "ScrubyDB"  # By default = "ScrubyDB"
+constants.HASH_REDUCE_LEFT = 6  # By default = 6
 
 class User(BaseModel):
     """Model of User."""
@@ -125,10 +123,11 @@ class User(BaseModel):
     email: EmailStr
     phone: Annotated[PhoneNumber, PhoneNumberValidator(number_format="E164")]
 
+
 async def main() -> None:
     """Example."""
     # Get collection of `User`.
-    user_coll = Scruby(User)
+    user_coll = await Scruby.create(User)
 
     user = User(
         first_name="John",
@@ -138,7 +137,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
@@ -152,7 +153,8 @@ async def main() -> None:
 
     # Full database deletion.
     # Hint: The main purpose is tests.
-    await Scruby.napalm()
+    Scruby.napalm()
+
 
 if __name__ == "__main__":
     anyio.run(main)
@@ -169,61 +171,61 @@ Ideally, hundreds and even thousands of threads are required.
 import anyio
 import datetime
 from typing import Annotated
-from pydantic import BaseModel, EmailStr
-from pydantic_extra_types.phone_numbers import PhoneNumber, PhoneNumberValidator
+from pydantic import BaseModel
 from scruby import Scruby, constants
 from pprint import pprint as pp
 
 constants.DB_ROOT = "ScrubyDB"  # By default = "ScrubyDB"
-constants.LENGTH_REDUCTION_HASH = 6  # 256 branches in collection
-                                     # (main purpose is tests).
+constants.HASH_REDUCE_LEFT = 6  # By default = 6
+
+
+class Phone(BaseModel):
+    """Phone model."""
+    brand: str
+    model: str
+    screen_diagonal: float
+    matrix_type: str
 
-class User(BaseModel):
-    """Model of User."""
-    first_name: str
-    last_name: str
-    birthday: datetime.datetime
-    email: EmailStr
-    phone: Annotated[PhoneNumber, PhoneNumberValidator(number_format="E164")]
 
 async def main() -> None:
     """Example."""
-    # Get collection of `User`.
-    user_coll = Scruby(User)
-
-    # Create user.
-    user = User(
-        first_name="John",
-        last_name="Smith",
-        birthday=datetime.datetime(1970, 1, 1),
-        email="John_Smith@gmail.com",
-        phone="+447986123456",
+    # Get collection of `Phone`.
+    phone_coll = await Scruby.create(Phone)
+
+    # Create phone.
+    phone = Phone(
+        brand="Samsung",
+        model="Galaxy A26",
+        screen_diagonal=6.7,
+        matrix_type="Super AMOLED",
     )
 
-    # Add user to collection.
-    await user_coll.set_key("+447986123456", user)
+    # Add phone to collection.
+    key = f"{phone.brand} {phone.model}"
+    await phone_coll.add_key(key, phone)
 
-    # Find user by email.
-    user_details: User | None = user_coll.find_one(
-        filter_fn=lambda doc: doc.email == "John_Smith@gmail.com",
+    # Find phone by brand.
+    phone_details: Phone | None = await phone_coll.find_one(
+        filter_fn=lambda doc: doc.brand == "Samsung",
     )
-    if user_details is not None:
-        pp(user_details)
+    if phone_details is not None:
+        pp(phone_details)
     else:
-        print("No User!")
+        print("No Phone!")
 
-    # Find user by birthday.
-    user_details: User | None = user_coll.find_one(
-        filter_fn=lambda doc: doc.birthday == datetime.datetime(1970, 1, 1),
+    # Find phone by model.
+    phone_details: Phone | None = await phone_coll.find_one(
+        filter_fn=lambda doc: doc.model == "Galaxy A26",
     )
-    if user_details is not None:
-        pp(user_details)
+    if phone_details is not None:
+        pp(phone_details)
     else:
-        print("No User!")
+        print("No Phone!")
 
     # Full database deletion.
     # Hint: The main purpose is tests.
-    await Scruby.napalm()
+    Scruby.napalm()
+
 
 if __name__ == "__main__":
     anyio.run(main)
@@ -240,51 +242,55 @@ Ideally, hundreds and even thousands of threads are required.
 import anyio
 import datetime
 from typing import Annotated
-from pydantic import BaseModel, EmailStr
-from pydantic_extra_types.phone_numbers import PhoneNumber, PhoneNumberValidator
+from pydantic import BaseModel
 from scruby import Scruby, constants
 from pprint import pprint as pp
 
 constants.DB_ROOT = "ScrubyDB"  # By default = "ScrubyDB"
-constants.LENGTH_REDUCTION_HASH = 6  # 256 branches in collection
-                                     # (main purpose is tests).
+constants.HASH_REDUCE_LEFT = 6  # By default = 6
+
+
+class Car(BaseModel):
+    """Car model."""
+    brand: str
+    model: str
+    year: int
+    power_reserve: int
 
-class User(BaseModel):
-    """Model of User."""
-    first_name: str
-    last_name: str
-    birthday: datetime.datetime
-    email: EmailStr
-    phone: Annotated[PhoneNumber, PhoneNumberValidator(number_format="E164")]
 
 async def main() -> None:
     """Example."""
-    # Get collection of `User`.
-    user_coll = Scruby(User)
-
-    # Create users.
-    for num in range(1, 10):
-        user = User(
-            first_name="John",
-            last_name="Smith",
-            birthday=datetime.datetime(1970, 1, num),
-            email=f"John_Smith_{num}@gmail.com",
-            phone=f"+44798612345{num}",
+    # Get collection of `Car`.
+    car_coll = await Scruby.create(Car)
+
+    # Create cars.
+    for name in range(1, 10):
+        car = Car(
+            brand="Mazda",
+            model=f"EZ-6 {num}",
+            year=2025,
+            power_reserve=600,
         )
-        await db.set_key(f"+44798612345{num}", user)
+        key = f"{car.brand} {car.model}"
+        await car_coll.add_key(key, car)
 
-    # Find users by email.
-    users: list[User] | None = user_coll.find(
-        filter_fn=lambda doc: doc.email == "John_Smith_5@gmail.com" or doc.email == "John_Smith_8@gmail.com",
+    # Find cars by brand and year.
+    car_list: list[Car] | None = await car_coll.find_many(
+        filter_fn=lambda doc: doc.brand == "Mazda" or doc.year == 2025,
     )
-    if users is not None:
-        pp(users)
+    if car_list is not None:
+        pp(car_list)
     else:
-        print("No users!")
+        print("No cars!")
+
+    # Get collection list.
+    collection_list = await Scruby.collection_list()
+    print(ucollection_list)  # ["Car"]
 
     # Full database deletion.
     # Hint: The main purpose is tests.
-    await Scruby.napalm()
+    Scruby.napalm()
+
 
 if __name__ == "__main__":
     anyio.run(main)

scruby-0.24.4.dist-info/RECORD

@@ -0,0 +1,18 @@
+scruby/__init__.py,sha256=elrW_AWMyl3kuTpEqGPaYFSpF8iVzjpivF6MxVNlqoQ,855
+scruby/aggregation.py,sha256=SYGcnMy2eq9vJb-pW3xR9LLAQIQ55TK-LGW_yKQ-7sU,3318
+scruby/constants.py,sha256=KInSZ_4dsQNXilrs7DvtQXevKEYibnNzl69a7XiWG4k,1099
+scruby/db.py,sha256=ggYW4dQPtr7m9-GM4QeYMMDZm5eUYN5bTAdz2Tj0hlw,5980
+scruby/errors.py,sha256=aj1zQlfxGwZC-bZZ07DRX2vHx31SpyWPqXHMpQ9kRVY,1124
+scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scruby/mixins/__init__.py,sha256=-rRZE-JZwGmEkC0wS_X0hs8OXsEYyvgSNIfil8wmjFA,454
+scruby/mixins/collection.py,sha256=eMnfHFdzk7LWILMmDbzugcOYSeIKp0DlEEqCmmGQRwA,1222
+scruby/mixins/count.py,sha256=Wcn6CeWrYSgsTTmYQ4J-CEiM4630rUSwRP9iKwbCl6c,2193
+scruby/mixins/custom_task.py,sha256=Ib1G1I7NyDGbow4SeafkYd9C0r6u6EDgUK0NxjhsEa0,2297
+scruby/mixins/delete.py,sha256=BmfQH68iX7kzC20w16xzFcLO3uLxYKdNyqZqIbXb1M0,3240
+scruby/mixins/find.py,sha256=va1hTm6Poua7_TMcZW2iqI-xmL1HcCUOx8pkKvTvu6U,5063
+scruby/mixins/keys.py,sha256=Hbb0AX68ph--fA43AXDWoM72PzSmS48h3iVwlQwQH0c,4971
+scruby/mixins/update.py,sha256=A9V4PjA3INnqLTGoBxIvC8y8Wo-nLxlFejkPUhsebzQ,3428
+scruby-0.24.4.dist-info/METADATA,sha256=RDE0Fa_IXd2hx2MDjdsI-5iwGhZOCZ9zOqqQuOe8k5g,9643
+scruby-0.24.4.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+scruby-0.24.4.dist-info/licenses/LICENSE,sha256=mS0Wz0yGNB63gEcWEnuIb_lldDYV0sjRaO-o_GL6CWE,1074
+scruby-0.24.4.dist-info/RECORD,,

{scruby-0.10.3.dist-info → scruby-0.24.4.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any

{scruby-0.10.3.dist-info → scruby-0.24.4.dist-info}/licenses/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Gennady Kostyunin
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2025 Gennady Kostyunin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

scruby-0.10.3.dist-info/RECORD

@@ -1,9 +0,0 @@
-scruby/__init__.py,sha256=wFwUS1KcLxfIopXOVS8gPue9fNzIIU2cVj_RgK5drz4,849
-scruby/constants.py,sha256=GbB-O0qaVdi5EHUp-zRAppFXLR-oHxpXUFVAOCpS0C8,1022
-scruby/db.py,sha256=J14Xjyc6iyb-cwBKiH8rJuioEHoYfNkLTezzvQBsJng,16181
-scruby/errors.py,sha256=4G0zNVzulBE9mM2iJLdg0EXP_W8n-L6EjZrkCCErvAU,574
-scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scruby-0.10.3.dist-info/METADATA,sha256=JGgVH8QKtA-iGifWhNdSczfuglIT2RRw5njRuNKvG3M,10829
-scruby-0.10.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-scruby-0.10.3.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
-scruby-0.10.3.dist-info/RECORD,,