ramifice 0.8.11__py3-none-any.whl → 0.8.13__py3-none-any.whl

ramifice/__init__.py

@@ -12,9 +12,24 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""ORM-like API MongoDB for Python language."""
+"""Ramifice - ORM-like API MongoDB for Python language."""
+
+__all__ = (
+    "model",
+    "translations",
+    "Migration",
+    "Unit",
+)
+
+import logging
 
 from ramifice.models.decorator import model
 from ramifice.utils import translations
 from ramifice.utils.migration import Migration
 from ramifice.utils.unit import Unit
+
+logging.basicConfig(
+    level=logging.INFO,
+    datefmt="%Y-%m-%d %H:%M:%S",
+    format="[%(asctime)s.%(msecs)03d] %(module)10s:%(lineno)-3d %(levelname)-7s - %(message)s",
+)

ramifice/commons/__init__.py

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

ramifice/commons/general.py

@@ -1,4 +1,4 @@
-"""General purpose query methods."""
+"""Ramifice - General purpose query methods."""
 
 __all__ = ("GeneralMixin",)
 
@@ -13,14 +13,14 @@ from ramifice.utils import constants, translations
 
 
 class GeneralMixin:
-    """General purpose query methods."""
+    """Ramifice - General purpose query methods."""
 
     @classmethod
     def from_mongo_doc(
         cls,
         mongo_doc: dict[str, Any],
     ) -> Any:
-        """Create object instance from Mongo document."""
+        """Ramifice - 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:
-        """Gets an estimate of the count of documents in a collection using collection metadata."""
+        """Ramifice - 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:
-        """Gets an estimate of the count of documents in a collection using collection metadata."""
+        """Ramifice - 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:
-        """Runs an aggregation framework pipeline."""
+        """Ramifice - 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]:
-        """Finds the distinct values for a specified field across a single collection.
+        """Ramifice - 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:
-        """Get collection name."""
+        """Ramifice - 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:
-        """The full name of this AsyncCollection.
+        """Ramifice - 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:
-        """Get AsyncBatabase for the current Model."""
+        """Ramifice - 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:
-        """Get AsyncCollection for the current Model."""
+        """Ramifice - 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 @@
-"""Indexation documents of collection."""
+"""Ramifice - Indexation documents of collection."""
 
 __all__ = ("IndexMixin",)
 
@@ -10,7 +10,7 @@ from ramifice.utils import constants
 
 
 class IndexMixin:
-    """Indexation documents of collection."""
+    """Ramifice - 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:
-        """Creates an index on this collection."""
+        """Ramifice - 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:
-        """Drops the specified index on this collection."""
+        """Ramifice - 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]:
-        """Create one or more indexes on this collection."""
+        """Ramifice - 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:
-        """Drops all indexes on this collection."""
+        """Ramifice - 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:
-        """Get information on this collection’s indexes."""
+        """Ramifice - 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:
-        """Get a cursor over the index documents for this collection."""
+        """Ramifice - 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,7 +1,8 @@
-"""Queries like `find many`."""
+"""Ramifice - Queries like `find many`."""
 
 __all__ = ("ManyMixin",)
 
+import logging
 from typing import Any
 
 import orjson
@@ -17,9 +18,11 @@ from ramifice.commons.tools import (
 from ramifice.utils import constants, translations
 from ramifice.utils.errors import PanicError
 
+logger = logging.getLogger(__name__)
+
 
 class ManyMixin:
-    """Queries like `find many`."""
+    """Ramifice - Queries like `find many`."""
 
     @classmethod
     async def find_many(
@@ -46,7 +49,7 @@ class ManyMixin:
         session: Any | None = None,
         allow_disk_use: Any | None = None,
     ) -> list[dict[str, Any]]:
-        """Find documents."""
+        """Ramifice - Find documents."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         # Correcting filter.
@@ -107,7 +110,7 @@ class ManyMixin:
         session: Any | None = None,
         allow_disk_use: Any | None = None,
     ) -> list[dict[str, Any]]:
-        """Find documents and convert to a raw documents.
+        """Ramifice - Find documents and convert to a raw documents.
 
         Special changes:
             _id to str
@@ -184,7 +187,7 @@ class ManyMixin:
         session: Any | None = None,
         allow_disk_use: Any | None = None,
     ) -> str | None:
-        """Find documents and convert to a json string."""
+        """Ramifice - Find documents and convert to a json string."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         # Correcting filter.
@@ -239,7 +242,7 @@ class ManyMixin:
         let: Any | None = None,
         comment: Any | None = None,
     ) -> DeleteResult:
-        """Find documents matching with Model."""
+        """Ramifice - Find documents matching with Model."""
         # Raises a panic if the Model cannot be removed.
         if not cls.META["is_delete_doc"]:
             msg = (
@@ -247,6 +250,7 @@ class ManyMixin:
                 + "META param: `is_delete_doc` (False) => "
                 + "Documents of this Model cannot be removed from the database!"
             )
+            logger.error(msg)
             raise PanicError(msg)
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]

ramifice/commons/one.py

@@ -1,7 +1,8 @@
-"""Requests like `find one`."""
+"""Ramifice - Requests like `find one`."""
 
 __all__ = ("OneMixin",)
 
+import logging
 from typing import Any
 
 from pymongo.asynchronous.collection import AsyncCollection
@@ -15,9 +16,11 @@ from ramifice.commons.tools import (
 from ramifice.utils import constants, translations
 from ramifice.utils.errors import PanicError
 
+logger = logging.getLogger(__name__)
+
 
 class OneMixin:
-    """Requests like `find one`."""
+    """Ramifice - Requests like `find one`."""
 
     @classmethod
     async def find_one(
@@ -26,7 +29,7 @@ class OneMixin:
         *args: tuple,
         **kwargs: dict[str, Any],
     ) -> dict[str, Any] | None:
-        """Find a single document."""
+        """Ramifice - Find a single document."""
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
         # Correcting filter.
@@ -48,7 +51,7 @@ class OneMixin:
         *args: tuple,
         **kwargs: dict[str, Any],
     ) -> dict[str, Any] | None:
-        """Find a single document and converting to raw document."""
+        """Ramifice - 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.
@@ -75,7 +78,7 @@ class OneMixin:
         *args: tuple,
         **kwargs: dict[str, Any],
     ) -> Any | None:
-        """Find a single document and convert it to a Model instance."""
+        """Ramifice - 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.
@@ -96,7 +99,7 @@ class OneMixin:
         *args: tuple,
         **kwargs: dict[str, Any],
     ) -> str | None:
-        """Find a single document and convert it to a JSON string."""
+        """Ramifice - 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.
@@ -121,7 +124,7 @@ class OneMixin:
         let: Any | None = None,
         comment: Any | None = None,
     ) -> DeleteResult:
-        """Find a single document and delete it."""
+        """Ramifice - Find a single document and delete it."""
         # Raises a panic if the Model cannot be removed.
         if not cls.META["is_delete_doc"]:
             msg = (
@@ -129,6 +132,7 @@ class OneMixin:
                 + "META param: `is_delete_doc` (False) => "
                 + "Documents of this Model cannot be removed from the database!"
             )
+            logger.error(msg)
             raise PanicError(msg)
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]
@@ -158,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."""
+        """Ramifice - 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 = (
@@ -166,6 +170,7 @@ class OneMixin:
                 + "META param: `is_delete_doc` (False) => "
                 + "Documents of this Model cannot be removed from the database!"
             )
+            logger.error(msg)
             raise PanicError(msg)
         # Get collection for current model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls.META["collection_name"]]

ramifice/commons/tools.py

@@ -1,4 +1,4 @@
-"""Tool of Commons - A set of auxiliary methods."""
+"""Ramifice - 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:
-    """Correcting filter of request.
+    """Ramifice - 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]:
-    """Create object instance from Mongo document."""
+    """Ramifice - 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]:
-    """Convert the Mongo document to the raw document.
+    """Ramifice - Convert the Mongo document to the raw document.
 
     Special changes:
         _id to str

ramifice/commons/unit_manager.py

@@ -1,10 +1,11 @@
-"""Units Management.
+"""Ramifice - Units Management.
 
 Management for `choices` parameter in dynamic field types.
 """
 
 __all__ = ("UnitMixin",)
 
+import logging
 from typing import Any
 
 from pymongo.asynchronous.collection import AsyncCollection
@@ -13,16 +14,18 @@ from ramifice.utils import constants, translations
 from ramifice.utils.errors import PanicError
 from ramifice.utils.unit import Unit
 
+logger = logging.getLogger(__name__)
+
 
 class UnitMixin:
-    """Units Management.
+    """Ramifice - Units Management.
 
     Management for `choices` parameter in dynamic field types.
     """
 
     @classmethod
     async def unit_manager(cls: Any, unit: Unit) -> None:
-        """Units Management.
+        """Ramifice - Units Management.
 
         Management for `choices` parameter in dynamic field types.
         """
@@ -37,14 +40,18 @@ class UnitMixin:
         )
         # Check the presence of a Model state.
         if model_state is None:
-            raise PanicError("Error: Model State - Not found!")
+            msg = "Error: Model State - Not found!"
+            logger.error(msg)
+            raise PanicError(msg)
         # Get language list.
         lang_list = translations.LANGUAGES
         # Get clean fields of Unit.
         unit_field: str = unit.field
         title = unit.title
         if len(title) != len(lang_list):
-            raise PanicError("Unit.title => There are no translations for some languages!")
+            msg = "Unit.title => There are no translations for some languages!"
+            logger.error(msg)
+            raise PanicError(msg)
         title = {lang: title[lang] for lang in lang_list}
         target_value = unit.value
         # Get dynamic field data.
@@ -65,6 +72,7 @@ class UnitMixin:
                         "Error: It is impossible to add unit - "
                         + f"Unit `{title[main_lang]}: {target_value}` is exists!"
                     )
+                    logger.error(msg)
                     raise PanicError(msg)
                 choices.append({"title": title, "value": target_value})
             else:
@@ -74,6 +82,7 @@ class UnitMixin:
             # Delete Unit from Model State.
             if choices is None:
                 msg = "Error: It is not possible to delete Unit - Units is not exists!"
+                logger.error(msg)
                 raise PanicError(msg)
             if not is_unit_exists:
                 main_lang = translations.DEFAULT_LOCALE
@@ -81,6 +90,7 @@ class UnitMixin:
                     "Error: It is not possible to delete Unit."
                     + f"Unit `{title[main_lang]}: {target_value}` is not exists!"
                 )
+                logger.error(msg)
                 raise PanicError(msg)
             choices = [item for item in choices if item["value"] != target_value]
             model_state["data_dynamic_fields"][unit_field] = choices or None

ramifice/fields/__init__.py

@@ -1,4 +1,4 @@
-"""Available field types."""
+"""Ramifice - Available field types."""
 
 from ramifice.fields.bool_field import BooleanField
 from ramifice.fields.choice_float_dyn_field import ChoiceFloatDynField

ramifice/fields/bool_field.py

@@ -1,14 +1,18 @@
-"""Field of Model for enter boolean value."""
+"""Ramifice - Field of Model for enter boolean value."""
 
 __all__ = ("BooleanField",)
 
+import logging
+
 from ramifice.fields.general.field import Field
 from ramifice.utils import constants
 from ramifice.utils.mixins.json_converter import JsonMixin
 
+logger = logging.getLogger(__name__)
+
 
 class BooleanField(Field, JsonMixin):
-    """Field of Model for enter boolean value."""
+    """Ramifice - Field of Model for enter boolean value."""
 
     def __init__(  # noqa: D107
         self,
@@ -21,22 +25,26 @@ class BooleanField(Field, JsonMixin):
         default: bool = False,
     ):
         if constants.DEBUG:
-            if default is not None and not isinstance(default, bool):
-                raise AssertionError("Parameter `default` - Not а `bool` type!")
-            if not isinstance(label, str):
-                raise AssertionError("Parameter `default` - Not а `str` type!")
-            if not isinstance(disabled, bool):
-                raise AssertionError("Parameter `disabled` - Not а `bool` type!")
-            if not isinstance(hide, bool):
-                raise AssertionError("Parameter `hide` - Not а `bool` type!")
-            if not isinstance(ignored, bool):
-                raise AssertionError("Parameter `ignored` - Not а `bool` type!")
-            if not isinstance(ignored, bool):
-                raise AssertionError("Parameter `ignored` - Not а `bool` type!")
-            if not isinstance(hint, str):
-                raise AssertionError("Parameter `hint` - Not а `str` type!")
-            if warning is not None and not isinstance(warning, list):
-                raise AssertionError("Parameter `warning` - Not а `list` type!")
+            try:
+                if default is not None and not isinstance(default, bool):
+                    raise AssertionError("Parameter `default` - Not а `bool` type!")
+                if not isinstance(label, str):
+                    raise AssertionError("Parameter `default` - Not а `str` type!")
+                if not isinstance(disabled, bool):
+                    raise AssertionError("Parameter `disabled` - Not а `bool` type!")
+                if not isinstance(hide, bool):
+                    raise AssertionError("Parameter `hide` - Not а `bool` type!")
+                if not isinstance(ignored, bool):
+                    raise AssertionError("Parameter `ignored` - Not а `bool` type!")
+                if not isinstance(ignored, bool):
+                    raise AssertionError("Parameter `ignored` - Not а `bool` type!")
+                if not isinstance(hint, str):
+                    raise AssertionError("Parameter `hint` - Not а `str` type!")
+                if warning is not None and not isinstance(warning, list):
+                    raise AssertionError("Parameter `warning` - Not а `list` type!")
+            except AssertionError as err:
+                logger.error(str(err))
+                raise err
 
         Field.__init__(
             self,

ramifice/fields/choice_float_dyn_field.py

@@ -1,18 +1,22 @@
-"""Field of Model.
+"""Ramifice - Field of Model.
 
 Type of selective float field with dynamic addition of elements.
 """
 
 __all__ = ("ChoiceFloatDynField",)
 
+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
 
+logger = logging.getLogger(__name__)
+
 
 class ChoiceFloatDynField(Field, ChoiceGroup, JsonMixin):
-    """Field of Model.
+    """Ramifice - Field of Model.
 
     Type of selective integer field with dynamic addition of elements.
     For simulate relationship Many-to-One.
@@ -31,24 +35,28 @@ class ChoiceFloatDynField(Field, ChoiceGroup, JsonMixin):
         readonly: bool = False,
     ):
         if constants.DEBUG:
-            if not isinstance(label, str):
-                raise AssertionError("Parameter `default` - Not а `str` type!")
-            if not isinstance(disabled, bool):
-                raise AssertionError("Parameter `disabled` - Not а `bool` type!")
-            if not isinstance(hide, bool):
-                raise AssertionError("Parameter `hide` - Not а `bool` type!")
-            if not isinstance(ignored, bool):
-                raise AssertionError("Parameter `ignored` - Not а `bool` type!")
-            if not isinstance(ignored, bool):
-                raise AssertionError("Parameter `ignored` - Not а `bool` type!")
-            if not isinstance(hint, str):
-                raise AssertionError("Parameter `hint` - Not а `str` type!")
-            if warning is not None and not isinstance(warning, list):
-                raise AssertionError("Parameter `warning` - Not а `list` type!")
-            if not isinstance(required, bool):
-                raise AssertionError("Parameter `required` - Not а `bool` type!")
-            if not isinstance(readonly, bool):
-                raise AssertionError("Parameter `readonly` - Not а `bool` type!")
+            try:
+                if not isinstance(label, str):
+                    raise AssertionError("Parameter `default` - Not а `str` type!")
+                if not isinstance(disabled, bool):
+                    raise AssertionError("Parameter `disabled` - Not а `bool` type!")
+                if not isinstance(hide, bool):
+                    raise AssertionError("Parameter `hide` - Not а `bool` type!")
+                if not isinstance(ignored, bool):
+                    raise AssertionError("Parameter `ignored` - Not а `bool` type!")
+                if not isinstance(ignored, bool):
+                    raise AssertionError("Parameter `ignored` - Not а `bool` type!")
+                if not isinstance(hint, str):
+                    raise AssertionError("Parameter `hint` - Not а `str` type!")
+                if warning is not None and not isinstance(warning, list):
+                    raise AssertionError("Parameter `warning` - Not а `list` type!")
+                if not isinstance(required, bool):
+                    raise AssertionError("Parameter `required` - Not а `bool` type!")
+                if not isinstance(readonly, bool):
+                    raise AssertionError("Parameter `readonly` - Not а `bool` type!")
+            except AssertionError as err:
+                logger.error(str(err))
+                raise err
 
         Field.__init__(
             self,
@@ -72,7 +80,7 @@ class ChoiceFloatDynField(Field, ChoiceGroup, JsonMixin):
         self.choices: list[list[float | str]] | None = None
 
     def has_value(self, is_migrate: bool = False) -> bool:
-        """Does the field value match the possible options in choices."""
+        """Ramifice - Does the field value match the possible options in choices."""
         if is_migrate:
             return True
         value = self.value