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

ramifice/paladins/groups/slug_group.py

@@ -1,4 +1,4 @@
-"""Group for checking slug fields.
+"""Ramifice - Group for checking slug fields.
 
 Supported fields:
     SlugField
@@ -6,6 +6,7 @@ Supported fields:
 
 __all__ = ("SlugGroupMixin",)
 
+import logging
 from typing import Any
 
 from slugify import slugify
@@ -13,16 +14,18 @@ from slugify import slugify
 from ramifice.paladins.tools import check_uniqueness
 from ramifice.utils.errors import PanicError
 
+logger = logging.getLogger(__name__)
+
 
 class SlugGroupMixin:
-    """Group for checking slug fields.
+    """Ramifice - Group for checking slug fields.
 
     Supported fields:
         SlugField
     """
 
     async def slug_group(self, params: dict[str, Any]) -> None:
-        """Checking slug fields."""
+        """Ramifice - Checking slug fields."""
         if not params["is_save"]:
             return
         #
@@ -48,6 +51,7 @@ class SlugGroupMixin:
                         + "This field is specified in slug_sources. "
                         + "This field should be mandatory or assign a default value."
                     )
+                    logger.error(err_msg)
                     raise PanicError(err_msg)
         # Insert result.
         if params["is_save"]:
@@ -65,6 +69,7 @@ class SlugGroupMixin:
                     + f"Parameter: `slug_sources` => "
                     + "At least one field should be unique!"
                 )
+                logger.error(err_msg)
                 raise PanicError(err_msg)
             # Add value to map.
             params["result_map"][field_name] = value

ramifice/paladins/groups/text_group.py

@@ -1,4 +1,4 @@
-"""Group for checking text fields.
+"""Ramifice - Group for checking text fields.
 
 Supported fields:
     URLField | TextField | PhoneField
@@ -30,7 +30,7 @@ from ramifice.utils.tools import (
 
 
 class TextGroupMixin:
-    """Group for checking text fields.
+    """Ramifice - Group for checking text fields.
 
     Supported fields:
         URLField | TextField | PhoneField
@@ -38,7 +38,7 @@ class TextGroupMixin:
     """
 
     async def text_group(self, params: dict[str, Any]) -> None:
-        """Checking text fields."""
+        """Ramifice - Checking text fields."""
         field = params["field_data"]
         field_name = field.name
         field_type: str = field.field_type

ramifice/paladins/password.py

@@ -1,7 +1,8 @@
-"""Verification, replacement and recoverang of password."""
+"""Ramifice - Verification, replacement and recoverang of password."""
 
 __all__ = ("PasswordMixin",)
 
+import logging
 from typing import Any
 
 from argon2 import PasswordHasher
@@ -10,16 +11,18 @@ from pymongo.asynchronous.collection import AsyncCollection
 from ramifice.utils import constants
 from ramifice.utils.errors import OldPassNotMatchError, PanicError
 
+logger = logging.getLogger(__name__)
+
 
 class PasswordMixin:
-    """Verification, replacement and recoverang of password."""
+    """Ramifice - Verification, replacement and recoverang of password."""
 
     async def verify_password(
         self,
         password: str,
         field_name: str = "password",
     ) -> bool:
-        """For password verification."""
+        """Ramifice - For password verification."""
         cls_model = self.__class__
         # Get documet ID.
         doc_id = self._id.value
@@ -29,6 +32,7 @@ class PasswordMixin:
                 + "Method: `verify_password` => "
                 + "Cannot get document ID - ID field is empty."
             )
+            logger.error(msg)
             raise PanicError(msg)
         # Get collection for current Model.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls_model.META["collection_name"]]
@@ -40,6 +44,7 @@ class PasswordMixin:
                 + "Method: `verify_password` => "
                 + f"There is no document with ID `{self._id.value}` in the database."
             )
+            logger.error(msg)
             raise PanicError(msg)
         # Get password hash.
         hash: str | None = mongo_doc.get(field_name)
@@ -49,6 +54,7 @@ class PasswordMixin:
                 + "Method: `verify_password` => "
                 + f"The model does not have a field `{field_name}`."
             )
+            logger.error(msg)
             raise PanicError(msg)
         # Password verification.
         is_valid: bool = False
@@ -70,9 +76,10 @@ class PasswordMixin:
         new_password: str,
         field_name: str = "password",
     ) -> None:
-        """For replace or recover password."""
+        """Ramifice - For replace or recover password."""
         cls_model = self.__class__
         if not await self.verify_password(old_password, field_name):
+            logger.warning("Old password does not match!")
             raise OldPassNotMatchError()
         # Get documet ID.
         doc_id = self._id.value

ramifice/paladins/refrash.py

@@ -1,7 +1,8 @@
-"""Update Model instance from database."""
+"""Ramifice - Update Model instance from database."""
 
 __all__ = ("RefrashMixin",)
 
+import logging
 from typing import Any
 
 from pymongo.asynchronous.collection import AsyncCollection
@@ -10,12 +11,14 @@ from ramifice.paladins.tools import refresh_from_mongo_doc
 from ramifice.utils import constants
 from ramifice.utils.errors import PanicError
 
+logger = logging.getLogger(__name__)
+
 
 class RefrashMixin:
-    """Update Model instance from database."""
+    """Ramifice - Update Model instance from database."""
 
     async def refrash_from_db(self) -> None:
-        """Update Model instance from database."""
+        """Ramifice - Update Model instance from database."""
         cls_model = self.__class__
         # Get collection.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls_model.META["collection_name"]]
@@ -26,6 +29,7 @@ class RefrashMixin:
                 + "Method: `refrash_from_db` => "
                 + f"A document with an identifier `{self._id.value}` is not exists in the database!"
             )
+            logger.error(msg)
             raise PanicError(msg)
         self.inject()
         refresh_from_mongo_doc(self, mongo_doc)

ramifice/paladins/save.py

@@ -1,7 +1,8 @@
-"""Create or update document in database."""
+"""Ramifice - Create or update document in database."""
 
 __all__ = ("SaveMixin",)
 
+import logging
 from datetime import datetime
 from typing import Any
 
@@ -11,12 +12,14 @@ from ramifice.paladins.tools import ignored_fields_to_none, refresh_from_mongo_d
 from ramifice.utils import constants
 from ramifice.utils.errors import PanicError
 
+logger = logging.getLogger(__name__)
+
 
 class SaveMixin:
-    """Create or update document in database."""
+    """Ramifice - Create or update document in database."""
 
     async def save(self) -> bool:
-        """Create or update document in database.
+        """Ramifice - Create or update document in database.
 
         This method pre-uses the `check` method.
         """
@@ -60,6 +63,7 @@ class SaveMixin:
                     + "Method: `save` => "
                     + "Geted value is None - it is impossible to refresh the current Model."
                 )
+                logger.error(msg)
                 raise PanicError(msg)
             refresh_from_mongo_doc(self, mongo_doc)
         else:
@@ -81,6 +85,7 @@ class SaveMixin:
                     + "Method: `save` => "
                     + "Geted value is None - it is impossible to refresh the current Model."
                 )
+                logger.error(msg)
                 raise PanicError(msg)
             if mongo_doc is not None:
                 refresh_from_mongo_doc(self, mongo_doc)
@@ -90,6 +95,7 @@ class SaveMixin:
                     + "Method: `save` => "
                     + "The document was not created."
                 )
+                logger.error(msg)
                 raise PanicError(msg)
         #
         # If everything is completed successfully.

ramifice/paladins/tools.py

@@ -1,4 +1,4 @@
-"""Tool of Paladins - A set of auxiliary methods."""
+"""Ramifice - Tool of Paladins - A set of auxiliary methods."""
 
 __all__ = (
     "ignored_fields_to_none",
@@ -8,20 +8,23 @@ __all__ = (
     "check_uniqueness",
 )
 
+import logging
 from typing import Any
 
 from ramifice.utils import errors, translations
 
+logger = logging.getLogger(__name__)
+
 
 def ignored_fields_to_none(inst_model: Any) -> None:
-    """Reset the values of ignored fields to None."""
+    """Ramifice - Reset the values of ignored fields to None."""
     for _, field_data in inst_model.__dict__.items():
         if not callable(field_data) and field_data.ignored:
             field_data.value = None
 
 
 def refresh_from_mongo_doc(inst_model: Any, mongo_doc: dict[str, Any]) -> None:
-    """Update object instance from Mongo document."""
+    """Ramifice - Update object instance from Mongo document."""
     lang: str = translations.CURRENT_LOCALE
     model_dict = inst_model.__dict__
     for name, data in mongo_doc.items():
@@ -35,17 +38,18 @@ def refresh_from_mongo_doc(inst_model: Any, mongo_doc: dict[str, Any]) -> None:
 
 
 def panic_type_error(value_type: str, params: dict[str, Any]) -> None:
-    """Unacceptable type of value."""
+    """Ramifice - Unacceptable type of value."""
     msg = (
         f"Model: `{params['full_model_name']}` > "
         + f"Field: `{params['field_data'].name}` > "
         + f"Parameter: `value` => Must be `{value_type}` type!"
     )
+    logger.error(msg)
     raise errors.PanicError(msg)
 
 
 def accumulate_error(err_msg: str, params: dict[str, Any]) -> None:
-    """For accumulating errors to ModelName.field_name.errors ."""
+    """Ramifice - Accumulating errors to ModelName.field_name.errors ."""
     if not params["field_data"].hide:
         params["field_data"].errors.append(err_msg)
         if not params["is_error_symptom"]:
@@ -56,6 +60,7 @@ def accumulate_error(err_msg: str, params: dict[str, Any]) -> None:
             + f"Field: `{params['field_data'].name}`"
             + f" => {err_msg}"
         )
+        logger.error(msg)
         raise errors.PanicError(msg)
 
 
@@ -65,7 +70,7 @@ async def check_uniqueness(
     field_name: str | None = None,
     is_multi_language: bool = False,
 ) -> bool:
-    """Check the uniqueness of the value in the collection."""
+    """Ramifice - Checking the uniqueness of the value in the collection."""
     q_filter = None
     if is_multi_language:
         lang_filter = [{f"{field_name}.{lang}": value} for lang in translations.LANGUAGES]

ramifice/paladins/validation.py

@@ -1,4 +1,4 @@
-"""Validation of Model and printing errors to console."""
+"""Ramifice - Validation of Model and printing errors to console."""
 
 __all__ = ("ValidationMixin",)
 
@@ -8,10 +8,10 @@ from termcolor import colored
 
 
 class ValidationMixin:
-    """Validation of Model and printing errors to console."""
+    """Ramifice - Validation of Model and printing errors to console."""
 
     async def is_valid(self) -> bool:
-        """Check data validity.
+        """Ramifice - Check data validity.
 
         The main use is to check data from web forms.
         It is also used to verify Models that do not migrate to the database.
@@ -20,7 +20,7 @@ class ValidationMixin:
         return result_check["is_valid"]
 
     def print_err(self) -> None:
-        """Printing errors to console.
+        """Ramifice - Printing errors to console.
 
         Convenient to use during development.
         """

ramifice/utils/__init__.py

@@ -1 +1 @@
-"""A set of Ramifice useful utilities."""
+"""Ramifice - A set of Ramifice useful utilities."""

ramifice/utils/constants.py

@@ -1,4 +1,4 @@
-"""Global variables.
+"""Ramifice - Global variables.
 
 List of variables:
 

ramifice/utils/errors.py

@@ -1,15 +1,15 @@
-"""Custom Exceptions for Ramifice."""
+"""Ramifice - Custom Exceptions for Ramifice."""
 
 
 class RamificeException(Exception):
-    """Root Exception for Ramifice."""
+    """Ramifice - Root Exception for Ramifice."""
 
     def __init__(self, *args, **kwargs) -> None:  # type: ignore[no-untyped-def] # noqa: D107
         super().__init__(*args, **kwargs)
 
 
 class FileHasNoExtensionError(RamificeException):
-    """Exception raised if the file has no extension.
+    """Ramifice - Exception raised if the file has no extension.
 
     Attributes:
         message -- explanation of the error
@@ -21,7 +21,7 @@ class FileHasNoExtensionError(RamificeException):
 
 
 class DoesNotMatchRegexError(RamificeException):
-    """Exception raised if does not match the regular expression.
+    """Ramifice - Exception raised if does not match the regular expression.
 
     Attributes:
         regex_str -- regular expression in string representation
@@ -33,7 +33,7 @@ class DoesNotMatchRegexError(RamificeException):
 
 
 class NoModelsForMigrationError(RamificeException):
-    """Exception raised if no Models for migration."""
+    """Ramifice - Exception raised if no Models for migration."""
 
     def __init__(self):  # type: ignore[no-untyped-def] # noqa: D107
         self.message = "No Models for Migration!"
@@ -41,7 +41,7 @@ class NoModelsForMigrationError(RamificeException):
 
 
 class PanicError(RamificeException):
-    """Exception raised for cases of which should not be.
+    """Ramifice - Exception raised for cases of which should not be.
 
     Attributes:
         message -- explanation of the error
@@ -53,7 +53,7 @@ class PanicError(RamificeException):
 
 
 class OldPassNotMatchError(RamificeException):
-    """Exception raised if when updating the password,
+    """Ramifice - Exception raised if when updating the password,
     the old password does not match.
     """  # noqa: D205
 

ramifice/utils/fixtures.py

@@ -1,10 +1,11 @@
-"""Fixtures - To populate the database with pre-created data.
+"""Ramifice - Fixtures - To populate the database with pre-created data.
 
 Runs automatically during Model migration.
 """
 
 __all__ = ("apply_fixture",)
 
+import logging
 from datetime import datetime
 from typing import Any
 
@@ -15,13 +16,15 @@ from termcolor import colored
 
 from ramifice.utils.errors import PanicError
 
+logger = logging.getLogger(__name__)
+
 
 async def apply_fixture(
     fixture_name: str,
     cls_model: Any,
     collection: AsyncCollection,
 ) -> None:
-    """Apply fixture for current Model.
+    """Ramifice - Apply fixture for current Model.
 
     Runs automatically during Model migration.
     """
@@ -37,6 +40,7 @@ async def apply_fixture(
             + f"META param: `fixture_name` ({fixture_name}) => "
             + "It seems that fixture is empty or it has incorrect contents!"
         )
+        logger.error(msg)
         raise PanicError(msg)
 
     if data_yaml is not None:
@@ -71,6 +75,7 @@ async def apply_fixture(
                 print(colored(fixture_path, "blue", attrs=["bold"]))
                 inst_model.print_err()
                 msg = f"Fixture `{fixture_name}` failed."
+                logger.error(msg)
                 raise PanicError(msg)
             # Get data for document.
             checked_data: dict[str, Any] = result_check["data"]

ramifice/utils/migration.py

@@ -1,4 +1,4 @@
-"""Migration are `Ramifice` way of
+"""Ramifice - Migration are `Ramifice` way of
 propagating changes you make to
 your models (add or delete a Model, add or delete a field in Model, etc.) into
 your database schema.
@@ -6,6 +6,7 @@ your database schema.
 
 __all__ = ("Migration",)
 
+import logging
 from datetime import datetime
 from typing import Any
 
@@ -18,16 +19,21 @@ from ramifice.utils import constants
 from ramifice.utils.errors import DoesNotMatchRegexError, NoModelsForMigrationError, PanicError
 from ramifice.utils.fixtures import apply_fixture
 
+logger = logging.getLogger(__name__)
+
 
 class Migration:
-    """Migration of models to database."""
+    """Ramifice - Migration of models to database."""
 
     def __init__(self, database_name: str, mongo_client: AsyncMongoClient):  # noqa: D107
         constants.DEBUG = False
         #
         db_name_regex = constants.REGEX["database_name"]
         if db_name_regex.match(database_name) is None:
-            raise DoesNotMatchRegexError("^[a-zA-Z][-_a-zA-Z0-9]{0,59}$")
+            regex_str: str = "^[a-zA-Z][-_a-zA-Z0-9]{0,59}$"
+            msg: str = f"Does not match the regular expression: {regex_str}"
+            logger.error(msg)
+            raise DoesNotMatchRegexError(regex_str)
         #
         constants.DATABASE_NAME = database_name
         constants.MONGO_CLIENT = mongo_client
@@ -36,10 +42,11 @@ class Migration:
         self.model_list: list[Any] = Model.__subclasses__()
         # Raise the exception if there are no models for migration.
         if len(self.model_list) == 0:
+            logger.error("No Models for Migration!")
             raise NoModelsForMigrationError()  # type: ignore[no-untyped-call]
 
     async def reset(self) -> None:
-        """Reset the condition of the models in a super collection.
+        """Ramifice - Reset the condition of the models in a super collection.
 
         Switch the `is_model_exist` parameter in the condition `False`.
         """
@@ -55,7 +62,7 @@ class Migration:
             await super_collection.update_one(q_filter, update)
 
     async def model_state(self, metadata: dict[str, Any]) -> dict[str, Any]:
-        """Get the state of the current model from a super collection."""
+        """Ramifice - Get the state of the current model from a super collection."""
         # Get access to super collection.
         # (Contains Model state and dynamic field data.)
         super_collection: AsyncCollection = constants.MONGO_DATABASE[
@@ -79,7 +86,7 @@ class Migration:
         return model_state
 
     def new_fields(self, metadata: dict[str, Any], model_state: dict[str, Any]) -> list[str]:
-        """Get a list of new fields that were added to Model."""
+        """Ramifice - Get a list of new fields that were added to Model."""
         new_fields: list[str] = []
         for field_name, field_type in metadata["field_name_and_type"].items():
             old_field_type: str | None = model_state["field_name_and_type"].get(field_name)
@@ -88,7 +95,7 @@ class Migration:
         return new_fields
 
     async def napalm(self) -> None:
-        """Delete data for non-existent Models from a super collection,
+        """Ramifice - Delete data for non-existent Models from a super collection,
         delete collections associated with those Models.
         """  # noqa: D205
         # Get access to database.
@@ -109,7 +116,7 @@ class Migration:
                 await database.drop_collection(collection_name)  # type: ignore[union-attr]
 
     async def migrate(self) -> None:
-        """Run migration process.
+        """Ramifice - Run migration process.
 
         1) Update the state of Models in the super collection.
         2) Register new Models in the super collection.
@@ -167,7 +174,9 @@ class Migration:
                     if not result_check["is_valid"]:
                         print(colored("\n!!!>>MIGRATION<<!!!", "red", attrs=["bold"]))
                         inst_model.print_err()
-                        raise PanicError("Migration failed.")
+                        msg: str = "Migration failed."
+                        logger.error(msg)
+                        raise PanicError(msg)
                     # Get checked data.
                     checked_data = result_check["data"]
                     # Add password from mongo_doc to checked_data.

ramifice/utils/mixins/__init__.py

@@ -1,4 +1,4 @@
-"""A set of mixins for Ramifice."""
+"""Ramifice - Set of mixins for Models and Fields."""
 
 from ramifice.utils.mixins.add_valid import AddValidMixin
 from ramifice.utils.mixins.hooks import HooksMixin

ramifice/utils/mixins/add_valid.py

@@ -1,4 +1,4 @@
-"""AddValidMixin - Contains an abstract method for additional validation of fields."""
+"""Ramifice - AddValidMixin - Contains an abstract method for additional validation of fields."""
 
 __all__ = ("AddValidMixin",)
 
@@ -6,9 +6,9 @@ from abc import ABCMeta
 
 
 class AddValidMixin(metaclass=ABCMeta):
-    """Contains an abstract method for additional validation of fields."""
+    """Ramifice - Contains an abstract method for additional validation of fields."""
 
     async def add_validation(self) -> dict[str, str]:
-        """Additional validation of fields."""
+        """Ramifice - Additional validation of fields."""
         error_map: dict[str, str] = {}
         return error_map

ramifice/utils/mixins/hooks.py

@@ -1,4 +1,4 @@
-"""HooksMixin - Contains abstract methods for creating hooks."""
+"""Ramifice - HooksMixin - Contains abstract methods for creating hooks."""
 
 __all__ = ("HooksMixin",)
 
@@ -6,22 +6,22 @@ from abc import ABCMeta
 
 
 class HooksMixin(metaclass=ABCMeta):
-    """A set of abstract methods for creating hooks."""
+    """Ramifice - A set of abstract methods for creating hooks."""
 
     async def pre_create(self) -> None:
-        """Called before a new document is created in the database."""
+        """Ramifice - Called before a new document is created in the database."""
 
     async def post_create(self) -> None:
-        """Called after a new document has been created in the database."""
+        """Ramifice - Called after a new document has been created in the database."""
 
     async def pre_update(self) -> None:
-        """Called before updating an existing document in the database."""
+        """Ramifice - Called before updating an existing document in the database."""
 
     async def post_update(self) -> None:
-        """Called after an existing document in the database is updated."""
+        """Ramifice - Called after an existing document in the database is updated."""
 
     async def pre_delete(self) -> None:
-        """Called before deleting an existing document in the database."""
+        """Ramifice - Called before deleting an existing document in the database."""
 
     async def post_delete(self) -> None:
-        """Called after an existing document in the database has been deleted."""
+        """Ramifice - Called after an existing document in the database has been deleted."""

ramifice/utils/mixins/indexing.py

@@ -1,4 +1,4 @@
-"""IndexMixin - Contains abstract method for indexing the model in the database."""
+"""Ramifice - IndexMixin - Contains abstract method for indexing the model in the database."""
 
 __all__ = ("IndexMixin",)
 
@@ -6,8 +6,8 @@ from abc import ABCMeta
 
 
 class IndexMixin(metaclass=ABCMeta):
-    """Contains the method for indexing the model in the database."""
+    """Ramifice - Contains the method for indexing the model in the database."""
 
     @classmethod
     async def indexing(cls) -> None:
-        """For set up and start indexing."""
+        """Ramifice - Set up and start indexing."""

ramifice/utils/mixins/json_converter.py

@@ -1,4 +1,4 @@
-"""JsonMixin - Contains the methods for converting Fields to JSON and back."""
+"""Ramifice - JsonMixin - Contains the methods for converting Fields to JSON and back."""
 
 __all__ = ("JsonMixin",)
 
@@ -8,10 +8,10 @@ import orjson
 
 
 class JsonMixin:
-    """Contains the methods for converting Fields to JSON and back."""
+    """Ramifice - Contains the methods for converting Fields to JSON and back."""
 
     def to_dict(self) -> dict[str, Any]:
-        """Convert object instance to a dictionary."""
+        """Ramifice - Convert object instance to a dictionary."""
         json_dict: dict[str, Any] = {}
         for name, data in self.__dict__.items():
             if not callable(data):
@@ -19,12 +19,12 @@ class JsonMixin:
         return json_dict
 
     def to_json(self) -> str:
-        """Convert object instance to a JSON string."""
+        """Ramifice - Convert object instance to a JSON string."""
         return orjson.dumps(self.to_dict()).decode("utf-8")
 
     @classmethod
     def from_dict(cls, json_dict: dict[str, Any]) -> Any:
-        """Convert JSON string to a object instance."""
+        """Ramifice - Convert JSON string to a object instance."""
         obj = cls()
         for name, data in json_dict.items():
             obj.__dict__[name] = data
@@ -32,6 +32,6 @@ class JsonMixin:
 
     @classmethod
     def from_json(cls, json_str: str) -> Any:
-        """Convert JSON string to a object instance."""
+        """Ramifice - Convert JSON string to a object instance."""
         json_dict = orjson.loads(json_str)
         return cls.from_dict(json_dict)