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

ramifice/fields/choice_int_mult_dyn_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model.
+"""Field of Model.
 
 Type of selective integer field with dynamic addition of elements.
 """
@@ -10,13 +10,13 @@ import logging
 from ramifice.fields.general.choice_group import ChoiceGroup
 from ramifice.fields.general.field import Field
 from ramifice.utils import constants
-from ramifice.utils.mixins.json_converter import JsonMixin
+from ramifice.utils.mixins import JsonMixin
 
 logger = logging.getLogger(__name__)
 
 
 class ChoiceIntMultDynField(Field, ChoiceGroup, JsonMixin):
-    """Ramifice - Field of Model.
+    """Field of Model.
 
     Type of selective integer field with dynamic addition of elements.
     For simulate relationship Many-to-Many.
@@ -32,7 +32,7 @@ class ChoiceIntMultDynField(Field, ChoiceGroup, JsonMixin):
         warning: list[str] | None = None,
         required: bool = False,
         readonly: bool = False,
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if not isinstance(label, str):
@@ -80,7 +80,7 @@ class ChoiceIntMultDynField(Field, ChoiceGroup, JsonMixin):
         self.choices: list[list[int | str]] | None = None
 
     def has_value(self, is_migrate: bool = False) -> bool:
-        """Ramifice - Does the field value match the possible options in choices."""
+        """Does the field value match the possible options in choices."""
         if is_migrate:
             return True
         value = self.value

ramifice/fields/choice_int_mult_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model.
+"""Field of Model.
 
 Type of selective integer field with static of elements.
 """
@@ -10,13 +10,13 @@ import logging
 from ramifice.fields.general.choice_group import ChoiceGroup
 from ramifice.fields.general.field import Field
 from ramifice.utils import constants
-from ramifice.utils.mixins.json_converter import JsonMixin
+from ramifice.utils.mixins import JsonMixin
 
 logger = logging.getLogger(__name__)
 
 
 class ChoiceIntMultField(Field, ChoiceGroup, JsonMixin):
-    """Ramifice - Field of Model.
+    """Field of Model.
 
     Type of selective integer field with static of elements.
     With multiple choice.
@@ -34,7 +34,7 @@ class ChoiceIntMultField(Field, ChoiceGroup, JsonMixin):
         required: bool = False,
         readonly: bool = False,
         choices: list[list[int | str]] | None = None,
-    ):
+    ) -> None:
         Field.__init__(
             self,
             label=label,
@@ -102,7 +102,7 @@ class ChoiceIntMultField(Field, ChoiceGroup, JsonMixin):
                 raise err
 
     def has_value(self, is_migrate: bool = False) -> bool:
-        """Ramifice - Does the field value match the possible options in choices."""
+        """Does the field value match the possible options in choices."""
         value = self.value
         if value is None:
             value = self.default

ramifice/fields/choice_text_dyn_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model.
+"""Field of Model.
 
 Type of selective text field with dynamic addition of elements.
 """
@@ -10,13 +10,13 @@ import logging
 from ramifice.fields.general.choice_group import ChoiceGroup
 from ramifice.fields.general.field import Field
 from ramifice.utils import constants
-from ramifice.utils.mixins.json_converter import JsonMixin
+from ramifice.utils.mixins import JsonMixin
 
 logger = logging.getLogger(__name__)
 
 
 class ChoiceTextDynField(Field, ChoiceGroup, JsonMixin):
-    """Ramifice - Field of Model.
+    """Field of Model.
 
     Type of selective text field with dynamic addition of elements.
     For simulate relationship Many-to-One.
@@ -33,7 +33,7 @@ class ChoiceTextDynField(Field, ChoiceGroup, JsonMixin):
         warning: list[str] | None = None,
         required: bool = False,
         readonly: bool = False,
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if not isinstance(label, str):
@@ -80,7 +80,7 @@ class ChoiceTextDynField(Field, ChoiceGroup, JsonMixin):
         self.choices: list[list[str]] | None = None
 
     def has_value(self, is_migrate: bool = False) -> bool:
-        """Ramifice - Does the field value match the possible options in choices."""
+        """Does the field value match the possible options in choices."""
         if is_migrate:
             return True
         value = self.value

ramifice/fields/choice_text_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model.
+"""Field of Model.
 
 Type of selective text field with static of elements.
 """
@@ -10,13 +10,13 @@ import logging
 from ramifice.fields.general.choice_group import ChoiceGroup
 from ramifice.fields.general.field import Field
 from ramifice.utils import constants
-from ramifice.utils.mixins.json_converter import JsonMixin
+from ramifice.utils.mixins import JsonMixin
 
 logger = logging.getLogger(__name__)
 
 
 class ChoiceTextField(Field, ChoiceGroup, JsonMixin):
-    """Ramifice - Field of Model.
+    """Field of Model.
 
     Type of selective text field with static of elements.
     With a single choice.
@@ -34,7 +34,7 @@ class ChoiceTextField(Field, ChoiceGroup, JsonMixin):
         required: bool = False,
         readonly: bool = False,
         choices: list[list[str]] | None = None,
-    ):
+    ) -> None:
         Field.__init__(
             self,
             label=label,
@@ -101,7 +101,7 @@ class ChoiceTextField(Field, ChoiceGroup, JsonMixin):
                 raise err
 
     def has_value(self, is_migrate: bool = False) -> bool:
-        """Ramifice - Does the field value match the possible options in choices."""
+        """Does the field value match the possible options in choices."""
         value = self.value
         if value is None:
             value = self.default

ramifice/fields/choice_text_mult_dyn_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model.
+"""Field of Model.
 
 Type of selective text field with dynamic addition of elements.
 """
@@ -10,13 +10,13 @@ import logging
 from ramifice.fields.general.choice_group import ChoiceGroup
 from ramifice.fields.general.field import Field
 from ramifice.utils import constants
-from ramifice.utils.mixins.json_converter import JsonMixin
+from ramifice.utils.mixins import JsonMixin
 
 logger = logging.getLogger(__name__)
 
 
 class ChoiceTextMultDynField(Field, ChoiceGroup, JsonMixin):
-    """Ramifice - Field of Model.
+    """Field of Model.
 
     Type of selective text field with dynamic addition of elements.
     For simulate relationship Many-to-Many.
@@ -32,7 +32,7 @@ class ChoiceTextMultDynField(Field, ChoiceGroup, JsonMixin):
         warning: list[str] | None = None,
         required: bool = False,
         readonly: bool = False,
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if not isinstance(label, str):
@@ -80,7 +80,7 @@ class ChoiceTextMultDynField(Field, ChoiceGroup, JsonMixin):
         self.choices: list[list[str]] | None = None
 
     def has_value(self, is_migrate: bool = False) -> bool:
-        """Ramifice - Does the field value match the possible options in choices."""
+        """Does the field value match the possible options in choices."""
         if is_migrate:
             return True
         value = self.value

ramifice/fields/choice_text_mult_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model.
+"""Field of Model.
 
 Type of selective text field with static of elements.
 """
@@ -10,13 +10,13 @@ import logging
 from ramifice.fields.general.choice_group import ChoiceGroup
 from ramifice.fields.general.field import Field
 from ramifice.utils import constants
-from ramifice.utils.mixins.json_converter import JsonMixin
+from ramifice.utils.mixins import JsonMixin
 
 logger = logging.getLogger(__name__)
 
 
 class ChoiceTextMultField(Field, ChoiceGroup, JsonMixin):
-    """Ramifice - Field of Model.
+    """Field of Model.
 
     Type of selective text field with static of elements.
     With multiple choice.
@@ -34,7 +34,7 @@ class ChoiceTextMultField(Field, ChoiceGroup, JsonMixin):
         required: bool = False,
         readonly: bool = False,
         choices: list[list[str]] | None = None,
-    ):
+    ) -> None:
         Field.__init__(
             self,
             label=label,
@@ -102,7 +102,7 @@ class ChoiceTextMultField(Field, ChoiceGroup, JsonMixin):
                 raise err
 
     def has_value(self, is_migrate: bool = False) -> bool:
-        """Ramifice - Does the field value match the possible options in choices."""
+        """Does the field value match the possible options in choices."""
         value = self.value
         if value is None:
             value = self.default

ramifice/fields/color_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model for enter color code."""
+"""Field of Model for enter color code."""
 
 __all__ = ("ColorField",)
 
@@ -7,13 +7,13 @@ import logging
 from ramifice.fields.general.field import Field
 from ramifice.fields.general.text_group import TextGroup
 from ramifice.utils import constants
-from ramifice.utils.mixins.json_converter import JsonMixin
+from ramifice.utils.mixins import JsonMixin
 
 logger = logging.getLogger(__name__)
 
 
 class ColorField(Field, TextGroup, JsonMixin):
-    """Ramifice - Field of Model for enter color code.
+    """Field of Model for enter color code.
 
     Default value is #000000 (black).
 
@@ -36,7 +36,7 @@ class ColorField(Field, TextGroup, JsonMixin):
         required: bool = False,
         readonly: bool = False,
         unique: bool = False,
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if default is not None:

ramifice/fields/date_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model for enter date."""
+"""Field of Model for enter date."""
 
 __all__ = ("DateField",)
 
@@ -18,7 +18,7 @@ logger = logging.getLogger(__name__)
 
 
 class DateField(Field, DateGroup):
-    """Ramifice - Field of Model for enter date."""
+    """Field of Model for enter date."""
 
     def __init__(  # noqa: D107
         self,
@@ -34,7 +34,7 @@ class DateField(Field, DateGroup):
         readonly: bool = False,
         max_date: datetime | None = None,
         min_date: datetime | None = None,
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if max_date is not None:
@@ -103,7 +103,7 @@ class DateField(Field, DateGroup):
         self.default = default
 
     def to_dict(self) -> dict[str, Any]:
-        """Ramifice - Convert object instance to a dictionary."""
+        """Convert object instance to a dictionary."""
         json_dict: dict[str, Any] = {}
         current_locale = translations.CURRENT_LOCALE
         for name, value in self.__dict__.items():
@@ -119,12 +119,12 @@ class DateField(Field, DateGroup):
         return json_dict
 
     def to_json(self) -> str:
-        """Ramifice - Convert object instance to a JSON string."""
+        """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:
-        """Ramifice - Convert JSON string to a object instance."""
+        """Convert JSON string to a object instance."""
         obj = cls()
         for name, value in json_dict.items():
             if name == "value" and value is not None:
@@ -135,6 +135,6 @@ class DateField(Field, DateGroup):
 
     @classmethod
     def from_json(cls, json_str: str) -> Any:
-        """Ramifice - Convert JSON string to a object instance."""
+        """Convert JSON string to a object instance."""
         json_dict = orjson.loads(json_str)
         return cls.from_dict(json_dict)

ramifice/fields/date_time_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model for enter date and time."""
+"""Field of Model for enter date and time."""
 
 __all__ = ("DateTimeField",)
 
@@ -18,7 +18,7 @@ logger = logging.getLogger(__name__)
 
 
 class DateTimeField(Field, DateGroup):
-    """Ramifice - Field of Model for enter date and time."""
+    """Field of Model for enter date and time."""
 
     def __init__(  # noqa: D107
         self,
@@ -34,7 +34,7 @@ class DateTimeField(Field, DateGroup):
         readonly: bool = False,
         max_date: datetime | None = None,
         min_date: datetime | None = None,
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if max_date is not None:
@@ -103,7 +103,7 @@ class DateTimeField(Field, DateGroup):
         self.default = default
 
     def to_dict(self) -> dict[str, Any]:
-        """Ramifice - Convert object instance to a dictionary."""
+        """Convert object instance to a dictionary."""
         json_dict: dict[str, Any] = {}
         current_locale = translations.CURRENT_LOCALE
         for name, value in self.__dict__.items():
@@ -119,12 +119,12 @@ class DateTimeField(Field, DateGroup):
         return json_dict
 
     def to_json(self) -> str:
-        """Ramifice - Convert object instance to a JSON string."""
+        """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:
-        """Ramifice - Convert JSON string to a object instance."""
+        """Convert JSON string to a object instance."""
         obj = cls()
         for name, value in json_dict.items():
             if name == "value" and value is not None:
@@ -135,6 +135,6 @@ class DateTimeField(Field, DateGroup):
 
     @classmethod
     def from_json(cls, json_str: str) -> Any:
-        """Ramifice - Convert JSON string to a object instance."""
+        """Convert JSON string to a object instance."""
         json_dict = orjson.loads(json_str)
         return cls.from_dict(json_dict)

ramifice/fields/email_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model for enter email address."""
+"""Field of Model for enter email address."""
 
 __all__ = ("EmailField",)
 
@@ -9,13 +9,13 @@ from email_validator import EmailNotValidError, validate_email
 from ramifice.fields.general.field import Field
 from ramifice.fields.general.text_group import TextGroup
 from ramifice.utils import constants
-from ramifice.utils.mixins.json_converter import JsonMixin
+from ramifice.utils.mixins import JsonMixin
 
 logger = logging.getLogger(__name__)
 
 
 class EmailField(Field, TextGroup, JsonMixin):
-    """Ramifice - Field of Model for enter email address."""
+    """Field of Model for enter email address."""
 
     def __init__(  # noqa: D107
         self,
@@ -30,7 +30,7 @@ class EmailField(Field, TextGroup, JsonMixin):
         required: bool = False,
         readonly: bool = False,
         unique: bool = False,
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if default is not None:

ramifice/fields/file_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model for upload file."""
+"""Field of Model for upload file."""
 
 __all__ = ("FileField",)
 
@@ -17,13 +17,13 @@ from ramifice.fields.general.file_group import FileGroup
 from ramifice.utils import constants
 from ramifice.utils.constants import MEDIA_ROOT, MEDIA_URL
 from ramifice.utils.errors import FileHasNoExtensionError
-from ramifice.utils.mixins.json_converter import JsonMixin
+from ramifice.utils.mixins import JsonMixin
 
 logger = logging.getLogger(__name__)
 
 
 class FileField(Field, FileGroup, JsonMixin):
-    """Ramifice - Field of Model for upload file."""
+    """Field of Model for upload file."""
 
     def __init__(  # noqa: D107
         self,
@@ -40,7 +40,7 @@ class FileField(Field, FileGroup, JsonMixin):
         placeholder: str = "",
         target_dir: str = "files",
         accept: str = "",
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if default is not None:
@@ -108,7 +108,7 @@ class FileField(Field, FileGroup, JsonMixin):
         filename: str | None = None,
         is_delete: bool = False,
     ) -> None:
-        """Ramifice - Convert base64 to a file,
+        """Convert base64 to a file,
         get file information and save in the target directory.
         """  # noqa: D205
         base64_str = base64_str or None
@@ -164,7 +164,7 @@ class FileField(Field, FileGroup, JsonMixin):
         src_path: str | None = None,
         is_delete: bool = False,
     ) -> None:
-        """Ramifice - Get file information and copy the file to the target directory."""
+        """Get file information and copy the file to the target directory."""
         src_path = src_path or None
         file_info: dict[str, str | int | bool] = {"save_as_is": False}
         file_info["is_new_file"] = True

ramifice/fields/float_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model for enter (float) number."""
+"""Field of Model for enter (float) number."""
 
 __all__ = ("FloatField",)
 
@@ -8,13 +8,13 @@ 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
+from ramifice.utils.mixins import JsonMixin
 
 logger = logging.getLogger(__name__)
 
 
 class FloatField(Field, NumberGroup, JsonMixin):
-    """Ramifice - Field of Model for enter (float) number."""
+    """Field of Model for enter (float) number."""
 
     def __init__(  # noqa: D107
         self,
@@ -33,7 +33,7 @@ class FloatField(Field, NumberGroup, JsonMixin):
         min_number: float | None = None,
         step: float = 1.0,
         input_type: Literal["number", "range"] = "number",
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if input_type not in ["number", "range"]:

ramifice/fields/general/__init__.py

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

ramifice/fields/general/choice_group.py

@@ -1,4 +1,4 @@
-"""Ramifice - General additional parameters for choice fields."""
+"""General additional parameters for choice fields."""
 
 __all__ = ("ChoiceGroup",)
 
@@ -6,15 +6,14 @@ from abc import ABCMeta
 
 
 class ChoiceGroup(metaclass=ABCMeta):
-    """Ramifice - General additional parameters for choice fields.
+    """General additional parameters for choice fields.
 
-    Attributes:
-        input_type -- Input type for a web form field.
-        placeholder -- Displays prompt text.
-        required -- Required field.
-        readonly -- Specifies that the field cannot be modified by the user.
-        unique -- The unique value of a field in a collection.
-        multiple -- Specifies that multiple options can be selected at once.
+    Args:
+        placeholder: Displays prompt text.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
+        unique: The unique value of a field in a collection.
+        multiple: Specifies that multiple options can be selected at once.
     """
 
     def __init__(  # noqa: D107
@@ -24,7 +23,7 @@ class ChoiceGroup(metaclass=ABCMeta):
         readonly: bool = False,
         unique: bool = False,
         multiple: bool = False,
-    ):
+    ) -> None:
         self.placeholder = placeholder
         self.required = required
         self.readonly = readonly

ramifice/fields/general/date_group.py

@@ -1,4 +1,4 @@
-"""Ramifice - General additional parameters for date|datetime fields."""
+"""General additional parameters for date|datetime fields."""
 
 __all__ = ("DateGroup",)
 
@@ -7,16 +7,16 @@ from datetime import datetime
 
 
 class DateGroup(metaclass=ABCMeta):
-    """Ramifice - General additional parameters for date|datetime fields.
+    """General additional parameters for date|datetime fields.
 
-    Attributes:
-        input_type -- Input type for a web form field.
-        placeholder -- Displays prompt text.
-        required -- Required field.
-        readonly -- Specifies that the field cannot be modified by the user.
-        unique -- The unique value of a field in a collection.
-        max_date -- Maximum allowed date.
-        min_date -- Minimum allowed date.
+    Args:
+        input_type: Input type for a web form field.
+        placeholder: Displays prompt text.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
+        unique: The unique value of a field in a collection.
+        max_date: Maximum allowed date.
+        min_date: Minimum allowed date.
     """
 
     def __init__(  # noqa: D107
@@ -28,7 +28,7 @@ class DateGroup(metaclass=ABCMeta):
         unique: bool = False,
         max_date: datetime | None = None,
         min_date: datetime | None = None,
-    ):
+    ) -> None:
         self.input_type = input_type
         self.value: datetime | None = None
         self.placeholder = placeholder

ramifice/fields/general/field.py

@@ -1,4 +1,4 @@
-"""Ramifice - General parameters for all types fields of Model."""
+"""General parameters for all types fields of Model."""
 
 __all__ = ("Field",)
 
@@ -6,18 +6,18 @@ from abc import ABCMeta
 
 
 class Field(metaclass=ABCMeta):
-    """Ramifice - General parameters for all types fields of Model.
+    """General parameters for all types fields of Model.
 
-    Attributes:
-        label -- Text label for a web form field.
-        disabled -- Blocks access and modification of the element.
-        hide -- Hide field from 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.
-        errors -- The value is determined automatically.
-        field_type -- Field type - ClassName.
-        group -- To optimize field traversal in the `check` method.
+    Args:
+        label: Text label for a web form field.
+        disabled: Blocks access and modification of the element.
+        hide: Hide field from 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.
+        errors: The value is determined automatically.
+        field_type: Field type - ClassName.
+        group: To optimize field traversal in the `check` method.
     """
 
     def __init__(  # noqa: D107
@@ -31,7 +31,7 @@ class Field(metaclass=ABCMeta):
         errors: list[str] = [],
         field_type: str = "",
         group: str = "",
-    ):
+    ) -> None:
         self.id = ""
         self.label = label
         self.name = ""

ramifice/fields/general/file_group.py

@@ -1,4 +1,4 @@
-"""Ramifice - General additional parameters for file fields."""
+"""General additional parameters for file fields."""
 
 __all__ = ("FileGroup",)
 
@@ -6,15 +6,15 @@ from abc import ABCMeta
 
 
 class FileGroup(metaclass=ABCMeta):
-    """Ramifice - General additional parameters for file fields.
+    """General additional parameters for file fields.
 
-    Attributes:
-        placeholder -- Displays prompt text.
-        required -- Required field.
-        max_size -- The maximum allowed file size in bytes.
-        default -- Default file path.
-        target_dir -- Directory for files inside media directory.
-        accept -- Describing which file types to allow.
+    Args:
+        placeholder: Displays prompt text.
+        required: Required field.
+        max_size: The maximum allowed file size in bytes.
+        default: Default file path.
+        target_dir: Directory for files inside media directory.
+        accept: Describing which file types to allow.
     """
 
     def __init__(  # noqa: D107
@@ -25,7 +25,7 @@ class FileGroup(metaclass=ABCMeta):
         default: str | None = None,
         target_dir: str = "",
         accept: str = "",
-    ):
+    ) -> None:
         self.input_type = "file"
         self.placeholder = placeholder
         self.required = required