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

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,23 +18,38 @@ 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.
+
+    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,
         min_date: datetime | None = None,
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if max_date is not None:
@@ -103,7 +118,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 +134,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 +150,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,28 +9,42 @@ 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.
+
+    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,
-    ):
+    ) -> 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,30 +17,45 @@ 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.
+
+    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:
                 if default is not None:
@@ -108,7 +123,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 +179,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,24 +8,42 @@ 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.
+
+    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.
+        max_number: Maximum allowed number.
+        min_number: Minimum allowed number.
+        step: Increment step for numeric fields.
+        input_type: Field type - `number` or `range`.
+    """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
-        disabled: bool = False,
+        placeholder: str = "",
+        default: float | None = None,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,
-        default: float | None = None,
-        placeholder: str = "",
         required: bool = False,
         readonly: bool = False,
         unique: bool = False,
@@ -33,7 +51,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

ramifice/fields/general/number_group.py

@@ -1,4 +1,4 @@
-"""Ramifice - General additional parameters for number fields."""
+"""General additional parameters for number fields."""
 
 __all__ = ("NumberGroup",)
 
@@ -6,13 +6,13 @@ from abc import ABCMeta
 
 
 class NumberGroup(metaclass=ABCMeta):
-    """Ramifice - General additional parameters for number fields.
+    """General additional parameters for number fields.
 
-    Attributes:
-        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.
+    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.
     """
 
     def __init__(  # noqa: D107
@@ -21,7 +21,7 @@ class NumberGroup(metaclass=ABCMeta):
         required: bool = False,
         readonly: bool = False,
         unique: bool = False,
-    ):
+    ) -> None:
         self.placeholder = placeholder
         self.required = required
         self.readonly = readonly

ramifice/fields/general/text_group.py

@@ -1,4 +1,4 @@
-"""Ramifice - General additional parameters for text fields."""
+"""General additional parameters for text fields."""
 
 __all__ = ("TextGroup",)
 
@@ -6,14 +6,14 @@ from abc import ABCMeta
 
 
 class TextGroup(metaclass=ABCMeta):
-    """Ramifice - General additional parameters for text fields.
+    """General additional parameters for text 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.
+    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.
     """
 
     def __init__(  # noqa: D107
@@ -23,7 +23,7 @@ class TextGroup(metaclass=ABCMeta):
         required: bool = False,
         readonly: bool = False,
         unique: bool = False,
-    ):
+    ) -> None:
         self.input_type = input_type
         self.value: str | None = None
         self.placeholder = placeholder
@@ -32,7 +32,7 @@ class TextGroup(metaclass=ABCMeta):
         self.unique = unique
 
     def __len__(self) -> int:
-        """Ramifice - Return length of field `value`."""
+        """Return length of field `value`."""
         value = self.value
         if value is None:
             return 0

ramifice/fields/id_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model for enter identifier of document."""
+"""Field of Model for enter identifier of document."""
 
 __all__ = ("IDField",)
 
@@ -15,29 +15,34 @@ logger = logging.getLogger(__name__)
 
 
 class IDField(Field):
-    """Ramifice - Field of Model for enter identifier of document.
+    """Field of Model for enter identifier of document.
 
-    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.
+    Agrs:
+        label: Text label for a web form field.
+        placeholder: Displays prompt text.
+        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 = "",
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,
-        placeholder: str = "",
         required: bool = False,
         readonly: bool = False,
         unique: bool = False,
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if not isinstance(label, str):
@@ -87,7 +92,7 @@ class IDField(Field):
         self.alerts: list[str] = []
 
     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] = {}
         for name, data in self.__dict__.items():
             if not callable(data):
@@ -98,12 +103,12 @@ class IDField(Field):
         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, data in json_dict.items():
             if name == "value" and data is not None:
@@ -114,6 +119,6 @@ class IDField(Field):
 
     @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)