ramifice 0.8.25__py3-none-any.whl → 0.8.27__py3-none-any.whl

ramifice/commons/tools.py

@@ -21,11 +21,7 @@ def correct_mongo_filter(cls_model: Any, filter: Any) -> Any:
     """
     lang: str = translations.CURRENT_LOCALE
     filter_json: str = json_util.dumps(filter)
-    filter_json = (
-        cls_model.META["regex_mongo_filter"]
-        .sub(rf'\g<field>.{lang}":', filter_json)
-        .replace('":.', ".")
-    )
+    filter_json = cls_model.META["regex_mongo_filter"].sub(rf'\g<field>.{lang}":', filter_json).replace('":.', ".")
     return json_util.loads(filter_json)
 
 

ramifice/fields/bool_field.py

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

ramifice/fields/choice_float_dyn_field.py

@@ -21,13 +21,23 @@ class ChoiceFloatDynField(Field, ChoiceGroup, JsonMixin):
     Type of selective integer field with dynamic addition of elements.
     For simulate relationship Many-to-One.
     Element are (add|delete) via `ModelName.unit_manager(unit)` method.
+
+    Args:
+        label: Text label for a web form field.
+        hide: Hide field from user.
+        disabled: Blocks access and modification of the element.
+        ignored: If true, the value of this field is not saved in the database.
+        hint: An alternative for the `placeholder` parameter.
+        warning: Warning information.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
     """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,

ramifice/fields/choice_float_field.py

@@ -20,20 +20,32 @@ class ChoiceFloatField(Field, ChoiceGroup, JsonMixin):
 
     Type of selective integer float with static of elements.
     With a single choice.
+
+    Args:
+        label: Text label for a web form field.
+        default: Default value.
+        hide: Hide field from user.
+        disabled: Blocks access and modification of the element.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
+        ignored: If true, the value of this field is not saved in the database.
+        hint: An alternative for the `placeholder` parameter.
+        warning: Warning information.
+        choices: For a predefined set of options - [[value, Title], ...].
     """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
+        default: float | None = None,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,
-        default: float | None = None,
         required: bool = False,
         readonly: bool = False,
-        choices: list[list[float | str]] | None = None,
+        choices: list[list[float | str]] | None = None,  # [[value, Title], ...]
     ) -> None:
         Field.__init__(
             self,

ramifice/fields/choice_float_mult_dyn_field.py

@@ -20,13 +20,23 @@ class ChoiceFloatMultDynField(Field, ChoiceGroup, JsonMixin):
 
     Type of selective float field with dynamic addition of elements.
     For simulate relationship Many-to-Many.
+
+    Args:
+        label: Text label for a web form field.
+        hide: Hide field from user.
+        disabled: Blocks access and modification of the element.
+        ignored: If true, the value of this field is not saved in the database.
+        hint: An alternative for the `placeholder` parameter.
+        warning: Warning information.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
     """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,

ramifice/fields/choice_float_mult_field.py

@@ -20,20 +20,32 @@ class ChoiceFloatMultField(Field, ChoiceGroup, JsonMixin):
 
     Type of selective float field with static of elements.
     With multiple choice.
+
+    Args:
+        label: Text label for a web form field.
+        default: Default value.
+        hide: Hide field from user.
+        disabled: Blocks access and modification of the element.
+        ignored: If true, the value of this field is not saved in the database.
+        hint: An alternative for the `placeholder` parameter.
+        warning: Warning information.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
+        choices: For a predefined set of options - [[value, Title], ...].
     """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
+        default: list[float] | None = None,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,
-        default: list[float] | None = None,
         required: bool = False,
         readonly: bool = False,
-        choices: list[list[float | str]] | None = None,
+        choices: list[list[float | str]] | None = None,  # [[value, Title], ...]
     ) -> None:
         Field.__init__(
             self,

ramifice/fields/choice_int_dyn_field.py

@@ -21,13 +21,23 @@ class ChoiceIntDynField(Field, ChoiceGroup, JsonMixin):
     Type of selective integer field with dynamic addition of elements.
     For simulate relationship Many-to-One.
     Element are (add|delete) via `ModelName.unit_manager(unit)` method.
+
+    Args:
+        label: Text label for a web form field.
+        hide: Hide field from user.
+        disabled: Blocks access and modification of the element.
+        ignored: If true, the value of this field is not saved in the database.
+        hint: An alternative for the `placeholder` parameter.
+        warning: Warning information.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
     """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,

ramifice/fields/choice_int_field.py

@@ -20,20 +20,32 @@ class ChoiceIntField(Field, ChoiceGroup, JsonMixin):
 
     Type of selective integer field with static of elements.
     With a single choice.
+
+    Args:
+        label: Text label for a web form field.
+        default: Default value.
+        hide: Hide field from user.
+        disabled: Blocks access and modification of the element.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
+        ignored: If true, the value of this field is not saved in the database.
+        hint: An alternative for the `placeholder` parameter.
+        warning: Warning information.
+        choices: For a predefined set of options - [[value, Title], ...].
     """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
+        default: int | None = None,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,
-        default: int | None = None,
         required: bool = False,
         readonly: bool = False,
-        choices: list[list[int | str]] | None = None,
+        choices: list[list[int | str]] | None = None,  # [[value, Title], ...]
     ) -> None:
         Field.__init__(
             self,

ramifice/fields/choice_int_mult_dyn_field.py

@@ -20,13 +20,23 @@ class ChoiceIntMultDynField(Field, ChoiceGroup, JsonMixin):
 
     Type of selective integer field with dynamic addition of elements.
     For simulate relationship Many-to-Many.
+
+    Args:
+        label: Text label for a web form field.
+        hide: Hide field from user.
+        disabled: Blocks access and modification of the element.
+        ignored: If true, the value of this field is not saved in the database.
+        hint: An alternative for the `placeholder` parameter.
+        warning: Warning information.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
     """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,

ramifice/fields/choice_int_mult_field.py

@@ -20,20 +20,32 @@ class ChoiceIntMultField(Field, ChoiceGroup, JsonMixin):
 
     Type of selective integer field with static of elements.
     With multiple choice.
+
+    Args:
+        label: Text label for a web form field.
+        default: Default value.
+        hide: Hide field from user.
+        disabled: Blocks access and modification of the element.
+        ignored: If true, the value of this field is not saved in the database.
+        hint: An alternative for the `placeholder` parameter.
+        warning: Warning information.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
+        choices: For a predefined set of options - [[value, Title], ...].
     """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
+        default: list[int] | None = None,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,
-        default: list[int] | None = None,
         required: bool = False,
         readonly: bool = False,
-        choices: list[list[int | str]] | None = None,
+        choices: list[list[int | str]] | None = None,  # [[value, Title], ...]
     ) -> None:
         Field.__init__(
             self,

ramifice/fields/choice_text_dyn_field.py

@@ -21,13 +21,23 @@ class ChoiceTextDynField(Field, ChoiceGroup, JsonMixin):
     Type of selective text field with dynamic addition of elements.
     For simulate relationship Many-to-One.
     Element are (add|delete) via `ModelName.unit_manager(unit)` method.
+
+    Args:
+        label: Text label for a web form field.
+        hide: Hide field from user.
+        disabled: Blocks access and modification of the element.
+        ignored: If true, the value of this field is not saved in the database.
+        hint: An alternative for the `placeholder` parameter.
+        warning: Warning information.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
     """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,

ramifice/fields/choice_text_field.py

@@ -20,20 +20,32 @@ class ChoiceTextField(Field, ChoiceGroup, JsonMixin):
 
     Type of selective text field with static of elements.
     With a single choice.
+
+    Args:
+        label: Text label for a web form field.
+        default: Default value.
+        hide: Hide field from user.
+        disabled: Blocks access and modification of the element.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
+        ignored: If true, the value of this field is not saved in the database.
+        hint: An alternative for the `placeholder` parameter.
+        warning: Warning information.
+        choices: For a predefined set of options - [[value, Title], ...].
     """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
+        default: str | None = None,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,
-        default: str | None = None,
         required: bool = False,
         readonly: bool = False,
-        choices: list[list[str]] | None = None,
+        choices: list[list[str]] | None = None,  # [[value, Title], ...]
     ) -> None:
         Field.__init__(
             self,

ramifice/fields/choice_text_mult_dyn_field.py

@@ -20,13 +20,23 @@ class ChoiceTextMultDynField(Field, ChoiceGroup, JsonMixin):
 
     Type of selective text field with dynamic addition of elements.
     For simulate relationship Many-to-Many.
+
+    Args:
+        label: Text label for a web form field.
+        hide: Hide field from user.
+        disabled: Blocks access and modification of the element.
+        ignored: If true, the value of this field is not saved in the database.
+        hint: An alternative for the `placeholder` parameter.
+        warning: Warning information.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
     """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,

ramifice/fields/choice_text_mult_field.py

@@ -20,20 +20,32 @@ class ChoiceTextMultField(Field, ChoiceGroup, JsonMixin):
 
     Type of selective text field with static of elements.
     With multiple choice.
+
+    Args:
+        label: Text label for a web form field.
+        default: Default value.
+        hide: Hide field from user.
+        disabled: Blocks access and modification of the element.
+        ignored: If true, the value of this field is not saved in the database.
+        hint: An alternative for the `placeholder` parameter.
+        warning: Warning information.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
+        choices: For a predefined set of options - [[value, Title], ...].
     """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
+        default: list[str] | None = None,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,
-        default: list[str] | None = None,
         required: bool = False,
         readonly: bool = False,
-        choices: list[list[str]] | None = None,
+        choices: list[list[str]] | None = None,  # [[value, Title], ...]
     ) -> None:
         Field.__init__(
             self,

ramifice/fields/color_field.py

@@ -17,22 +17,35 @@ class ColorField(Field, TextGroup, JsonMixin):
 
     Default value is #000000 (black).
 
-    Examples:
-            #fff | #f2f2f2 | #f2f2f200 | rgb(255,0,24) |
-        rgba(255,0,24,0.5) | rgba(#fff,0.5) | hsl(120,100%,50%) |
-        hsla(170,23%,25%,0.2) | 0x00ffff
+    Samples:
+    #ffffff | #fff | #f2f2f2 | #f2f2f200 | rgb(255,0,24) |
+    rgba(255,0,24,0.5) | rgba(#fff,0.5) | hsl(120,100%,50%) |
+    hsla(170,23%,25%,0.2) | 0x00ffff
+
+    Agrs:
+        label: Text label for a web form field.
+        placeholder: Displays prompt text.
+        default: Value by default.
+        hide: Hide field from user.
+        disabled: Blocks access and modification of the element.
+        ignored: If true, the value of this field is not saved in the database.
+        hint: An alternative for the `placeholder` parameter.
+        warning: Warning information.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
+        unique: The unique value of a field in a collection.
     """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
+        placeholder: str = "",
+        default: str | None = "#000000",
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,
-        default: str | None = "#000000",
-        placeholder: str = "",
         required: bool = False,
         readonly: bool = False,
         unique: bool = False,

ramifice/fields/date_field.py

@@ -18,18 +18,33 @@ logger = logging.getLogger(__name__)
 
 
 class DateField(Field, DateGroup):
-    """Field of Model for enter date."""
+    """Field of Model for enter date.
+
+    Agrs:
+        label: Text label for a web form field.
+        placeholder: Displays prompt text.
+        default: Value by default.
+        hide: Hide field from user.
+        disabled: Blocks access and modification of the element.
+        ignored: If true, the value of this field is not saved in the database.
+        hint: An alternative for the `placeholder` parameter.
+        warning: Warning information.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
+        max_date: Maximum allowed date.
+        min_date: Minimum allowed date.
+    """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
+        placeholder: str = "",
+        default: datetime | None = None,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,
-        default: datetime | None = None,
-        placeholder: str = "",
         required: bool = False,
         readonly: bool = False,
         max_date: datetime | None = None,

ramifice/fields/date_time_field.py

@@ -18,18 +18,33 @@ logger = logging.getLogger(__name__)
 
 
 class DateTimeField(Field, DateGroup):
-    """Field of Model for enter date and time."""
+    """Field of Model for enter date and time.
+
+    Agrs:
+        label: Text label for a web form field.
+        placeholder: Displays prompt text.
+        default: Value by default.
+        hide: Hide field from user.
+        disabled: Blocks access and modification of the element.
+        ignored: If true, the value of this field is not saved in the database.
+        hint: An alternative for the `placeholder` parameter.
+        warning: Warning information.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
+        max_date: Maximum allowed date and time.
+        min_date: Minimum allowed date and time.
+    """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
+        placeholder: str = "",
+        default: datetime | None = None,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,
-        default: datetime | None = None,
-        placeholder: str = "",
         required: bool = False,
         readonly: bool = False,
         max_date: datetime | None = None,

ramifice/fields/email_field.py

@@ -15,18 +15,32 @@ logger = logging.getLogger(__name__)
 
 
 class EmailField(Field, TextGroup, JsonMixin):
-    """Field of Model for enter email address."""
+    """Field of Model for enter email address.
+
+    Agrs:
+        label: Text label for a web form field.
+        placeholder: Displays prompt text.
+        default: Value by default.
+        hide: Hide field from user.
+        disabled: Blocks access and modification of the element.
+        ignored: If true, the value of this field is not saved in the database.
+        hint: An alternative for the `placeholder` parameter.
+        warning: Warning information.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
+        unique: The unique value of a field in a collection.
+    """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
+        placeholder: str = "",
+        default: str | None = None,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,
-        default: str | None = None,
-        placeholder: str = "",
         required: bool = False,
         readonly: bool = False,
         unique: bool = False,
@@ -43,7 +57,7 @@ class EmailField(Field, TextGroup, JsonMixin):
                     try:
                         validate_email(default, check_deliverability=True)
                     except EmailNotValidError:
-                        raise AssertionError("Parameter `default` - Invalid Email address!")
+                        raise AssertionError("Parameter `default` - Invalid Email address!")  # noqa: B904
                 if not isinstance(label, str):
                     raise AssertionError("Parameter `default` - Not а `str` type!")
                 if not isinstance(disabled, bool):

ramifice/fields/file_field.py

@@ -5,7 +5,7 @@ __all__ = ("FileField",)
 import logging
 import uuid
 from base64 import b64decode
-from datetime import date
+from datetime import datetime
 from os import makedirs
 from os.path import basename, exists, getsize
 from shutil import copyfile
@@ -23,23 +23,38 @@ logger = logging.getLogger(__name__)
 
 
 class FileField(Field, FileGroup, JsonMixin):
-    """Field of Model for upload file."""
+    """Field of Model for upload file.
+
+    Agrs:
+        label: Text label for a web form field.
+        placeholder: Displays prompt text.
+        default: Value by default.
+        hide: Hide field from user.
+        disabled: Blocks access and modification of the element.
+        ignored: If true, the value of this field is not saved in the database.
+        hint: An alternative for the `placeholder` parameter.
+        warning: Warning information.
+        required: Required field.
+        max_size: The maximum allowed file size in bytes.
+        target_dir: Directory for files inside media directory.
+        accept: Describing which file types to allow. Example: ".pdf,.doc,.docx,application/msword".
+    """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
+        placeholder: str = "",
+        default: str | None = None,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,
         required: bool = False,
         # The maximum size of the file in bytes.
         max_size: int = 2097152,  # 2 MB = 2097152 Bytes (in binary)
-        default: str | None = None,
-        placeholder: str = "",
         target_dir: str = "files",
-        accept: str = "",
+        accept: str = "",  # Example: ".pdf,.doc,.docx,application/msword"
     ) -> None:
         if constants.DEBUG:
             try:
@@ -47,9 +62,7 @@ class FileField(Field, FileGroup, JsonMixin):
                     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!"
-                        )
+                        raise AssertionError("The `default` parameter should not contain an empty string!")
                 if not isinstance(label, str):
                     raise AssertionError("Parameter `default` - Not а `str` type!")
                 if not isinstance(disabled, bool):
@@ -134,7 +147,7 @@ class FileField(Field, FileGroup, JsonMixin):
             # Create new (uuid) file name.
             f_uuid_name = f"{uuid.uuid4()}{extension}"
             # Create the current date for the directory name.
-            date_str: str = str(date.today())
+            date_str: str = str(datetime.now().date())  # noqa: DTZ005
             # Create path to target directory.
             dir_target_path = f"{MEDIA_ROOT}/uploads/{self.target_dir}/{date_str}"
             # Create target directory if it does not exist.
@@ -180,7 +193,7 @@ class FileField(Field, FileGroup, JsonMixin):
             # Create new (uuid) file name.
             f_uuid_name = f"{uuid.uuid4()}{extension}"
             # Create the current date for the directory name.
-            date_str: str = str(date.today())
+            date_str: str = str(datetime.now().date())  # noqa: DTZ005
             # Create path to target directory.
             dir_target_path = f"{MEDIA_ROOT}/uploads/{self.target_dir}/{date_str}"
             # Create target directory if it does not exist.