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

ramifice/fields/float_field.py

@@ -1,15 +1,20 @@
-"""Field of Model for enter (float) number."""
+"""Ramifice - Field of Model for enter (float) number."""
 
 __all__ = ("FloatField",)
 
+import logging
+from typing import Literal
+
 from ramifice.fields.general.field import Field
 from ramifice.fields.general.number_group import NumberGroup
 from ramifice.utils import constants
 from ramifice.utils.mixins.json_converter import JsonMixin
 
+logger = logging.getLogger(__name__)
+
 
 class FloatField(Field, NumberGroup, JsonMixin):
-    """Field of Model for enter (float) number."""
+    """Ramifice - Field of Model for enter (float) number."""
 
     def __init__(  # noqa: D107
         self,
@@ -27,53 +32,57 @@ class FloatField(Field, NumberGroup, JsonMixin):
         max_number: float | None = None,
         min_number: float | None = None,
         step: float = 1.0,
-        input_type: str = "number",  # number | range
+        input_type: Literal["number", "range"] = "number",
     ):
         if constants.DEBUG:
-            if input_type not in ["number", "range"]:
-                raise AssertionError(
-                    "Parameter `input_type` - Invalid input type! "
-                    + "The permissible value of `number` or `range`."
-                )
-            if max_number is not None and not isinstance(max_number, float):
-                raise AssertionError("Parameter `max_number` - Not а number `float` type!")
-            if min_number is not None and not isinstance(min_number, float):
-                raise AssertionError("Parameter `min_number` - Not а number `float` type!")
-            if not isinstance(step, float):
-                raise AssertionError("Parameter `step` - Not а number `float` type!")
-            if max_number is not None and min_number is not None and max_number <= min_number:
-                raise AssertionError(
-                    "The `max_number` parameter should be more than the `min_number`!"
-                )
-            if default is not None:
-                if not isinstance(default, float):
-                    raise AssertionError("Parameter `default` - Not а number `float` type!")
-                if max_number is not None and default > max_number:
-                    raise AssertionError("Parameter `default` is more `max_number`!")
-                if max_number is not None and default < min_number:  # type: ignore
-                    raise AssertionError("Parameter `default` is less `min_number`!")
-            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(placeholder, str):
-                raise AssertionError("Parameter `placeholder` - Not а `str` 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!")
-            if not isinstance(unique, bool):
-                raise AssertionError("Parameter `unique` - Not а `bool` type!")
+            try:
+                if input_type not in ["number", "range"]:
+                    raise AssertionError(
+                        "Parameter `input_type` - Invalid input type! "
+                        + "The permissible value of `number` or `range`."
+                    )
+                if max_number is not None and not isinstance(max_number, float):
+                    raise AssertionError("Parameter `max_number` - Not а number `float` type!")
+                if min_number is not None and not isinstance(min_number, float):
+                    raise AssertionError("Parameter `min_number` - Not а number `float` type!")
+                if not isinstance(step, float):
+                    raise AssertionError("Parameter `step` - Not а number `float` type!")
+                if max_number is not None and min_number is not None and max_number <= min_number:
+                    raise AssertionError(
+                        "The `max_number` parameter should be more than the `min_number`!"
+                    )
+                if default is not None:
+                    if not isinstance(default, float):
+                        raise AssertionError("Parameter `default` - Not а number `float` type!")
+                    if max_number is not None and default > max_number:
+                        raise AssertionError("Parameter `default` is more `max_number`!")
+                    if max_number is not None and default < min_number:  # type: ignore
+                        raise AssertionError("Parameter `default` is less `min_number`!")
+                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(placeholder, str):
+                    raise AssertionError("Parameter `placeholder` - Not а `str` 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!")
+                if not isinstance(unique, bool):
+                    raise AssertionError("Parameter `unique` - Not а `bool` type!")
+            except AssertionError as err:
+                logger.error(str(err))
+                raise err
 
         Field.__init__(
             self,

ramifice/fields/general/__init__.py

@@ -1 +1 @@
-"""Abstract classes for the fields."""
+"""Ramifice - Abstract classes for the fields."""

ramifice/fields/general/choice_group.py

@@ -1,4 +1,4 @@
-"""General additional parameters for choice fields."""
+"""Ramifice - General additional parameters for choice fields."""
 
 __all__ = ("ChoiceGroup",)
 
@@ -6,7 +6,7 @@ from abc import ABCMeta
 
 
 class ChoiceGroup(metaclass=ABCMeta):
-    """General additional parameters for choice fields.
+    """Ramifice - General additional parameters for choice fields.
 
     Attributes:
         input_type -- Input type for a web form field.

ramifice/fields/general/date_group.py

@@ -1,4 +1,4 @@
-"""General additional parameters for date|datetime fields."""
+"""Ramifice - General additional parameters for date|datetime fields."""
 
 __all__ = ("DateGroup",)
 
@@ -7,7 +7,7 @@ from datetime import datetime
 
 
 class DateGroup(metaclass=ABCMeta):
-    """General additional parameters for date|datetime fields.
+    """Ramifice - General additional parameters for date|datetime fields.
 
     Attributes:
         input_type -- Input type for a web form field.

ramifice/fields/general/field.py

@@ -1,4 +1,4 @@
-"""General parameters for all types fields of Model."""
+"""Ramifice - General parameters for all types fields of Model."""
 
 __all__ = ("Field",)
 
@@ -6,7 +6,7 @@ from abc import ABCMeta
 
 
 class Field(metaclass=ABCMeta):
-    """General parameters for all types fields of Model.
+    """Ramifice - General parameters for all types fields of Model.
 
     Attributes:
         label -- Text label for a web form field.

ramifice/fields/general/file_group.py

@@ -1,4 +1,4 @@
-"""General additional parameters for file fields."""
+"""Ramifice - General additional parameters for file fields."""
 
 __all__ = ("FileGroup",)
 
@@ -6,7 +6,7 @@ from abc import ABCMeta
 
 
 class FileGroup(metaclass=ABCMeta):
-    """General additional parameters for file fields.
+    """Ramifice - General additional parameters for file fields.
 
     Attributes:
         placeholder -- Displays prompt text.

ramifice/fields/general/number_group.py

@@ -1,4 +1,4 @@
-"""General additional parameters for number fields."""
+"""Ramifice - General additional parameters for number fields."""
 
 __all__ = ("NumberGroup",)
 
@@ -6,7 +6,7 @@ from abc import ABCMeta
 
 
 class NumberGroup(metaclass=ABCMeta):
-    """General additional parameters for number fields.
+    """Ramifice - General additional parameters for number fields.
 
     Attributes:
         placeholder -- Displays prompt text.

ramifice/fields/general/text_group.py

@@ -1,4 +1,4 @@
-"""General additional parameters for text fields."""
+"""Ramifice - General additional parameters for text fields."""
 
 __all__ = ("TextGroup",)
 
@@ -6,7 +6,7 @@ from abc import ABCMeta
 
 
 class TextGroup(metaclass=ABCMeta):
-    """General additional parameters for text fields.
+    """Ramifice - General additional parameters for text fields.
 
     Attributes:
         input_type -- Input type for a web form field.
@@ -32,7 +32,7 @@ class TextGroup(metaclass=ABCMeta):
         self.unique = unique
 
     def __len__(self) -> int:
-        """Return length of field `value`."""
+        """Ramifice - Return length of field `value`."""
         value = self.value
         if value is None:
             return 0

ramifice/fields/id_field.py

@@ -1,7 +1,8 @@
-"""Field of Model for enter identifier of document."""
+"""Ramifice - Field of Model for enter identifier of document."""
 
 __all__ = ("IDField",)
 
+import logging
 from typing import Any
 
 import orjson
@@ -10,9 +11,11 @@ from bson.objectid import ObjectId
 from ramifice.fields.general.field import Field
 from ramifice.utils import constants
 
+logger = logging.getLogger(__name__)
+
 
 class IDField(Field):
-    """Field of Model for enter identifier of document.
+    """Ramifice - Field of Model for enter identifier of document.
 
     Attributes:
         input_type -- Input type for a web form field.
@@ -36,28 +39,32 @@ class IDField(Field):
         unique: 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(placeholder, str):
-                raise AssertionError("Parameter `placeholder` - Not а `str` 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!")
-            if not isinstance(unique, bool):
-                raise AssertionError("Parameter `unique` - 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(placeholder, str):
+                    raise AssertionError("Parameter `placeholder` - Not а `str` 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!")
+                if not isinstance(unique, bool):
+                    raise AssertionError("Parameter `unique` - Not а `bool` type!")
+            except AssertionError as err:
+                logger.error(str(err))
+                raise err
 
         Field.__init__(
             self,
@@ -80,7 +87,7 @@ class IDField(Field):
         self.alerts: list[str] = []
 
     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):
@@ -91,12 +98,12 @@ class IDField(Field):
         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():
             if name == "value" and data is not None:
@@ -107,6 +114,6 @@ class IDField(Field):
 
     @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)

ramifice/fields/image_field.py

@@ -1,7 +1,8 @@
-"""Field of Model for upload image."""
+"""Ramifice - Field of Model for upload image."""
 
 __all__ = ("ImageField",)
 
+import logging
 import uuid
 from base64 import b64decode
 from datetime import date
@@ -18,9 +19,11 @@ from ramifice.utils.constants import MEDIA_ROOT, MEDIA_URL
 from ramifice.utils.errors import FileHasNoExtensionError
 from ramifice.utils.mixins.json_converter import JsonMixin
 
+logger = logging.getLogger(__name__)
+
 
 class ImageField(Field, FileGroup, JsonMixin):
-    """Field of Model for upload image."""
+    """Ramifice - Field of Model for upload image."""
 
     def __init__(  # noqa: D107
         self,
@@ -42,62 +45,66 @@ class ImageField(Field, FileGroup, JsonMixin):
         thumbnails: dict[str, int] | None = None,
     ):
         if constants.DEBUG:
-            if default is not None:
-                if not isinstance(default, str):
-                    raise AssertionError("Parameter `default` - Not а `str` type!")
-                if len(default) == 0:
-                    raise AssertionError(
-                        "The `default` parameter should not contain an empty string!"
-                    )
-            if thumbnails is not None:
-                if not isinstance(thumbnails, dict):
-                    raise AssertionError("Parameter `thumbnails` - Not а `dict` type!")
-                if len(thumbnails) == 0:
-                    raise AssertionError(
-                        "The `thumbnails` parameter should not contain an empty dictionary!"
-                    )
-                size_name_list = ["lg", "md", "sm", "xs"]
-                curr_size_thumb: int = 0
-                for size_name in thumbnails.keys():
-                    if size_name not in size_name_list:
+            try:
+                if default is not None:
+                    if not isinstance(default, str):
+                        raise AssertionError("Parameter `default` - Not а `str` type!")
+                    if len(default) == 0:
+                        raise AssertionError(
+                            "The `default` parameter should not contain an empty string!"
+                        )
+                if thumbnails is not None:
+                    if not isinstance(thumbnails, dict):
+                        raise AssertionError("Parameter `thumbnails` - Not а `dict` type!")
+                    if len(thumbnails) == 0:
                         raise AssertionError(
-                            f"The `thumbnails` parameter contains an unacceptable size name `{size_name}`!\n"
-                            + " Allowed names: lg, md, sm, xs.\n"
-                            + " Use all sizes is not necessary.",
+                            "The `thumbnails` parameter should not contain an empty dictionary!"
                         )
-                    max_size_thumb: int | None = thumbnails.get(size_name)
-                    if max_size_thumb is not None:
-                        if curr_size_thumb > 0 and max_size_thumb >= curr_size_thumb:
+                    size_name_list = ["lg", "md", "sm", "xs"]
+                    curr_size_thumb: int = 0
+                    for size_name in thumbnails.keys():
+                        if size_name not in size_name_list:
                             raise AssertionError(
-                                "The `thumbnails` parameter -> "
-                                + f"The `{size_name}` key should be less than a previous size!"
-                                + 'Example: {"lg": 1200, "md": 600, "sm": 300, "xs": 150 }'
+                                f"The `thumbnails` parameter contains an unacceptable size name `{size_name}`!\n"
+                                + " Allowed names: lg, md, sm, xs.\n"
+                                + " Use all sizes is not necessary.",
                             )
-                        curr_size_thumb = max_size_thumb
-            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(placeholder, str):
-                raise AssertionError("Parameter `placeholder` - Not а `str` type!")
-            if not isinstance(required, bool):
-                raise AssertionError("Parameter `required` - Not а `bool` type!")
-            if not isinstance(max_size, int):
-                raise AssertionError("Parameter `max_size` - Not а `int` type!")
-            if not isinstance(target_dir, str):
-                raise AssertionError("Parameter `target_dir` - Not а `str` type!")
-            if not isinstance(accept, str):
-                raise AssertionError("Parameter `accept` - Not а `str` type!")
+                        max_size_thumb: int | None = thumbnails.get(size_name)
+                        if max_size_thumb is not None:
+                            if curr_size_thumb > 0 and max_size_thumb >= curr_size_thumb:
+                                raise AssertionError(
+                                    "The `thumbnails` parameter -> "
+                                    + f"The `{size_name}` key should be less than a previous size!"
+                                    + 'Example: {"lg": 1200, "md": 600, "sm": 300, "xs": 150 }'
+                                )
+                            curr_size_thumb = max_size_thumb
+                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(placeholder, str):
+                    raise AssertionError("Parameter `placeholder` - Not а `str` type!")
+                if not isinstance(required, bool):
+                    raise AssertionError("Parameter `required` - Not а `bool` type!")
+                if not isinstance(max_size, int):
+                    raise AssertionError("Parameter `max_size` - Not а `int` type!")
+                if not isinstance(target_dir, str):
+                    raise AssertionError("Parameter `target_dir` - Not а `str` type!")
+                if not isinstance(accept, str):
+                    raise AssertionError("Parameter `accept` - Not а `str` type!")
+            except AssertionError as err:
+                logger.error(str(err))
+                raise err
 
         Field.__init__(
             self,
@@ -132,7 +139,7 @@ class ImageField(Field, FileGroup, JsonMixin):
         filename: str | None = None,
         is_delete: bool = False,
     ) -> None:
-        """Convert base64 to a image,
+        """Ramifice - Convert base64 to a image,
         get image information and save in the target directory.
         """  # noqa: D205
         base64_str = base64_str or None
@@ -145,7 +152,9 @@ class ImageField(Field, FileGroup, JsonMixin):
             # Get file extension.
             extension = Path(filename).suffix
             if len(extension) == 0:
-                raise FileHasNoExtensionError(f"The image `{filename}` has no extension.")
+                msg = f"The image `{filename}` has no extension."
+                logger.error(msg)
+                raise FileHasNoExtensionError(msg)
             # Prepare Base64 content.
             for item in enumerate(base64_str):
                 if item[1] == ",":
@@ -199,7 +208,7 @@ class ImageField(Field, FileGroup, JsonMixin):
         src_path: str | None = None,
         is_delete: bool = False,
     ) -> None:
-        """Get image information and copy the image to the target directory."""
+        """Ramifice - Get image information and copy the image to the target directory."""
         src_path = src_path or None
         img_info: dict[str, str | int | bool] = {"save_as_is": False}
         img_info["is_new_img"] = True
@@ -210,6 +219,7 @@ class ImageField(Field, FileGroup, JsonMixin):
             extension = Path(src_path).suffix
             if len(extension) == 0:
                 msg = f"The image `{src_path}` has no extension."
+                logger.error(msg)
                 raise FileHasNoExtensionError(msg)
             # Create the current date for the directory name.
             date_str: str = str(date.today())