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

ramifice/paladins/__init__.py

@@ -1,4 +1,19 @@
-"""Ramifice - Paladins - Model instance methods."""
+"""Paladins - Model instance methods.
+
+This module provides:
+
+- `add_validation`: Contains an abstract method for additional validation of fields.
+- `check`: Validation of Model data before saving to the database.
+- `delete`: Delete document from database.
+- `Hooks`: A set of abstract methods for creating hooks.
+- `indexing`: Contains the method for indexing the model in the database.
+- `password`: Verification, replacement and recoverang of password.
+- `refrash_from_db`: Update Model instance from database.
+- `save`: Create or update document in database.
+- `Tools`: A set of auxiliary methods.
+- `is_valid`: Validation of Model.
+- `print_err`: Printing errors to console.
+"""
 
 __all__ = ("QPaladinsMixin",)
 
@@ -24,7 +39,7 @@ class QPaladinsMixin(
     HooksMixin,
     IndexMixin,
 ):
-    """Ramifice - Paladins - Model instance methods."""
+    """Paladins - Model instance methods."""
 
     def __init__(self) -> None:  # noqa: D107
         super().__init__()

ramifice/paladins/add_valid.py

@@ -1,4 +1,4 @@
-"""Ramifice - AddValidMixin - Contains an abstract method for additional validation of fields."""
+"""AddValidMixin - Contains an abstract method for additional validation of fields."""
 
 __all__ = ("AddValidMixin",)
 
@@ -8,8 +8,8 @@ from xloft import NamedTuple
 
 
 class AddValidMixin(metaclass=ABCMeta):
-    """Ramifice - Contains an abstract method for additional validation of fields."""
+    """Contains an abstract method for additional validation of fields."""
 
     async def add_validation(self) -> NamedTuple:
-        """Ramifice - Additional validation of fields."""
+        """Additional validation of fields."""
         return NamedTuple()

ramifice/paladins/check.py

@@ -1,4 +1,4 @@
-"""Ramifice - Validation of Model data before saving to the database."""
+"""Validation of Model data before saving to the database."""
 
 __all__ = ("CheckMixin",)
 
@@ -40,7 +40,7 @@ class CheckMixin(
     SlugGroupMixin,
     TextGroupMixin,
 ):
-    """Ramifice - Validation of Model data before saving to the database."""
+    """Validation of Model data before saving to the database."""
 
     async def check(
         self,
@@ -48,7 +48,7 @@ class CheckMixin(
         collection: AsyncCollection | None = None,
         is_migration_process: bool = False,
     ) -> dict[str, Any]:
-        """Ramifice - Validation of Model data before saving to the database.
+        """Validation of Model data before saving to the database.
 
         It is also used to verify Models that do not migrate to the database.
         """

ramifice/paladins/delete.py

@@ -1,4 +1,4 @@
-"""Ramifice - Delete document from database."""
+"""Delete document from database."""
 
 __all__ = ("DeleteMixin",)
 
@@ -17,7 +17,7 @@ logger = logging.getLogger(__name__)
 
 
 class DeleteMixin:
-    """Ramifice - Delete document from database."""
+    """Delete document from database."""
 
     async def delete(
         self,
@@ -30,7 +30,7 @@ class DeleteMixin:
         comment: Any | None = None,
         **kwargs: dict[str, Any],
     ) -> dict[str, Any]:
-        """Ramifice - Delete document from database."""
+        """Delete document from database."""
         cls_model = self.__class__
         # Raises a panic if the Model cannot be removed.
         if not cls_model.META["is_delete_doc"]:

ramifice/paladins/groups/__init__.py

@@ -1,4 +1,4 @@
-"""Ramifice - Groups - Model instance methods for specific processing of fields."""
+"""Groups - Model instance methods for specific processing of fields."""
 
 __all__ = (
     "BoolGroupMixin",

ramifice/paladins/groups/bool_group.py

@@ -1,4 +1,4 @@
-"""Ramifice - Group for checking boolean fields.
+"""Group for checking boolean fields.
 
 Supported fields:
     BooleanField
@@ -12,14 +12,14 @@ from ramifice.paladins.tools import panic_type_error
 
 
 class BoolGroupMixin:
-    """Ramifice - Group for checking boolean fields.
+    """Group for checking boolean fields.
 
     Supported fields:
         BooleanField
     """
 
     def bool_group(self, params: dict[str, Any]) -> None:
-        """Ramifice - Checking boolean fields."""
+        """Checking boolean fields."""
         field = params["field_data"]
         # Get current value.
         value = field.value

ramifice/paladins/groups/choice_group.py

@@ -1,4 +1,4 @@
-"""Ramifice - Group for checking choice fields.
+"""Group for checking choice fields.
 
 Supported fields:
     ChoiceTextMultField | ChoiceTextMultDynField | ChoiceTextField
@@ -16,7 +16,7 @@ from ramifice.utils import translations
 
 
 class ChoiceGroupMixin:
-    """Ramifice - Group for checking choice fields.
+    """Group for checking choice fields.
 
     Supported fields:
             ChoiceTextMultField | ChoiceTextMultDynField | ChoiceTextField
@@ -26,7 +26,7 @@ class ChoiceGroupMixin:
     """
 
     def choice_group(self, params: dict[str, Any]) -> None:
-        """Ramifice - Checking choice fields."""
+        """Checking choice fields."""
         field = params["field_data"]
         is_migrate = params["is_migration_process"]
         # Get current value.

ramifice/paladins/groups/date_group.py

@@ -1,4 +1,4 @@
-"""Ramifice - Group for checking date fields.
+"""Group for checking date fields.
 
 Supported fields:
     DateTimeField | DateField
@@ -19,14 +19,14 @@ from ramifice.utils import translations
 
 
 class DateGroupMixin:
-    """Ramifice - Group for checking date fields.
+    """Group for checking date fields.
 
     Supported fields:
         DateTimeField | DateField
     """
 
     def date_group(self, params: dict[str, Any]) -> None:
-        """Ramifice - Checking date fields."""
+        """Checking date fields."""
         field = params["field_data"]
         # Get current value.
         value = field.value or field.default or None

ramifice/paladins/groups/file_group.py

@@ -1,4 +1,4 @@
-"""Ramifice - Group for checking file fields.
+"""Group for checking file fields.
 
 Supported fields: FileField
 """
@@ -16,13 +16,13 @@ from ramifice.utils.tools import to_human_size
 
 
 class FileGroupMixin:
-    """Ramifice - Group for checking file fields.
+    """Group for checking file fields.
 
     Supported fields: FileField
     """
 
     async def file_group(self, params: dict[str, Any]) -> None:
-        """Ramifice - Checking file fields."""
+        """Checking file fields."""
         field = params["field_data"]
         value = field.value or None
 

ramifice/paladins/groups/id_group.py

@@ -1,4 +1,4 @@
-"""Ramifice - Group for checking id fields.
+"""Group for checking id fields.
 
 Supported fields:
     IDField
@@ -15,14 +15,14 @@ from ramifice.utils import translations
 
 
 class IDGroupMixin:
-    """Ramifice - Group for checking id fields.
+    """Group for checking id fields.
 
     Supported fields:
         IDField
     """
 
     def id_group(self, params: dict[str, Any]) -> None:
-        """Ramifice - Checking id fields."""
+        """Checking id fields."""
         field = params["field_data"]
         # Get current value.
         value = field.value

ramifice/paladins/groups/img_group.py

@@ -1,4 +1,4 @@
-"""Ramifice - Group for checking image fields.
+"""Group for checking image fields.
 
 Supported fields: ImageField
 """
@@ -16,13 +16,13 @@ from ramifice.utils.tools import to_human_size
 
 
 class ImgGroupMixin:
-    """Ramifice - Group for checking image fields.
+    """Group for checking image fields.
 
     Supported fields: ImageField
     """
 
     async def img_group(self, params: dict[str, Any]) -> None:
-        """Ramifice - Checking image fields."""
+        """Checking image fields."""
         field = params["field_data"]
         value = field.value or None
 

ramifice/paladins/groups/num_group.py

@@ -1,4 +1,4 @@
-"""Ramifice - Group for checking integer fields.
+"""Group for checking integer fields.
 
 Supported fields:
     IntegerField | FloatField
@@ -17,14 +17,14 @@ from ramifice.utils import translations
 
 
 class NumGroupMixin:
-    """Ramifice - Group for checking integer fields.
+    """Group for checking integer fields.
 
     Supported fields:
         IntegerField | FloatField
     """
 
     async def num_group(self, params: dict[str, Any]) -> None:
-        """Ramifice - Checking number fields."""
+        """Checking number fields."""
         field = params["field_data"]
         field_name = field.name
         # Get current value.

ramifice/paladins/groups/pass_group.py

@@ -1,4 +1,4 @@
-"""Ramifice - Group for checking password fields.
+"""Group for checking password fields.
 
 Supported fields: PasswordField
 """
@@ -15,13 +15,13 @@ from ramifice.utils.tools import is_password
 
 
 class PassGroupMixin:
-    """Ramifice - Group for checking password fields.
+    """Group for checking password fields.
 
     Supported fields: PasswordField
     """
 
     def pass_group(self, params: dict[str, Any]) -> None:
-        """Ramifice - Checking password fields."""
+        """Checking password fields."""
         field = params["field_data"]
         # When updating the document, skip the verification.
         if params["is_update"]:

ramifice/paladins/groups/slug_group.py

@@ -1,4 +1,4 @@
-"""Ramifice - Group for checking slug fields.
+"""Group for checking slug fields.
 
 Supported fields:
     SlugField
@@ -18,14 +18,14 @@ logger = logging.getLogger(__name__)
 
 
 class SlugGroupMixin:
-    """Ramifice - Group for checking slug fields.
+    """Group for checking slug fields.
 
     Supported fields:
         SlugField
     """
 
     async def slug_group(self, params: dict[str, Any]) -> None:
-        """Ramifice - Checking slug fields."""
+        """Checking slug fields."""
         if not params["is_save"]:
             return
         #

ramifice/paladins/groups/text_group.py

@@ -1,4 +1,4 @@
-"""Ramifice - Group for checking text fields.
+"""Group for checking text fields.
 
 Supported fields:
     URLField | TextField | PhoneField
@@ -30,7 +30,7 @@ from ramifice.utils.tools import (
 
 
 class TextGroupMixin:
-    """Ramifice - Group for checking text fields.
+    """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:
-        """Ramifice - Checking text fields."""
+        """Checking text fields."""
         field = params["field_data"]
         field_name = field.name
         field_type: str = field.field_type

ramifice/paladins/hooks.py

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

ramifice/paladins/indexing.py

@@ -1,4 +1,4 @@
-"""Ramifice - IndexMixin - Contains abstract method for indexing the model in the database."""
+"""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):
-    """Ramifice - Contains the method for indexing the model in the database."""
+    """Contains the method for indexing the model in the database."""
 
     @classmethod
     async def indexing(cls) -> None:
-        """Ramifice - Set up and start indexing."""
+        """Set up and start indexing."""

ramifice/paladins/password.py

@@ -1,4 +1,4 @@
-"""Ramifice - Verification, replacement and recoverang of password."""
+"""Verification, replacement and recoverang of password."""
 
 __all__ = ("PasswordMixin",)
 
@@ -15,14 +15,14 @@ logger = logging.getLogger(__name__)
 
 
 class PasswordMixin:
-    """Ramifice - Verification, replacement and recoverang of password."""
+    """Verification, replacement and recoverang of password."""
 
     async def verify_password(
         self,
         password: str,
         field_name: str = "password",
     ) -> bool:
-        """Ramifice - For password verification."""
+        """For password verification."""
         cls_model = self.__class__
         # Get documet ID.
         doc_id = self._id.value
@@ -76,7 +76,7 @@ class PasswordMixin:
         new_password: str,
         field_name: str = "password",
     ) -> None:
-        """Ramifice - For replace or recover password."""
+        """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!")

ramifice/paladins/refrash.py

@@ -1,4 +1,4 @@
-"""Ramifice - Update Model instance from database."""
+"""Update Model instance from database."""
 
 __all__ = ("RefrashMixin",)
 
@@ -15,10 +15,10 @@ logger = logging.getLogger(__name__)
 
 
 class RefrashMixin:
-    """Ramifice - Update Model instance from database."""
+    """Update Model instance from database."""
 
     async def refrash_from_db(self) -> None:
-        """Ramifice - Update Model instance from database."""
+        """Update Model instance from database."""
         cls_model = self.__class__
         # Get collection.
         collection: AsyncCollection = constants.MONGO_DATABASE[cls_model.META["collection_name"]]

ramifice/paladins/save.py

@@ -1,4 +1,4 @@
-"""Ramifice - Create or update document in database."""
+"""Create or update document in database."""
 
 __all__ = ("SaveMixin",)
 
@@ -16,10 +16,10 @@ logger = logging.getLogger(__name__)
 
 
 class SaveMixin:
-    """Ramifice - Create or update document in database."""
+    """Create or update document in database."""
 
     async def save(self) -> bool:
-        """Ramifice - Create or update document in database.
+        """Create or update document in database.
 
         This method pre-uses the `check` method.
         """

ramifice/paladins/tools.py

@@ -1,4 +1,4 @@
-"""Ramifice - Tool of Paladins - A set of auxiliary methods."""
+"""Tool of Paladins - A set of auxiliary methods."""
 
 __all__ = (
     "ignored_fields_to_none",
@@ -17,14 +17,14 @@ logger = logging.getLogger(__name__)
 
 
 def ignored_fields_to_none(inst_model: Any) -> None:
-    """Ramifice - Reset the values of ignored fields to None."""
+    """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:
-    """Ramifice - Update object instance from Mongo document."""
+    """Update object instance from Mongo document."""
     lang: str = translations.CURRENT_LOCALE
     model_dict = inst_model.__dict__
     for name, data in mongo_doc.items():
@@ -38,7 +38,7 @@ 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:
-    """Ramifice - Unacceptable type of value."""
+    """Unacceptable type of value."""
     msg = (
         f"Model: `{params['full_model_name']}` > "
         + f"Field: `{params['field_data'].name}` > "
@@ -49,7 +49,7 @@ def panic_type_error(value_type: str, params: dict[str, Any]) -> None:
 
 
 def accumulate_error(err_msg: str, params: dict[str, Any]) -> None:
-    """Ramifice - Accumulating errors to ModelName.field_name.errors ."""
+    """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"]:
@@ -70,7 +70,7 @@ async def check_uniqueness(
     field_name: str | None = None,
     is_multi_language: bool = False,
 ) -> bool:
-    """Ramifice - Checking the uniqueness of the value in the collection."""
+    """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 @@
-"""Ramifice - Validation of Model and printing errors to console."""
+"""Validation of Model and printing errors to console."""
 
 __all__ = ("ValidationMixin",)
 
@@ -8,10 +8,10 @@ from termcolor import colored
 
 
 class ValidationMixin:
-    """Ramifice - Validation of Model and printing errors to console."""
+    """Validation of Model and printing errors to console."""
 
     async def is_valid(self) -> bool:
-        """Ramifice - Check data validity.
+        """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:
-        """Ramifice - Printing errors to console.
+        """Printing errors to console.
 
         Convenient to use during development.
         """

ramifice/utils/__init__.py

@@ -1 +1,13 @@
-"""Ramifice - A set of Ramifice useful utilities."""
+"""A set of Ramifice useful utilities.
+
+This module includes:
+
+- `constants` - Global variables.
+- `errors` - Custom Exceptions for Ramifice.
+- `fixtures` - To populate the database with pre-created data.
+- `migration` - Migration of models to database.
+- `mixins` - Set of mixins for Models and Fields.
+- `tools` - Global collection of auxiliary methods.
+- `translations` - Localization of translations.
+- `unit` - Data management in dynamic fields.
+"""

ramifice/utils/constants.py

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