ramifice 0.8.22__py3-none-any.whl → 0.8.26__py3-none-any.whl

ramifice/__init__.py

@@ -12,7 +12,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""ORM-pseudo-like API MongoDB for Python language."""
+"""ORM-pseudo-like API MongoDB for Python language.
+
+Ramifice is built around <a href="https://pypi.org/project/pymongo/" alt="PyMongo">PyMongo</a>.
+
+For simulate relationship Many-to-One and Many-to-Many,
+a simplified alternative (Types of selective fields with dynamic addition of elements) is used.
+The project is more concentrated for web development or for applications with a graphic interface.
+"""
 
 __all__ = (
     "NamedTuple",

ramifice/commons/__init__.py

@@ -1,4 +1,4 @@
-"""Ramifice - Commons - Model class methods."""
+"""Commons - Model class methods."""
 
 __all__ = ("QCommonsMixin",)
 
@@ -16,7 +16,7 @@ class QCommonsMixin(
     IndexMixin,
     UnitMixin,
 ):
-    """Ramifice - Commons - Model class methods."""
+    """Commons - Model class methods."""
 
     def __init__(self) -> None:  # noqa: D107
         super().__init__()

ramifice/commons/general.py

@@ -1,4 +1,4 @@
-"""Ramifice - General purpose query methods."""
+"""General purpose query methods."""
 
 __all__ = ("GeneralMixin",)
 
@@ -13,14 +13,14 @@ from ramifice.utils import constants, translations
 
 
 class GeneralMixin:
-    """Ramifice - General purpose query methods."""
+    """General purpose query methods."""
 
     @classmethod
     def from_mongo_doc(
         cls,
         mongo_doc: dict[str, Any],
     ) -> Any:
-        """Ramifice - Create object instance from Mongo document."""
+        """Create object instance from Mongo document."""
         obj: Any = cls()
         lang: str = translations.CURRENT_LOCALE
         for name, data in mongo_doc.items():
@@ -41,7 +41,7 @@ class GeneralMixin:
         comment: Any | None = None,
         **kwargs,
     ) -> int:
-        """Ramifice - Gets an estimate of the count of documents in a collection using collection metadata."""
+        """Gets an estimate of the count of documents in a collection using collection metadata."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         #
@@ -58,7 +58,7 @@ class GeneralMixin:
         comment: Any | None = None,
         **kwargs,
     ) -> int:
-        """Ramifice - Gets an estimate of the count of documents in a collection using collection metadata."""
+        """Gets an estimate of the count of documents in a collection using collection metadata."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         # Correcting filter.
@@ -81,7 +81,7 @@ class GeneralMixin:
         comment: Any | None = None,
         **kwargs,
     ) -> AsyncCommandCursor:
-        """Ramifice - Runs an aggregation framework pipeline."""
+        """Runs an aggregation framework pipeline."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         # Correcting filter.
@@ -106,7 +106,7 @@ class GeneralMixin:
         hint: Any | None = None,
         **kwargs,
     ) -> list[Any]:
-        """Ramifice - Finds the distinct values for a specified field across a single collection.
+        """Finds the distinct values for a specified field across a single collection.
 
         Returns an array of unique values for specified field of collection.
         """
@@ -127,7 +127,7 @@ class GeneralMixin:
 
     @classmethod
     def collection_name(cls) -> str:
-        """Ramifice - Get collection name."""
+        """Get collection name."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         #
@@ -135,7 +135,7 @@ class GeneralMixin:
 
     @classmethod
     def collection_full_name(cls) -> str:
-        """Ramifice - The full name of this AsyncCollection.
+        """The full name of this AsyncCollection.
 
         The full name is of the form database_name.collection_name.
         """
@@ -146,7 +146,7 @@ class GeneralMixin:
 
     @classmethod
     def database(cls) -> AsyncDatabase:
-        """Ramifice - Get AsyncBatabase for the current Model."""
+        """Get AsyncBatabase for the current Model."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         #
@@ -154,7 +154,7 @@ class GeneralMixin:
 
     @classmethod
     def collection(cls) -> AsyncCollection:
-        """Ramifice - Get AsyncCollection for the current Model."""
+        """Get AsyncCollection for the current Model."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         #

ramifice/commons/indexes.py

@@ -1,4 +1,4 @@
-"""Ramifice - Indexation documents of collection."""
+"""Indexation documents of collection."""
 
 __all__ = ("IndexMixin",)
 
@@ -10,7 +10,7 @@ from ramifice.utils import constants
 
 
 class IndexMixin:
-    """Ramifice - Indexation documents of collection."""
+    """Indexation documents of collection."""
 
     @classmethod
     async def create_index(  # type: ignore[no-untyped-def]
@@ -20,7 +20,7 @@ class IndexMixin:
         comment: Any | None = None,
         **kwargs,
     ) -> str:
-        """Ramifice - Creates an index on this collection."""
+        """Creates an index on this collection."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         # Create index.
@@ -40,7 +40,7 @@ class IndexMixin:
         comment: Any | None = None,
         **kwargs,
     ) -> None:
-        """Ramifice - Drops the specified index on this collection."""
+        """Drops the specified index on this collection."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         # Delete index.
@@ -59,7 +59,7 @@ class IndexMixin:
         comment: Any | None = None,
         **kwargs,
     ) -> list[str]:
-        """Ramifice - Create one or more indexes on this collection."""
+        """Create one or more indexes on this collection."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         # Create indexes.
@@ -78,7 +78,7 @@ class IndexMixin:
         comment: Any | None = None,
         **kwargs,
     ) -> None:
-        """Ramifice - Drops all indexes on this collection."""
+        """Drops all indexes on this collection."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         # Delete indexes.
@@ -90,7 +90,7 @@ class IndexMixin:
         session: Any | None = None,
         comment: Any | None = None,
     ) -> Any:
-        """Ramifice - Get information on this collection’s indexes."""
+        """Get information on this collection’s indexes."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         # Get information.
@@ -103,7 +103,7 @@ class IndexMixin:
         session: Any | None = None,
         comment: Any | None = None,
     ) -> Any:
-        """Ramifice - Get a cursor over the index documents for this collection."""
+        """Get a cursor over the index documents for this collection."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         # Get cursor.

ramifice/commons/many.py

@@ -1,4 +1,4 @@
-"""Ramifice - Queries like `find many`."""
+"""Queries like `find many`."""
 
 __all__ = ("ManyMixin",)
 
@@ -22,7 +22,7 @@ logger = logging.getLogger(__name__)
 
 
 class ManyMixin:
-    """Ramifice - Queries like `find many`."""
+    """Queries like `find many`."""
 
     @classmethod
     async def find_many(
@@ -49,7 +49,7 @@ class ManyMixin:
         session: Any | None = None,
         allow_disk_use: Any | None = None,
     ) -> list[dict[str, Any]]:
-        """Ramifice - Find documents."""
+        """Find documents."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         # Correcting filter.
@@ -110,7 +110,7 @@ class ManyMixin:
         session: Any | None = None,
         allow_disk_use: Any | None = None,
     ) -> list[dict[str, Any]]:
-        """Ramifice - Find documents and convert to a raw documents.
+        """Find documents and convert to a raw documents.
 
         Special changes:
             _id to str
@@ -187,7 +187,7 @@ class ManyMixin:
         session: Any | None = None,
         allow_disk_use: Any | None = None,
     ) -> str | None:
-        """Ramifice - Find documents and convert to a json string."""
+        """Find documents and convert to a json string."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         # Correcting filter.
@@ -242,7 +242,7 @@ class ManyMixin:
         let: Any | None = None,
         comment: Any | None = None,
     ) -> DeleteResult:
-        """Ramifice - Find documents matching with Model."""
+        """Find documents matching with Model."""
         # Raises a panic if the Model cannot be removed.
         if not cls.META["is_delete_doc"]:
             msg = (

ramifice/commons/one.py

@@ -1,4 +1,4 @@
-"""Ramifice - Requests like `find one`."""
+"""Requests like `find one`."""
 
 __all__ = ("OneMixin",)
 
@@ -20,7 +20,7 @@ logger = logging.getLogger(__name__)
 
 
 class OneMixin:
-    """Ramifice - Requests like `find one`."""
+    """Requests like `find one`."""
 
     @classmethod
     async def find_one(
@@ -29,7 +29,7 @@ class OneMixin:
         *args: tuple,
         **kwargs: dict[str, Any],
     ) -> dict[str, Any] | None:
-        """Ramifice - Find a single document."""
+        """Find a single document."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         # Correcting filter.
@@ -51,7 +51,7 @@ class OneMixin:
         *args: tuple,
         **kwargs: dict[str, Any],
     ) -> dict[str, Any] | None:
-        """Ramifice - Find a single document and converting to raw document."""
+        """Find a single document and converting to raw document."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         # Correcting filter.
@@ -78,7 +78,7 @@ class OneMixin:
         *args: tuple,
         **kwargs: dict[str, Any],
     ) -> Any | None:
-        """Ramifice - Find a single document and convert it to a Model instance."""
+        """Find a single document and convert it to a Model instance."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         # Correcting filter.
@@ -99,7 +99,7 @@ class OneMixin:
         *args: tuple,
         **kwargs: dict[str, Any],
     ) -> str | None:
-        """Ramifice - Find a single document and convert it to a JSON string."""
+        """Find a single document and convert it to a JSON string."""
         # 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:
-        """Ramifice - Find a single document and delete it."""
+        """Find a single document and delete it."""
         # 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:
-        """Ramifice - Find a single document and delete it, return original."""
+        """Find a single document and delete it, return original."""
         # Raises a panic if the Model cannot be removed.
         if not cls.META["is_delete_doc"]:
             msg = (

ramifice/commons/tools.py

@@ -1,4 +1,4 @@
-"""Ramifice - Tool of Commons - A set of auxiliary methods."""
+"""Tool of Commons - A set of auxiliary methods."""
 
 __all__ = (
     "correct_mongo_filter",
@@ -15,7 +15,7 @@ from ramifice.utils import translations
 
 
 def correct_mongo_filter(cls_model: Any, filter: Any) -> Any:
-    """Ramifice - Correcting filter of request.
+    """Correcting filter of request.
 
     Corrects `TextField` fields that require localization of translation.
     """
@@ -33,7 +33,7 @@ def password_to_none(
     field_name_and_type: dict[str, str],
     mongo_doc: dict[str, Any],
 ) -> dict[str, Any]:
-    """Ramifice - Create object instance from Mongo document."""
+    """Create object instance from Mongo document."""
     for f_name, t_name in field_name_and_type.items():
         if "PasswordField" == t_name:
             mongo_doc[f_name] = None
@@ -45,7 +45,7 @@ def mongo_doc_to_raw_doc(
     mongo_doc: dict[str, Any],
     lang: str,
 ) -> dict[str, Any]:
-    """Ramifice - Convert the Mongo document to the raw document.
+    """Convert the Mongo document to the raw document.
 
     Special changes:
         _id to str

ramifice/commons/unit_manager.py

@@ -1,4 +1,4 @@
-"""Ramifice - Units Management.
+"""Units Management.
 
 Management for `choices` parameter in dynamic field types.
 """
@@ -22,14 +22,14 @@ logger = logging.getLogger(__name__)
 
 
 class UnitMixin:
-    """Ramifice - Units Management.
+    """Units Management.
 
     Management for `choices` parameter in dynamic field types.
     """
 
     @classmethod
     async def unit_manager(cls: Any, unit: Unit) -> None:
-        """Ramifice - Units Management.
+        """Units Management.
 
         Management for `choices` parameter in dynamic field types.
         """

ramifice/fields/__init__.py

@@ -1,4 +1,4 @@
-"""Ramifice - Available field types."""
+"""Available field types."""
 
 __all__ = (
     "BooleanField",

ramifice/fields/bool_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model for enter boolean value."""
+"""Field of Model for enter boolean value."""
 
 __all__ = ("BooleanField",)
 
@@ -6,24 +6,34 @@ import logging
 
 from ramifice.fields.general.field import Field
 from ramifice.utils import constants
-from ramifice.utils.mixins.json_converter import JsonMixin
+from ramifice.utils.mixins import JsonMixin
 
 logger = logging.getLogger(__name__)
 
 
 class BooleanField(Field, JsonMixin):
-    """Ramifice - Field of Model for enter boolean value."""
+    """Field of Model for enter boolean value.
+
+    Args:
+        label: Text label for a web form field.
+        default: Default value.
+        hide: Hide field from user.
+        disabled: Blocks access and modification of the element.
+        ignored: If true, the value of this field is not saved in the database.
+        hint: An alternative for the `placeholder` parameter.
+        warning: Warning information.
+    """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
+        default: bool = False,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,
-        default: bool = False,
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if default is not None and not isinstance(default, bool):

ramifice/fields/choice_float_dyn_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model.
+"""Field of Model.
 
 Type of selective float field with dynamic addition of elements.
 """
@@ -10,30 +10,40 @@ import logging
 from ramifice.fields.general.choice_group import ChoiceGroup
 from ramifice.fields.general.field import Field
 from ramifice.utils import constants
-from ramifice.utils.mixins.json_converter import JsonMixin
+from ramifice.utils.mixins import JsonMixin
 
 logger = logging.getLogger(__name__)
 
 
 class ChoiceFloatDynField(Field, ChoiceGroup, JsonMixin):
-    """Ramifice - Field of Model.
+    """Field of Model.
 
     Type of selective integer field with dynamic addition of elements.
     For simulate relationship Many-to-One.
     Element are (add|delete) via `ModelName.unit_manager(unit)` method.
+
+    Args:
+        label: Text label for a web form field.
+        hide: Hide field from user.
+        disabled: Blocks access and modification of the element.
+        ignored: If true, the value of this field is not saved in the database.
+        hint: An alternative for the `placeholder` parameter.
+        warning: Warning information.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
     """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,
         required: bool = False,
         readonly: bool = False,
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if not isinstance(label, str):
@@ -80,7 +90,7 @@ class ChoiceFloatDynField(Field, ChoiceGroup, JsonMixin):
         self.choices: list[list[float | str]] | None = None
 
     def has_value(self, is_migrate: bool = False) -> bool:
-        """Ramifice - Does the field value match the possible options in choices."""
+        """Does the field value match the possible options in choices."""
         if is_migrate:
             return True
         value = self.value

ramifice/fields/choice_float_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model.
+"""Field of Model.
 
 Type of selective float field with static of elements.
 """
@@ -10,31 +10,43 @@ import logging
 from ramifice.fields.general.choice_group import ChoiceGroup
 from ramifice.fields.general.field import Field
 from ramifice.utils import constants
-from ramifice.utils.mixins.json_converter import JsonMixin
+from ramifice.utils.mixins import JsonMixin
 
 logger = logging.getLogger(__name__)
 
 
 class ChoiceFloatField(Field, ChoiceGroup, JsonMixin):
-    """Ramifice - Field of Model.
+    """Field of Model.
 
     Type of selective integer float with static of elements.
     With a single choice.
+
+    Args:
+        label: Text label for a web form field.
+        default: Default value.
+        hide: Hide field from user.
+        disabled: Blocks access and modification of the element.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
+        ignored: If true, the value of this field is not saved in the database.
+        hint: An alternative for the `placeholder` parameter.
+        warning: Warning information.
+        choices: For a predefined set of options - [[value, Title], ...].
     """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
+        default: float | None = None,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,
-        default: float | None = None,
         required: bool = False,
         readonly: bool = False,
-        choices: list[list[float | str]] | None = None,
-    ):
+        choices: list[list[float | str]] | None = None,  # [[value, Title], ...]
+    ) -> None:
         Field.__init__(
             self,
             label=label,
@@ -96,7 +108,7 @@ class ChoiceFloatField(Field, ChoiceGroup, JsonMixin):
                 raise err
 
     def has_value(self, is_migrate: bool = False) -> bool:
-        """Ramifice - Does the field value match the possible options in choices."""
+        """Does the field value match the possible options in choices."""
         value = self.value
         if value is None:
             value = self.default

ramifice/fields/choice_float_mult_dyn_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model.
+"""Field of Model.
 
 Type of selective float field with dynamic addition of elements.
 """
@@ -10,29 +10,39 @@ import logging
 from ramifice.fields.general.choice_group import ChoiceGroup
 from ramifice.fields.general.field import Field
 from ramifice.utils import constants
-from ramifice.utils.mixins.json_converter import JsonMixin
+from ramifice.utils.mixins import JsonMixin
 
 logger = logging.getLogger(__name__)
 
 
 class ChoiceFloatMultDynField(Field, ChoiceGroup, JsonMixin):
-    """Ramifice - Field of Model.
+    """Field of Model.
 
     Type of selective float field with dynamic addition of elements.
     For simulate relationship Many-to-Many.
+
+    Args:
+        label: Text label for a web form field.
+        hide: Hide field from user.
+        disabled: Blocks access and modification of the element.
+        ignored: If true, the value of this field is not saved in the database.
+        hint: An alternative for the `placeholder` parameter.
+        warning: Warning information.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
     """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,
         required: bool = False,
         readonly: bool = False,
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if not isinstance(label, str):
@@ -80,7 +90,7 @@ class ChoiceFloatMultDynField(Field, ChoiceGroup, JsonMixin):
         self.choices: list[list[float | str]] | None = None
 
     def has_value(self, is_migrate: bool = False) -> bool:
-        """Ramifice - Does the field value match the possible options in choices."""
+        """Does the field value match the possible options in choices."""
         if is_migrate:
             return True
         value = self.value

ramifice/fields/choice_float_mult_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model.
+"""Field of Model.
 
 Type of selective float field with static of elements.
 """
@@ -10,31 +10,43 @@ import logging
 from ramifice.fields.general.choice_group import ChoiceGroup
 from ramifice.fields.general.field import Field
 from ramifice.utils import constants
-from ramifice.utils.mixins.json_converter import JsonMixin
+from ramifice.utils.mixins import JsonMixin
 
 logger = logging.getLogger(__name__)
 
 
 class ChoiceFloatMultField(Field, ChoiceGroup, JsonMixin):
-    """Ramifice - Field of Model.
+    """Field of Model.
 
     Type of selective float field with static of elements.
     With multiple choice.
+
+    Args:
+        label: Text label for a web form field.
+        default: Default value.
+        hide: Hide field from user.
+        disabled: Blocks access and modification of the element.
+        ignored: If true, the value of this field is not saved in the database.
+        hint: An alternative for the `placeholder` parameter.
+        warning: Warning information.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
+        choices: For a predefined set of options - [[value, Title], ...].
     """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
+        default: list[float] | None = None,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,
-        default: list[float] | None = None,
         required: bool = False,
         readonly: bool = False,
-        choices: list[list[float | str]] | None = None,
-    ):
+        choices: list[list[float | str]] | None = None,  # [[value, Title], ...]
+    ) -> None:
         Field.__init__(
             self,
             label=label,
@@ -102,7 +114,7 @@ class ChoiceFloatMultField(Field, ChoiceGroup, JsonMixin):
                 raise err
 
     def has_value(self, is_migrate: bool = False) -> bool:
-        """Ramifice - Does the field value match the possible options in choices."""
+        """Does the field value match the possible options in choices."""
         value = self.value
         if value is None:
             value = self.default