scruby-dict 0.3.0__py3-none-any.whl

scruby_dict/__init__.py

@@ -0,0 +1,9 @@
+# Copyright (c) 2026 Gennady Kostyunin
+# SPDX-License-Identifier: MIT
+"""Scruby-Dict - In search methods, returns result as dictionaries."""
+
+from __future__ import annotations
+
+__all__ = ("ReturnDict",)
+
+from scruby_dict.plugin import ReturnDict

scruby_dict/plugin.py

@@ -0,0 +1,166 @@
+# Scruby-Dict - In search methods, returns result as dictionaries.
+# Copyright (c) 2026 Gennady Kostyunin
+# SPDX-License-Identifier: MIT
+"""Scruby-Dict Plugin."""
+
+from __future__ import annotations
+
+__all__ = ("ReturnDict",)
+
+
+import concurrent.futures
+from collections.abc import Callable
+from typing import Any, final
+
+import orjson
+from anyio import Path
+from scruby import Scruby
+from scruby_plugin import ScrubyPlugin
+
+
+class ReturnDict(ScrubyPlugin):
+    """Scruby-Dict Plugin.
+
+    In search methods, returns result as dictionaries.
+    """
+
+    def __init__(self, scruby_self: Scruby) -> None:  # noqa: D107
+        ScrubyPlugin.__init__(self, scruby_self)
+
+    @final
+    @staticmethod
+    async def _task_find(
+        branch_number: int,
+        filter_fn: Callable,
+        hash_reduce_left: int,
+        db_root: str,
+        class_model: Any,
+    ) -> list[dict[str, Any]] | None:
+        """Task for find documents.
+
+        This method is for internal use.
+
+        Returns:
+            List of documents as dictionaries or None.
+        """
+        branch_number_as_hash: str = f"{branch_number:08x}"[hash_reduce_left:]
+        separated_hash: str = "/".join(list(branch_number_as_hash))
+        leaf_path = Path(
+            *(
+                db_root,
+                class_model.__name__,
+                separated_hash,
+                "leaf.json",
+            ),
+        )
+        docs: list[dict[str, Any]] = []
+        if await leaf_path.exists():
+            data_json: bytes = await leaf_path.read_bytes()
+            data: dict[str, str] = orjson.loads(data_json) or {}
+            for _, val in data.items():
+                doc = class_model.model_validate_json(val)
+                if filter_fn(doc):
+                    docs.append(doc.model_dump())
+        return docs or None
+
+    @final
+    async def find_one(
+        self,
+        filter_fn: Callable,
+    ) -> dict[str, Any] | None:
+        """Asynchronous method for find one document matching the filter.
+
+        Attention:
+            - The search is based on the effect of a quantum loop.
+            - The search effectiveness depends on the number of processor threads.
+
+        Args:
+            filter_fn (Callable): A function that execute the conditions of filtering.
+
+        Returns:
+            One document as dictionary or None.
+        """
+        # Get Scruby instance
+        scruby_self = self.scruby_self()
+        # Variable initialization
+        search_task_fn: Callable = self._task_find
+        branch_numbers: range = range(scruby_self._max_number_branch)
+        hash_reduce_left: int = scruby_self._hash_reduce_left
+        db_root: str = scruby_self._db_root
+        class_model: Any = scruby_self._class_model
+        # Run quantum loop
+        with concurrent.futures.ThreadPoolExecutor(scruby_self._max_workers) as executor:
+            for branch_number in branch_numbers:
+                future = executor.submit(
+                    search_task_fn,
+                    branch_number,
+                    filter_fn,
+                    hash_reduce_left,
+                    db_root,
+                    class_model,
+                )
+                docs = await future.result()
+                if docs is not None:
+                    return docs[0]
+        return None
+
+    @final
+    async def find_many(
+        self,
+        filter_fn: Callable = lambda _: True,
+        limit_docs: int = 100,
+        page_number: int = 1,
+    ) -> list[dict[str, Any]] | None:
+        """Asynchronous method for find many documents matching the filter.
+
+        Attention:
+            - The search is based on the effect of a quantum loop.
+            - The search effectiveness depends on the number of processor threads.
+
+        Args:
+            filter_fn (Callable): A function that execute the conditions of filtering.
+                                  By default it searches for all documents.
+            limit_docs (int): Limiting the number of documents. By default = 100.
+            page_number (int): For pagination. By default = 1.
+                               Number of documents per page = limit_docs.
+
+        Returns:
+            List of documents as dictionaries or None.
+        """
+        # The `page_number` parameter must not be less than one
+        assert page_number > 0, "`find_many` => The `page_number` parameter must not be less than one."
+        # Get Scruby instance
+        scruby_self = self.scruby_self()
+        # Variable initialization
+        search_task_fn: Callable = self._task_find
+        branch_numbers: range = range(scruby_self._max_number_branch)
+        hash_reduce_left: int = scruby_self._hash_reduce_left
+        db_root: str = scruby_self._db_root
+        class_model: Any = scruby_self._class_model
+        counter: int = 0
+        number_docs_skippe: int = limit_docs * (page_number - 1) if page_number > 1 else 0
+        result: list[dict[str, Any]] = []
+        # Run quantum loop
+        with concurrent.futures.ThreadPoolExecutor(scruby_self._max_workers) as executor:
+            for branch_number in branch_numbers:
+                if number_docs_skippe == 0 and counter >= limit_docs:
+                    return result[:limit_docs]
+                future = executor.submit(
+                    search_task_fn,
+                    branch_number,
+                    filter_fn,
+                    hash_reduce_left,
+                    db_root,
+                    class_model,
+                )
+                docs = await future.result()
+                if docs is not None:
+                    for doc in docs:
+                        if number_docs_skippe == 0:
+                            if counter >= limit_docs:
+                                return result[:limit_docs]
+                            result.append(doc)
+                            counter += 1
+                        else:
+                            number_docs_skippe -= 1
+        return result or None

scruby_dict-0.3.0.dist-info/METADATA

@@ -0,0 +1,159 @@
+Metadata-Version: 2.4
+Name: scruby-dict
+Version: 0.3.0
+Summary: Plugin for Scruby - In search methods, returns results in the form of dictionaries.
+Project-URL: Bug Tracker, https://github.com/kebasyaty/scruby-dict/issues
+Project-URL: Changelog, https://github.com/kebasyaty/scruby-dict/blob/v0/CHANGELOG.md
+Project-URL: Homepage, https://kebasyaty.github.io/scruby-dict/
+Project-URL: Repository, https://github.com/kebasyaty/scruby-dict
+Project-URL: Source, https://github.com/kebasyaty/scruby-dict
+Author-email: kebasyaty <kebasyaty@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: database,dictionary,plugin,scruby
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+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: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: <4.0,>=3.12
+Requires-Dist: anyio>=4.12.1
+Requires-Dist: scruby-plugin>=0.3.6
+Description-Content-Type: text/markdown
+
+<div align="center">
+  <p align="center">
+    <a href="https://github.com/kebasyaty/scruby-dict">
+      <img
+        height="80"
+        alt="Logo"
+        src="https://raw.githubusercontent.com/kebasyaty/scruby-dict/main/assets/logo.svg">
+    </a>
+  </p>
+  <p>
+    <h1>scruby-dict</h1>
+    <h3>Plugin for Scruby - In search methods, returns result as dictionaries.</h3>
+    <p align="center">
+      <a href="https://github.com/kebasyaty/scruby-dict/actions/workflows/test.yml" alt="Build Status"><img src="https://github.com/kebasyaty/scruby-dict/actions/workflows/test.yml/badge.svg" alt="Build Status"></a>
+      <a href="https://kebasyaty.github.io/scruby-dict/" alt="Docs"><img src="https://img.shields.io/badge/docs-available-brightgreen.svg" alt="Docs"></a>
+      <a href="https://pypi.python.org/pypi/scruby-dict/" alt="PyPI pyversions"><img src="https://img.shields.io/pypi/pyversions/scruby-dict.svg" alt="PyPI pyversions"></a>
+      <a href="https://pypi.python.org/pypi/scruby-dict/" alt="PyPI status"><img src="https://img.shields.io/pypi/status/scruby-dict.svg" alt="PyPI status"></a>
+      <a href="https://pypi.python.org/pypi/scruby-dict/" alt="PyPI version fury.io"><img src="https://badge.fury.io/py/scruby-dict.svg" alt="PyPI version fury.io"></a>
+      <br>
+      <a href="https://pyrefly.org/" alt="Types: Pyrefly"><img src="https://img.shields.io/badge/types-Pyrefly-FFB74D.svg" alt="Types: Pyrefly"></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://pypi.org/project/scruby-dict"><img src="https://img.shields.io/pypi/format/scruby-dict" alt="Format"></a>
+      <a href="https://pepy.tech/projects/scruby-dict"><img src="https://static.pepy.tech/badge/scruby-dict" alt="PyPI Downloads"></a>
+      <a href="https://github.com/kebasyaty/scruby-dict/blob/main/LICENSE" alt="GitHub license"><img src="https://img.shields.io/github/license/kebasyaty/scruby-dict" alt="GitHub license"></a>
+    </p>
+    <p align="center">
+      Scruby-Dict is a plugin for the <a href="https://pypi.org/project/scruby/" alt="Scruby">Scruby</a> project.
+    </p>
+  </p>
+</div>
+
+##
+
+<br>
+
+[![Documentation](https://raw.githubusercontent.com/kebasyaty/scruby-dict/v0/assets/links/documentation.svg "Documentation")](https://kebasyaty.github.io/scruby-dict/ "Documentation")
+
+[![Requirements](https://raw.githubusercontent.com/kebasyaty/scruby-dict/v0/assets/links/requirements.svg "Requirements")](https://github.com/kebasyaty/scruby-dict/blob/v0/REQUIREMENTS.md "Requirements")
+
+## Installation
+
+```shell
+uv add scruby-dict
+```
+
+## Usage
+
+[![Examples](https://raw.githubusercontent.com/kebasyaty/scruby-dict/v0/assets/links/examples.svg "Examples")](https://kebasyaty.github.io/scruby-dict/latest/pages/usage/ "Examples")
+
+```python
+import anyio
+from typing import Any
+from pydantic import Field
+from scruby import Scruby, ScrubyModel, ScrubySettings
+from scruby_dict import ReturnDict
+from pprint import pprint as pp
+
+# Plugins connection.
+ScrubySettings.plugins = [
+    ReturnDict,
+]
+
+
+class Car(ScrubyModel):
+    """Car model."""
+    brand: str = Field(strict=True, frozen=True)
+    model: str = Field(strict=True, frozen=True)
+    year: int = Field(strict=True, frozen=True)
+    power_reserve: int = Field(strict=True, frozen=True)
+    description: str = Field(strict=True)
+    # key is always at bottom
+    key: str = Field(
+        strict=True,
+        frozen=True,
+        default_factory=lambda data: f"{data['brand']}:{data['model']}",
+    )
+
+
+async def main() -> None:
+    """Example."""
+    # Get collection `Car`
+    car_coll = await Scruby.collection(Car)
+    # Create cars.
+    for num in range(1, 10):
+        car = Car(
+            brand="Mazda",
+            model=f"EZ-6 {num}",
+            year=2025,
+            power_reserve=600,
+            description="Electric cars are the future of the global automotive industry.",
+        )
+        await car_coll.add_doc(car)
+
+    # Find one car
+    car_dict: dict[str, Any] | None = await car_coll.plugins.returnDict.find_one(c
+        filter_fn=lambda doc: doc.brand == "Mazda" and doc.model == "EZ-6 9",
+    )
+    if car_dict is not None:
+      pp(car_dict)
+    else:
+      print("Not Found")
+
+    # Fand many cars
+    car_list: list[dict[str, Any]] | None = await car_coll.plugins.returnDict.find_many(
+        filter_fn=lambda doc: doc.brand == "Mazda",
+    )
+    if car_list is not None:
+      pp(car_list)
+    else:
+      print("Not Found")
+
+    # Full database deletion.
+    # Hint: The main purpose is tests.
+    Scruby.napalm()
+
+
+if __name__ == "__main__":
+    anyio.run(main)
+```
+
+<br>
+
+[![Changelog](https://raw.githubusercontent.com/kebasyaty/scruby-dict/v0/assets/links/changelog.svg "Changelog")](https://github.com/kebasyaty/scruby-dict/blob/v0/CHANGELOG.md "Changelog")
+
+[![GPL-3.0](https://raw.githubusercontent.com/kebasyaty/scruby-dict/v0/assets/links/mit.svg "MIT")](https://github.com/kebasyaty/scruby-dict/blob/main/LICENSE "MIT")

scruby_dict-0.3.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+scruby_dict/__init__.py,sha256=-11wZwiS0eCInhbWWhFdHXM5-_BCpxr9fJDBT-XRHKU,247
+scruby_dict/plugin.py,sha256=6RLmXaY8f473j2KKOn6MrlWpxOQt9SwgDiTaiNBVuuo,5957
+scruby_dict/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scruby_dict-0.3.0.dist-info/METADATA,sha256=PwWWZM9TbIH76hc9VNimTEJFQxXkHIc5GmumUzGh1rM,6616
+scruby_dict-0.3.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+scruby_dict-0.3.0.dist-info/licenses/LICENSE,sha256=mvh5qv1YJGyuVCkRxonDDNOzxlwXszKvwxXfOeXKrqw,1074
+scruby_dict-0.3.0.dist-info/RECORD,,

scruby_dict-0.3.0.dist-info/WHEEL

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

scruby_dict-0.3.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 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.