scruby 2.6.2__py3-none-any.whl → 2.6.4__py3-none-any.whl

scruby/mixins/find.py

@@ -19,7 +19,7 @@ from scruby.cache import DocCache
 
 
 class ReturnType(Enum):
-    """Return type.
+    """Return type for a find_one and find_many methods.
 
     Members:
         - `MODEL:` ScrubyModel type.
@@ -82,6 +82,8 @@ class Find:
     def find_one(
         self,
         filter_fn: Callable,
+        include_fields: set[str] | None = None,
+        exclude_fields: set[str] | None = None,
         return_type: ReturnType = ReturnType.MODEL,
     ) -> Any | None:
         """Synchronous method for find one document matching the filter.
@@ -92,6 +94,10 @@ class Find:
 
         Args:
             filter_fn (Callable): A function that execute the conditions of filtering.
+            include_fields: (set[str] | None): A set of fields to include in the output.
+                                               Available for `ReturnType.JSON` and `ReturnType.DICT`.
+            exclude_fields: (set[str] | None): A set of fields to exclude from the output.
+                                               Available for `ReturnType.JSON` and `ReturnType.DICT`.
             return_type (ReturnType): ScrubyModel, JSON-string or Dictionary.
 
         Returns:
@@ -101,6 +107,7 @@ class Find:
         hash_reduce_left: int = self._hash_reduce_left
         assert hash_reduce_left != 0, "Scruby.run(hash_reduce_left = 0) - Not valid for `find_one` method."
 
+        model_dump_kwargs = {"include": include_fields, "exclude": exclude_fields}
         search_task_fn: Callable = self._task_find
         branch_numbers: range = range(self._max_number_branch)
         class_model: Any = self._class_model
@@ -136,9 +143,9 @@ class Find:
             case 1:
                 return doc
             case 2:
-                return doc.model_dump_json() if doc is not None else None
+                return doc.model_dump_json(**model_dump_kwargs) if doc is not None else None
             case 3:
-                return doc.model_dump() if doc is not None else None
+                return doc.model_dump(**model_dump_kwargs) if doc is not None else None
             case _ as unreachable:
                 assert_never(Never(unreachable))  # pyrefly: ignore[not-callable]
 
@@ -150,6 +157,8 @@ class Find:
         page_number: int = 1,
         sort_fn: Callable | None = lambda doc: doc.created_at,
         sort_reverse: bool = True,
+        include_fields: set[str] | None = None,
+        exclude_fields: set[str] | None = None,
         return_type: ReturnType = ReturnType.MODEL,
     ) -> list[Any] | str | None:
         """Synchronous method for find many documents matching the filter.
@@ -170,6 +179,10 @@ class Find:
                                        By default, documents are sorted by creation date.
             sort_reverse: (bool): Sorting direction.
                                   By default, sort descending (newest to oldest).
+            include_fields: (set[str] | None): A set of fields to include in the output.
+                                               Available for `ReturnType.JSON` and `ReturnType.DICT`.
+            exclude_fields: (set[str] | None): A set of fields to exclude from the output.
+                                               Available for `ReturnType.JSON` and `ReturnType.DICT`.
             return_type (ReturnType): ScrubyModel, JSON-string or Dictionary.
 
         Returns:
@@ -186,6 +199,7 @@ class Find:
         hash_reduce_left: int = self._hash_reduce_left
         assert hash_reduce_left != 0, "Scruby.run(hash_reduce_left = 0) - Not valid for `find_many` method."
 
+        model_dump_kwargs = {"include": include_fields, "exclude": exclude_fields}
         search_task_fn: Callable = self._task_find
         branch_numbers: range = range(self._max_number_branch)
         class_model: Any = self._class_model
@@ -235,8 +249,12 @@ class Find:
             case 1:
                 return result or None
             case 2:
-                return f"[{','.join([doc.model_dump_json() for doc in result])}]" if result is not None else None
+                return (
+                    f"[{','.join([doc.model_dump_json(**model_dump_kwargs) for doc in result])}]"
+                    if result is not None
+                    else None
+                )
             case 3:
-                return [doc.model_dump() for doc in result] if result is not None else None
+                return [doc.model_dump(**model_dump_kwargs) for doc in result] if result is not None else None
             case _ as unreachable:
                 assert_never(Never(unreachable))  # pyrefly: ignore[not-callable]

{scruby-2.6.2.dist-info → scruby-2.6.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scruby
-Version: 2.6.2
+Version: 2.6.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
@@ -147,6 +147,7 @@ from scruby import Scruby, ScrubyModel
 
 class User(ScrubyModel):
     """User model."""
+    username: str
     first_name: str
     last_name: str
     birthday: datetime
@@ -172,6 +173,7 @@ async def main() -> None:
 
     # Create user
     user = User(
+        username=f"user_1",
         first_name="John",
         last_name="Smith",
         birthday=datetime(1970, 1, 1, tzinfo=ZoneInfo("UTC")),

{scruby-2.6.2.dist-info → scruby-2.6.4.dist-info}/RECORD

@@ -14,11 +14,11 @@ scruby/mixins/collection.py,sha256=mLr6SAFh1XYKEzedsPAEWYyWKG8xSx7OOkGhhfYm3qM,2
 scruby/mixins/count.py,sha256=CGpyOpsG25uC5utI2ByNxq2iTbJocj6w5tXrC1_cP40,2561
 scruby/mixins/custom_task.py,sha256=DIry4gBlTdaqZqymar-RrHSdhEiC2tn2pl9jmbk56zw,1547
 scruby/mixins/delete.py,sha256=InKVIud_ZYx9-CchUz_IygQDXMynNi4jQ0HKYeHC_R8,4328
-scruby/mixins/find.py,sha256=oEZRE6RqIBdwvNr8iSYyod8hI6ibi_egJP0pyXmJiss,9169
+scruby/mixins/find.py,sha256=MRyBIc4KPibjhHubl7XHmMj4JIBNLXNgsLID_V9jtrw,10488
 scruby/mixins/keys.py,sha256=MvBy_8fQGROaQATK2qse2V8wR-xodPQG0KKZ2PK_t9U,10790
 scruby/mixins/update.py,sha256=TyxvxB-gNijlfzTmhwrq0ydvu0C3R-RihW5h5tJ96bM,4964
-scruby-2.6.2.dist-info/METADATA,sha256=wY8DdpOxNi_7cnChSYlg3IFu-IzU6IKp9WtW7aCNyRM,13317
-scruby-2.6.2.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
-scruby-2.6.2.dist-info/licenses/GPL-3.0-LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-scruby-2.6.2.dist-info/licenses/MIT-LICENSE,sha256=mS0Wz0yGNB63gEcWEnuIb_lldDYV0sjRaO-o_GL6CWE,1074
-scruby-2.6.2.dist-info/RECORD,,
+scruby-2.6.4.dist-info/METADATA,sha256=6FpVRsUxZ7cIh_EXgxXytv9yM5IKRFoAhfak4ya6kj0,13363
+scruby-2.6.4.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+scruby-2.6.4.dist-info/licenses/GPL-3.0-LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+scruby-2.6.4.dist-info/licenses/MIT-LICENSE,sha256=mS0Wz0yGNB63gEcWEnuIb_lldDYV0sjRaO-o_GL6CWE,1074
+scruby-2.6.4.dist-info/RECORD,,