ramifice 0.8.40__py3-none-any.whl → 0.8.42__py3-none-any.whl

ramifice/commons/general.py

@@ -43,7 +43,7 @@ class GeneralMixin:
         comment: Any | None = None,
         **kwargs,
     ) -> int:
-        """Gets an estimate of the count of documents in a collection using collection metadata."""
+        """Get an estimate of the number of documents in this collection using collection metadata."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         #
@@ -60,7 +60,7 @@ class GeneralMixin:
         comment: Any | None = None,
         **kwargs,
     ) -> int:
-        """Gets an estimate of the count of documents in a collection using collection metadata."""
+        """Count the number of documents in this collection."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         # Correcting filter.
@@ -83,7 +83,7 @@ class GeneralMixin:
         comment: Any | None = None,
         **kwargs,
     ) -> AsyncCommandCursor:
-        """Runs an aggregation framework pipeline."""
+        """Perform an aggregation using the aggregation framework on this collection."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         # Correcting filter.
@@ -108,7 +108,7 @@ class GeneralMixin:
         hint: Any | None = None,
         **kwargs,
     ) -> list[Any]:
-        """Finds the distinct values for a specified field across a single collection.
+        """Get a list of distinct values for key among all documents in this collection.
 
         Returns an array of unique values for specified field of collection.
         """
@@ -129,7 +129,7 @@ class GeneralMixin:
 
     @classmethod
     def collection_name(cls) -> str:
-        """Get collection name."""
+        """The name of this AsyncCollection."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         #

ramifice/commons/many.py

@@ -240,7 +240,7 @@ class ManyMixin:
         let: Any | None = None,
         comment: Any | None = None,
     ) -> DeleteResult:
-        """Find documents matching with Model."""
+        """Delete one or more documents matching the filter."""
         # Raises a panic if the Model cannot be removed.
         if not cls.META["is_delete_doc"]:
             msg = (

ramifice/commons/one.py

@@ -31,7 +31,7 @@ class OneMixin:
         *args: tuple,
         **kwargs: dict[str, Any],
     ) -> dict[str, Any] | None:
-        """Find a single document."""
+        """Get a single document from the database."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         # Correcting filter.
@@ -124,7 +124,7 @@ class OneMixin:
         let: Any | None = None,
         comment: Any | None = None,
     ) -> DeleteResult:
-        """Find a single document and delete it."""
+        """Delete a single document matching the filter."""
         # Raises a panic if the Model cannot be removed.
         if not cls.META["is_delete_doc"]:
             msg = (
@@ -162,7 +162,7 @@ class OneMixin:
         comment: Any | None = None,
         **kwargs: dict[str, Any],
     ) -> dict[str, Any] | None:
-        """Find a single document and delete it, return original."""
+        """Finds a single document and deletes it, returning the document."""
         # Raises a panic if the Model cannot be removed.
         if not cls.META["is_delete_doc"]:
             msg = (

{ramifice-0.8.40.dist-info → ramifice-0.8.42.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ramifice
-Version: 0.8.40
+Version: 0.8.42
 Summary: ORM-pseudo-like API MongoDB for Python language.
 Project-URL: Homepage, https://github.com/kebasyaty/ramifice
 Project-URL: Documentation, https://kebasyaty.github.io/ramifice/
@@ -286,7 +286,7 @@ if __name__ == "__main__":
      <tr>
        <td align="left">db_query_docs_limit</td>
        <td align="left">1000</td>
-       <td align="left">limiting query results.</td>
+       <td align="left">Limiting the number of request results.</td>
      </tr>
      <tr>
        <td align="left">is_create_doc</td>

{ramifice-0.8.40.dist-info → ramifice-0.8.42.dist-info}/RECORD

@@ -1,10 +1,10 @@
 ramifice/__init__.py,sha256=Ms9drE4wSvoUyzAtAa-VRykD7ufz6L_GtHx-YQRePDI,1619
 ramifice/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ramifice/commons/__init__.py,sha256=RR_cVDF0H8xa56q2PXGKUSmYOPF-AUNKRY9u7DHD_KU,583
-ramifice/commons/general.py,sha256=zaWBzSLEaUC6Jl3uXwVKlteaGmh1Y3m1TKbRQ9YpNw0,5471
+ramifice/commons/general.py,sha256=yPRG8c2s5C7-J2L4Ev_pa0QA0TWdVrCoD15MuKU5DtY,5488
 ramifice/commons/indexes.py,sha256=Y8v1L3_upl771pJG7mQkSJNwP6slGEakVvj2fZ4zloE,3655
-ramifice/commons/many.py,sha256=paHeSx1aVg08C52h6b3vb-jNXqm0_zgRqxViUvqTmVo,9416
-ramifice/commons/one.py,sha256=hv3gj739YKF3UWtS2Q-TFqgAkZs2du0HxMuQ0LIArJc,6993
+ramifice/commons/many.py,sha256=F1OxAuwmswHTFRUZAvRQO3w4Ih31E3W6FMts07w9OtI,9430
+ramifice/commons/one.py,sha256=b-nIVDCCZhH58z3Fbqrz7r8cf8fEAvV9ZycSLLR2Gpk,7027
 ramifice/commons/tools.py,sha256=MCTPtOl14sIUBkp51f-nqTFVsD0iUj51G40rEFSzU20,2477
 ramifice/commons/unit_manager.py,sha256=V9i3O-Z3eZKVpMUv2a_8FV0VBeHpJZWqeLRGJmtAEsg,4983
 ramifice/fields/__init__.py,sha256=e1TlGRLYMo-97CNUona6EFR0svR--Wp77d_LsYhaBoo,2398
@@ -77,7 +77,7 @@ ramifice/utils/mixins.py,sha256=5G3x8hK3igM7JBgCiCnVDdb_0K_D1gV1tw0QKpDlm-A,1161
 ramifice/utils/tools.py,sha256=WOazw24pvL96-0yNBy7YRGErN3vAQ4F6GS9TLvWFqrs,2747
 ramifice/utils/translations.py,sha256=YItvCWv-13FS2x8VYsAOH-Nx_qQOitOX7-bRGX3mc3A,4718
 ramifice/utils/unit.py,sha256=zHfvkyEU4sxHOc-QMuntEcvyfQqH75AK1zx8E25kM9Y,2535
-ramifice-0.8.40.dist-info/METADATA,sha256=3mxePSplwQl5PjOS9roJRj_el6VxsC7Jn8qcqjIVoZk,18883
-ramifice-0.8.40.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-ramifice-0.8.40.dist-info/licenses/LICENSE,sha256=LrEL0aTZx90HDwFUQCJutORiDjJL9AnuVvCtspXIqt4,1095
-ramifice-0.8.40.dist-info/RECORD,,
+ramifice-0.8.42.dist-info/METADATA,sha256=A3eFjc5MeNxDWEkNp7eilVtGiKFVNop0qyNp6T1MmQ0,18899
+ramifice-0.8.42.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ramifice-0.8.42.dist-info/licenses/LICENSE,sha256=LrEL0aTZx90HDwFUQCJutORiDjJL9AnuVvCtspXIqt4,1095
+ramifice-0.8.42.dist-info/RECORD,,