scruby 2.0.2__py3-none-any.whl → 2.0.4__py3-none-any.whl

scruby/cache.py

@@ -7,7 +7,7 @@ __all__ = ("DocCache",)
 
 import string
 from pathlib import Path
-from typing import Any, ClassVar, Literal, Never, assert_never, final
+from typing import Any, ClassVar, Literal, final
 
 import orjson
 
@@ -35,8 +35,9 @@ class DocCache:
                 cls.cache[collection_name] = {
                     key: {key: {key: {} for key in hexdigits} for key in hexdigits} for key in hexdigits
                 }
-            case _ as unreachable:
-                assert_never(Never(unreachable))  # pyrefly: ignore[not-callable]
+            case _:
+                msg = "Scruby.run() > Parameter: `hash_reduce_left` -> Valid values are Literal[7, 6, 5]."
+                raise AssertionError(msg)
 
     @classmethod
     def load_cache(cls, subclasses: list[Any]) -> None:

scruby/mixins/count.py

@@ -34,7 +34,7 @@ class Count:
         self,
         filter_fn: Callable,
     ) -> int:
-        """Asynchronous method.
+        """Synchronous method.
 
         Count the number of documents a matching the filter in this collection.
 

scruby/mixins/delete.py

@@ -68,6 +68,9 @@ class Delete:
                             del DocCache.cache[collection_name][branch_number_as_hash[0]][branch_number_as_hash[1]][
                                 branch_number_as_hash[2]
                             ][doc_name]
+                        case _:
+                            msg = "Scruby.run() > Parameter: `hash_reduce_left` -> Valid values are Literal[7, 6, 5]."
+                            raise AssertionError(msg)
                 else:
                     new_state[doc_name] = doc_json
             await leaf_path.write_bytes(orjson.dumps(new_state))

scruby/mixins/find.py

@@ -68,6 +68,9 @@ class Find:
                 docs = DocCache.cache[collection_name][branch_number_as_hash[0]][branch_number_as_hash[1]][
                     branch_number_as_hash[2]
                 ]
+            case _:
+                msg = "Scruby.run() > Parameter: `hash_reduce_left` -> Valid values are Literal[7, 6, 5]."
+                raise AssertionError(msg)
 
         for _, doc in docs.items():
             if stop_event.is_set():

scruby/mixins/keys.py

@@ -79,6 +79,9 @@ class Keys:
                 DocCache.cache[collection_name][key_as_hash[0]][key_as_hash[1]][prepared_key] = doc
             case 5:
                 DocCache.cache[collection_name][key_as_hash[0]][key_as_hash[1]][key_as_hash[2]][prepared_key] = doc
+            case _:
+                msg = "Scruby.run() > Parameter: `hash_reduce_left` -> Valid values are Literal[7, 6, 5]."
+                raise AssertionError(msg)
 
     @final
     async def update_doc(self, doc: Any) -> None:
@@ -126,6 +129,9 @@ class Keys:
                         DocCache.cache[collection_name][key_as_hash[0]][key_as_hash[1]][key_as_hash[2]][
                             prepared_key
                         ] = doc
+                    case _:
+                        msg = "Scruby.run() > Parameter: `hash_reduce_left` -> Valid values are Literal[7, 6, 5]."
+                        raise AssertionError(msg)
             else:
                 raise KeyNotExistsError()
         else:
@@ -162,6 +168,9 @@ class Keys:
                 return DocCache.cache[collection_name][key_as_hash[0]][key_as_hash[1]].get(prepared_key)
             case 5:
                 return DocCache.cache[collection_name][key_as_hash[0]][key_as_hash[1]][key_as_hash[2]].get(prepared_key)
+            case _:
+                msg = "Scruby.run() > Parameter: `hash_reduce_left` -> Valid values are Literal[7, 6, 5]."
+                raise AssertionError(msg)
 
     @final
     def has_key(self, key: str) -> bool:
@@ -199,6 +208,9 @@ class Keys:
                     DocCache.cache[collection_name][key_as_hash[0]][key_as_hash[1]][key_as_hash[2]].get(prepared_key)
                     is not None
                 )
+            case _:
+                msg = "Scruby.run() > Parameter: `hash_reduce_left` -> Valid values are Literal[7, 6, 5]."
+                raise AssertionError(msg)
         return is_exists
 
     @final
@@ -234,6 +246,9 @@ class Keys:
                         del DocCache.cache[collection_name][key_as_hash[0]][key_as_hash[1]][key_as_hash[2]][
                             prepared_key
                         ]
+                    case _:
+                        msg = "Scruby.run() > Parameter: `hash_reduce_left` -> Valid values are Literal[7, 6, 5]."
+                        raise AssertionError(msg)
             else:
                 raise KeyNotExistsError()
         else:

scruby/mixins/update.py

@@ -74,6 +74,9 @@ class Update:
                             DocCache.cache[collection_name][branch_number_as_hash[0]][branch_number_as_hash[1]][
                                 branch_number_as_hash[2]
                             ][doc_name] = doc
+                        case _:
+                            msg = "Scruby.run() > Parameter: `hash_reduce_left` -> Valid values are Literal[7, 6, 5]."
+                            raise AssertionError(msg)
                     # Update counter
                     counter += 1
                 else:
@@ -88,7 +91,7 @@ class Update:
         new_data: dict[str, Any],
         filter_fn: Callable = lambda _: True,
     ) -> int:
-        """Asynchronous method for updates many documents matching the filter.
+        """Asynchronous method for updates one or more documents matching the filter.
 
         Attention:
             - For a complex case, a custom task may be needed.

{scruby-2.0.2.dist-info → scruby-2.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scruby
-Version: 2.0.2
+Version: 2.0.4
 Summary: Asynchronous library for building and managing a hybrid database, by scheme of key-value.
 Project-URL: Bug Tracker, https://github.com/kebasyaty/scruby/issues
 Project-URL: Changelog, https://github.com/kebasyaty/scruby/blob/v2/CHANGELOG.md
@@ -96,6 +96,10 @@ Description-Content-Type: text/markdown
 6 = 256 branches in collection -> ~256000+ docs (for small projects).
 <br>
 5 = 4096 branches in collection -> ~4096000+ docs (for large projects).
+<br>
+<br>
+<b>If you notice the production server slowing down,</b><br>
+<b>you will need to add RAM and CPU.</b>
 </p>
 
 <br>
@@ -137,7 +141,6 @@ from typing import Annotated
 from pydantic import EmailStr, Field
 from pydantic_extra_types.phone_numbers import PhoneNumber, PhoneNumberValidator
 from scruby import Scruby, ScrubyModel, ScrubyConfig
-from pprint import pprint as pp
 
 
 class User(ScrubyModel):
@@ -180,7 +183,6 @@ async def main() -> None:
 
     # Get user details
     user = user_coll.get_doc("+447986123456")
-    pp(user)
     user_coll.get_doc("key missing")  # => None
 
     # Check for the presence of a key in the collection
@@ -189,6 +191,21 @@ async def main() -> None:
     # Delete a document by key
     await user_coll.delete_doc("+447986123456")
 
+    # Get collection name
+    user_coll.collection_name()  # => User
+
+    # Get collection list
+    coll_list = await Scruby.collection_list()  # => ["User"]
+
+    # Get the number of documents in the collection from metadata
+    await user_coll.estimated_document_count()  # => 1
+
+    # Get the number of documents comparable to the filter
+    user_coll.count_documents(filter_fn=lambda doc: doc.first_name == "John") == 1
+
+    # Delete collection
+    await Scruby.delete_collection("User")
+
     # Full database deletion
     # Hint: The main purpose is tests
     Scruby.napalm()
@@ -208,7 +225,6 @@ The search effectiveness depends on the number of processor threads.
 import anyio
 from pydantic import Field
 from scruby import ReturnType, Scruby, ScrubyConfig, ScrubyModel
-from pprint import pprint as pp
 
 
 class Phone(ScrubyModel):
@@ -248,19 +264,11 @@ async def main() -> None:
     phone_details: Phone | None = phone_coll.find_one(
         filter_fn=lambda doc: doc.brand == "Samsung",
     )
-    if phone_details is not None:
-        pp(phone_details)
-    else:
-        print("No Phone!")
 
     # Find phone by model
     phone_details: Phone | None = phone_coll.find_one(
         filter_fn=lambda doc: doc.model == "Galaxy A26",
     )
-    if phone_details is not None:
-        pp(phone_details)
-    else:
-        print("No Phone!")
 
     # Return phone in JSON format
     phone_details: str | None = phone_coll.find_one(
@@ -268,7 +276,7 @@ async def main() -> None:
         return_type=ReturnType.JSON,
     )
 
-    # Return phone in Dict format
+    # Return phone in Dictionary format
     phone_details: dict | None = phone_coll.find_one(
         filter_fn=lambda doc: doc.model == "Galaxy A26",
         return_type=ReturnType.DICT,
@@ -294,7 +302,6 @@ import anyio
 from typing import Annotated
 from pydantic import Field
 from scruby import ReturnType, Scruby, ScrubyConfig, ScrubyModel
-from pprint import pprint as pp
 
 
 class Car(ScrubyModel):
@@ -331,19 +338,11 @@ async def main() -> None:
 
     # Find all cars
     car_list: list[Car] | None = car_coll.find_many()
-    if car_list is not None:
-        pp(car_list)
-    else:
-        print("No cars!")
 
     # Find cars by brand and year
     car_list: list[Car] | None = car_coll.find_many(
         filter_fn=lambda doc: doc.brand == "Mazda" and doc.year == 2025,
     )
-    if car_list is not None:
-        pp(car_list)
-    else:
-        print("No cars!")
 
     # Pagination
     car_list: list[Car] | None = car_coll.find_many(
@@ -351,10 +350,6 @@ async def main() -> None:
         limit_docs=5,
         page_number=2,
     )
-    if car_list is not None:
-        pp(car_list)
-    else:
-        print("No cars!")
 
     # Sorting
     car_list: list[Car] | None = car_coll.find_many(
@@ -362,10 +357,6 @@ async def main() -> None:
         sort_fn=lambda doc: (doc.brand, doc.updated_at),
         sort_reverse=True,
     )
-    if car_list is not None:
-        pp(car_list)
-    else:
-        print("No cars!")
 
     # Return cars in JSON format
     car_list: str | None = car_coll.find_many(
@@ -373,12 +364,23 @@ async def main() -> None:
         return_type=ReturnType.JSON,
     )
 
-    # Return cars in Dict format
+    # Return cars in Dictionary format
     car_list: list[dict] | None = car_coll.find_many(
         filter_fn=lambda doc: doc.brand == "Mazda",
         return_type=ReturnType.DICT,
     )
 
+    # Update one or more documents matching the filter
+    count_updated = await car_coll.update_many(
+        new_data={"brand": "BMW"},
+        filter_fn=lambda doc: doc.brand == "Mazda",
+    )
+
+    # Delete one or more documents matching the filter
+    count_deleted = await car_coll.delete_many(
+        filter_fn=lambda doc: doc.brand == "BMW",
+    )
+
     # Full database deletion
     # Hint: The main purpose is tests
     Scruby.napalm()

{scruby-2.0.2.dist-info → scruby-2.0.4.dist-info}/RECORD

@@ -1,6 +1,6 @@
 scruby/__init__.py,sha256=40UhjME7WRJ-kHmqju4tMx9t1t6Sq6-EtL1LwgbTbcA,1280
 scruby/aggregation.py,sha256=NBFxQqyRqUG2KIuD9fbl4uzSHJWTaskjiZ1YNBa-Zbo,3575
-scruby/cache.py,sha256=rwCnttMVTEjb813OGWFoMSu2likdqAvFw_9gRlcJGUA,3356
+scruby/cache.py,sha256=Et3NpeMDCNHa2B8H1El4QwIrlW4Cysf3ODeqkR2rGO4,3387
 scruby/config.py,sha256=RzCk4oLO4LeTQEuNljWKh9QxQ-6-mXmUpn9AmlpISCU,3514
 scruby/db.py,sha256=np6WFjjlXrDnA5nwRDb7Nscwvvn4r2CXvydXnRWeSS0,10194
 scruby/errors.py,sha256=lTWiHzyO5Es9Nkf7quODJjONGn6ifcL95qlpA4epQQM,1386
@@ -8,14 +8,14 @@ scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 scruby/utils.py,sha256=ZwWxSyh_BAOQkXlIqXFOlX2lHVk9rfYGQiVqtTk8PpE,1865
 scruby/mixins/__init__.py,sha256=nT79e80zXliuTGhR9CFosI2-3PQUCKwXbR7wPiFwgrU,669
 scruby/mixins/collection.py,sha256=VrFadQimpWLHaNcmS-dl6CC94CiOE2w_crxewOdZfvQ,1741
-scruby/mixins/count.py,sha256=asqDsKzjdZHiXybFYTSZje9yhum1atYkBzXddnC2Efw,2391
+scruby/mixins/count.py,sha256=1tcQVxIxjlMNDG2XbI9QHKNjo5FbMlezIA80l0UE3Ac,2390
 scruby/mixins/custom_task.py,sha256=MCelgM8GNBkO6INaWQ5h5NX53zrgV90QWIZDl8Ygmrw,1412
-scruby/mixins/delete.py,sha256=7m7s1NKlFCgVPGyiGcWqXGD_0esgPckdTicl0WTT_Wo,4053
-scruby/mixins/find.py,sha256=Wly-94cqnVizcw6YLfcog2ygxzSNrApEly_OjgG5pMk,8677
-scruby/mixins/keys.py,sha256=vZ_TdLjq0YYinoXocyVKbGSDvf3esPzJe2bIw8nFZrA,9695
-scruby/mixins/update.py,sha256=-gyPQrr358W5pPslI2ZTVAeP12IXvXqqxvt1dqSFmG0,4627
-scruby-2.0.2.dist-info/METADATA,sha256=2SotkEcbKEj0oY0tzmxNDc7nWCz4tdpR3XRlSznTyvQ,13009
-scruby-2.0.2.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
-scruby-2.0.2.dist-info/licenses/GPL-3.0-LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-scruby-2.0.2.dist-info/licenses/MIT-LICENSE,sha256=mS0Wz0yGNB63gEcWEnuIb_lldDYV0sjRaO-o_GL6CWE,1074
-scruby-2.0.2.dist-info/RECORD,,
+scruby/mixins/delete.py,sha256=Q-FPJGm6pqJzoyEdd48M8o_kwYdYWLoceRuzcNXc_uw,4258
+scruby/mixins/find.py,sha256=25LqXTHvzEIsB3KxUYGW-dOL_yYRBx7bVwcO5t9DPgo,8846
+scruby/mixins/keys.py,sha256=kI8F_Q0q_V7FnyQUn7RatRMj4UaBuARY1qxsS8ey8oM,10588
+scruby/mixins/update.py,sha256=syRUy2MvxKcUAjqn9ZTXzl3KGWO2PUbQoI0NeiAW-Bg,4839
+scruby-2.0.4.dist-info/METADATA,sha256=WQQxRqWC5dS__uqQoUN1bdDEBUFsM0HWRim4H93oj2E,13335
+scruby-2.0.4.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+scruby-2.0.4.dist-info/licenses/GPL-3.0-LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+scruby-2.0.4.dist-info/licenses/MIT-LICENSE,sha256=mS0Wz0yGNB63gEcWEnuIb_lldDYV0sjRaO-o_GL6CWE,1074
+scruby-2.0.4.dist-info/RECORD,,