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

ramifice/fields/choice_int_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,30 +10,40 @@ 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 ChoiceIntDynField(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-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,
         required: bool = False,
         readonly: bool = False,
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if not isinstance(label, str):
@@ -80,7 +90,7 @@ class ChoiceIntDynField(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_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model.
+"""Field of Model.
 
 Type of selective integer field with static of elements.
 """
@@ -10,31 +10,43 @@ 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 ChoiceIntField(Field, ChoiceGroup, JsonMixin):
-    """Ramifice - Field of Model.
+    """Field of Model.
 
     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,
             label=label,
@@ -96,7 +108,7 @@ class ChoiceIntField(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_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,29 +10,39 @@ 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.
+
+    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,
         required: bool = False,
         readonly: bool = False,
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if not isinstance(label, str):
@@ -80,7 +90,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,31 +10,43 @@ 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.
+
+    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,
             label=label,
@@ -102,7 +114,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,30 +10,40 @@ 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.
     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,
         required: bool = False,
         readonly: bool = False,
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if not isinstance(label, str):
@@ -80,7 +90,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,31 +10,43 @@ 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.
+
+    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,
             label=label,
@@ -101,7 +113,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,29 +10,39 @@ 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.
+
+    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,
         required: bool = False,
         readonly: bool = False,
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if not isinstance(label, str):
@@ -80,7 +90,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,31 +10,43 @@ 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.
+
+    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,
             label=label,
@@ -102,7 +114,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,36 +7,49 @@ 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).
 
-    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,
-    ):
+    ) -> 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,23 +18,38 @@ logger = logging.getLogger(__name__)
 
 
 class DateField(Field, DateGroup):
-    """Ramifice - 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,
         min_date: datetime | None = None,
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if max_date is not None:
@@ -103,7 +118,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 +134,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 +150,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)