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

ramifice/fields/image_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model for upload image."""
+"""Field of Model for upload image."""
 
 __all__ = ("ImageField",)
 
@@ -17,33 +17,49 @@ 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 ImageField(Field, FileGroup, JsonMixin):
-    """Ramifice - Field of Model for upload image."""
+    """Field of Model for upload image.
+
+    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: "image/png,image/jpeg,image/webp".
+        thumbnails: Sizes of thumbnails - Example: {"lg": 1200, "md": 600, "sm": 300, "xs": 150 }.
+    """
 
     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 original image in bytes.
         max_size: int = 2097152,  # 2 MB = 2097152 Bytes (in binary)
-        default: str | None = None,
-        placeholder: str = "",
         target_dir: str = "images",
         accept: str = "image/png,image/jpeg,image/webp",
         # Available 4 sizes from lg to xs or None.
         # Example: {"lg": 1200, "md": 600, "sm": 300, "xs": 150 }
         thumbnails: dict[str, int] | None = None,
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if default is not None:
@@ -139,7 +155,7 @@ class ImageField(Field, FileGroup, JsonMixin):
         filename: str | None = None,
         is_delete: bool = False,
     ) -> None:
-        """Ramifice - Convert base64 to a image,
+        """Convert base64 to a image,
         get image information and save in the target directory.
         """  # noqa: D205
         base64_str = base64_str or None
@@ -208,7 +224,7 @@ class ImageField(Field, FileGroup, JsonMixin):
         src_path: str | None = None,
         is_delete: bool = False,
     ) -> None:
-        """Ramifice - Get image information and copy the image to the target directory."""
+        """Get image information and copy the image to the target directory."""
         src_path = src_path or None
         img_info: dict[str, str | int | bool] = {"save_as_is": False}
         img_info["is_new_img"] = True

ramifice/fields/integer_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model for enter (int) number."""
+"""Field of Model for enter (int) number."""
 
 __all__ = ("IntegerField",)
 
@@ -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 IntegerField(Field, NumberGroup, JsonMixin):
-    """Ramifice - Field of Model for enter (int) number."""
+    """Field of Model for enter (int) 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: int | None = None,
         hide: bool = False,
+        disabled: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,
-        default: int | None = None,
-        placeholder: str = "",
         required: bool = False,
         readonly: bool = False,
         unique: bool = False,
@@ -33,7 +51,7 @@ class IntegerField(Field, NumberGroup, JsonMixin):
         min_number: int | None = None,
         step: int = 1,
         input_type: Literal["number", "range"] = "number",
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if input_type not in ["number", "range"]:

ramifice/fields/ip_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model for enter IP address."""
+"""Field of Model for enter IP address."""
 
 __all__ = ("IPField",)
 
@@ -8,28 +8,42 @@ 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 IPField(Field, TextGroup, JsonMixin):
-    """Ramifice - Field of Model for enter IP address."""
+    """Field of Model for enter IP 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/password_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model for enter password."""
+"""Field of Model for enter password."""
 
 __all__ = ("PasswordField",)
 
@@ -14,24 +14,33 @@ logger = logging.getLogger(__name__)
 
 
 class PasswordField(Field):
-    r"""Ramifice - Field of Model for enter password.
+    r"""Field of Model for enter password.
 
-    Warning:
-            Regular expression: ^[-._!"`'#%&,:;<>=@{}~$()*+/\\?[]^|a-zA-Z0-9]{8,256}$
-            Valid characters: a-z A-Z 0-9 - . _ ! " ` ' # % & , : ; < > = @ { } ~ $ ( ) * + / \\ ? [ ] ^ |
-            Number of characters: from 8 to 256.
+    Attention:
+    - Regular expression: ^[-._!"`'#%&,:;<>=@{}~$()*+/\\?[]^|a-zA-Z0-9]{8,256}$
+    - Valid characters: a-z A-Z 0-9 - . _ ! " ` ' # % & , : ; < > = @ { } ~ $ ( ) * + / \\ ? [ ] ^ |
+    - Number of characters: from 8 to 256.
+
+    Agrs:
+        label: Text label for a web form field.
+        placeholder: Displays prompt text.
+        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.
+        required: Required field.
     """
 
     def __init__(  # noqa: D107
         self,
         label: str = "",
+        placeholder: str = "",
         hide: bool = False,
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,
-        placeholder: str = "",
         required: bool = False,
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if not isinstance(label, str):
@@ -72,7 +81,7 @@ class PasswordField(Field):
         self.required = required
 
     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):
@@ -80,12 +89,12 @@ class PasswordField(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():
             obj.__dict__[name] = data
@@ -93,6 +102,6 @@ class PasswordField(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)

ramifice/fields/phone_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model for enter phone number."""
+"""Field of Model for enter phone number."""
 
 __all__ = ("PhoneField",)
 
@@ -9,31 +9,45 @@ import phonenumbers
 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 PhoneField(Field, TextGroup, JsonMixin):
-    """Ramifice - Field of Model for enter phone number.
+    """Field of Model for enter phone number.
 
-    WARNING: By default is used validator `phonenumbers.is_valid_number()`.
+    Attention:
+    By default is used validator `phonenumbers.is_valid_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.
     """
 
     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/slug_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model for automatic generation of string `slug`."""
+"""Field of Model for automatic generation of string `slug`."""
 
 __all__ = ("SlugField",)
 
@@ -7,29 +7,40 @@ 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 SlugField(Field, TextGroup, JsonMixin):
-    """Ramifice - Field of Model for automatic generation of string `slug`.
+    """Field of Model for automatic generation of string `slug`.
 
     Convenient to use for Url addresses.
+
+    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.
+        readonly: Specifies that the field cannot be modified by the user.
+        slug_sources: List of sources fields.
     """
 
     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 = "",
         readonly: bool = False,
         slug_sources: list[str] = ["_id"],
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if not isinstance(label, str):

ramifice/fields/text_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model for enter text."""
+"""Field of Model for enter text."""
 
 __all__ = ("TextField",)
 
@@ -6,32 +6,49 @@ import logging
 
 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 TextField(Field, JsonMixin):
-    """Ramifice - Field of Model for enter text."""
+    """Field of Model for enter text.
+
+    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.
+        textarea: Is it necessary to use the Textarea widget.
+        use_editor: Is it necessary to use the widget of the text editor.
+        required: Required field.
+        readonly: Specifies that the field cannot be modified by the user.
+        unique: The unique value of a field in a collection.
+        maxlength: The maximum line length.
+        multi_language: Is it need support for several languages.
+    """
 
     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,
         textarea: bool = False,
         use_editor: bool = False,
-        placeholder: str = "",
         required: bool = False,
         readonly: bool = False,
         unique: bool = False,
         maxlength: int = 256,
         # Support for several language.
         multi_language: bool = False,
-    ):
+    ) -> None:
         if constants.DEBUG:
             try:
                 if not isinstance(maxlength, int):
@@ -96,7 +113,7 @@ class TextField(Field, JsonMixin):
         self.multi_language = multi_language
 
     def __len__(self) -> int:
-        """Ramifice - Return length of field `value`."""
+        """Return length of field `value`."""
         value = self.value
         if isinstance(value, str):
             return len(value)

ramifice/fields/url_field.py

@@ -1,4 +1,4 @@
-"""Ramifice - Field of Model for enter URL address."""
+"""Field of Model for enter URL address."""
 
 __all__ = ("URLField",)
 
@@ -8,42 +8,42 @@ from urllib.parse import urlparse
 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 URLField(Field, TextGroup, JsonMixin):
-    """Ramifice - Field of Model for enter URL address.
+    """Field of Model for enter URL address.
 
-    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.
-        default -- Value by default.
-        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.
+        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/models/__init__.py

@@ -1 +1,7 @@
-"""Ramifice - Models."""
+"""Models.
+
+This module provides:
+
+- `Model`: Converting Python classes into Ramifice Models.
+- `model`: Decorator for converting Python classes into Ramifice models.
+"""

ramifice/models/decorator.py

@@ -1,4 +1,4 @@
-"""Ramifice - Decorator for converting Python classes into Ramifice models."""
+"""Decorator for converting Python classes into Ramifice models."""
 
 __all__ = ("model",)
 
@@ -25,7 +25,7 @@ def model(
     is_update_doc: bool = True,
     is_delete_doc: bool = True,
 ) -> Any:
-    """Ramifice - Decorator for converting Python Classe into Ramifice Model."""
+    """Decorator for converting Python Classe into Ramifice Model."""
     try:
         if not isinstance(service_name, str):
             msg = "Parameter `service_name` - Must be `str` type!"
@@ -96,7 +96,7 @@ def model(
 
 
 def caching(cls: Any, service_name: str) -> dict[str, Any]:
-    """Ramifice - Add additional metadata to `Model.META`."""
+    """Add additional metadata to `Model.META`."""
     metadata: dict[str, Any] = {}
     model_name: str = cls.__name__
     if REGEX["model_name"].match(model_name) is None:

ramifice/models/model.py

@@ -1,4 +1,4 @@
-"""Ramifice - Converting Python classes into Ramifice Models."""
+"""Converting Python classes into Ramifice Models."""
 
 __all__ = ("Model",)
 
@@ -16,7 +16,7 @@ from ramifice.utils import translations
 
 
 class Model(metaclass=ABCMeta):
-    """Ramifice - Converting Python Class into Ramifice Model."""
+    """Converting Python Class into Ramifice Model."""
 
     META: dict[str, Any] = {}
 
@@ -50,25 +50,25 @@ class Model(metaclass=ABCMeta):
 
     @property
     def id(self) -> IDField:
-        """Ramifice - Getter for the field `_id`."""
+        """Getter for the field `_id`."""
         return self._id
 
     @abstractmethod
     def fields(self) -> None:
-        """Ramifice - Adding fields."""
+        """Adding fields."""
         pass
 
     def model_name(self) -> str:
-        """Ramifice - Get Model name - Class name."""
+        """Get Model name - Class name."""
         return self.__class__.__name__
 
     def full_model_name(self) -> str:
-        """Ramifice - Get full Model name - module_name + . + ClassName."""
+        """Get full Model name - module_name + . + ClassName."""
         cls = self.__class__
         return f"{cls.__module__}.{cls.__name__}"
 
     def inject(self) -> None:
-        """Ramifice - Injecting metadata from Model.META in params of fields."""
+        """Injecting metadata from Model.META in params of fields."""
         metadata = self.__class__.META
         if bool(metadata):
             lang = translations.CURRENT_LOCALE
@@ -92,7 +92,7 @@ class Model(metaclass=ABCMeta):
     # Complect of methods for converting Model to JSON and back.
     # --------------------------------------------------------------------------
     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):
@@ -100,12 +100,12 @@ class Model(metaclass=ABCMeta):
         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():
             obj.__dict__[name] = obj.__dict__[name].__class__.from_dict(data)
@@ -113,13 +113,13 @@ class Model(metaclass=ABCMeta):
 
     @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)
 
     # --------------------------------------------------------------------------
     def to_dict_only_value(self) -> dict[str, Any]:
-        """Ramifice - Convert model.field.value (only the `value` attribute) to a dictionary."""
+        """Convert model.field.value (only the `value` attribute) to a dictionary."""
         json_dict: dict[str, Any] = {}
         current_locale = translations.CURRENT_LOCALE
         for name, data in self.__dict__.items():
@@ -150,12 +150,12 @@ class Model(metaclass=ABCMeta):
         return json_dict
 
     def to_json_only_value(self) -> str:
-        """Ramifice - Convert model.field.value (only the `value` attribute) to a JSON string."""
+        """Convert model.field.value (only the `value` attribute) to a JSON string."""
         return orjson.dumps(self.to_dict_only_value()).decode("utf-8")
 
     @classmethod
     def from_dict_only_value(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 obj.__dict__.items():
             if callable(data):
@@ -172,12 +172,12 @@ class Model(metaclass=ABCMeta):
 
     @classmethod
     def from_json_only_value(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_only_value(json_dict)
 
     def refrash_fields_only_value(self, only_value_dict: dict[str, Any]) -> None:
-        """Ramifice - Partial or complete update a `value` of fields."""
+        """Partial or complete update a `value` of fields."""
         for name, data in self.__dict__.items():
             if callable(data):
                 continue