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

ramifice/fields/float_field.py

@@ -14,18 +14,36 @@ logger = logging.getLogger(__name__)
 
 
 class FloatField(Field, NumberGroup, JsonMixin):
-    """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,

ramifice/fields/general/choice_group.py

@@ -2,10 +2,8 @@
 
 __all__ = ("ChoiceGroup",)
 
-from abc import ABCMeta
 
-
-class ChoiceGroup(metaclass=ABCMeta):
+class ChoiceGroup:  # noqa: B903
     """General additional parameters for choice fields.
 
     Args:

ramifice/fields/general/date_group.py

@@ -2,11 +2,10 @@
 
 __all__ = ("DateGroup",)
 
-from abc import ABCMeta
 from datetime import datetime
 
 
-class DateGroup(metaclass=ABCMeta):
+class DateGroup:
     """General additional parameters for date|datetime fields.
 
     Args:

ramifice/fields/general/field.py

@@ -2,10 +2,8 @@
 
 __all__ = ("Field",)
 
-from abc import ABCMeta
 
-
-class Field(metaclass=ABCMeta):
+class Field:
     """General parameters for all types fields of Model.
 
     Args:
@@ -28,7 +26,7 @@ class Field(metaclass=ABCMeta):
         ignored: bool = False,
         hint: str = "",
         warning: list[str] | None = None,
-        errors: list[str] = [],
+        errors: list[str] = [],  # noqa: B006
         field_type: str = "",
         group: str = "",
     ) -> None:

ramifice/fields/general/file_group.py

@@ -2,10 +2,8 @@
 
 __all__ = ("FileGroup",)
 
-from abc import ABCMeta
 
-
-class FileGroup(metaclass=ABCMeta):
+class FileGroup:
     """General additional parameters for file fields.
 
     Args:

ramifice/fields/general/number_group.py

@@ -2,10 +2,8 @@
 
 __all__ = ("NumberGroup",)
 
-from abc import ABCMeta
 
-
-class NumberGroup(metaclass=ABCMeta):
+class NumberGroup:  # noqa: B903
     """General additional parameters for number fields.
 
     Args:

ramifice/fields/general/text_group.py

@@ -2,10 +2,8 @@
 
 __all__ = ("TextGroup",)
 
-from abc import ABCMeta
 
-
-class TextGroup(metaclass=ABCMeta):
+class TextGroup:
     """General additional parameters for text fields.
 
     Args:

ramifice/fields/id_field.py

@@ -17,23 +17,28 @@ logger = logging.getLogger(__name__)
 class IDField(Field):
     """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,

ramifice/fields/image_field.py

@@ -5,7 +5,7 @@ __all__ = ("ImageField",)
 import logging
 import uuid
 from base64 import b64decode
-from datetime import date
+from datetime import datetime
 from os import makedirs
 from os.path import basename, exists, getsize
 from shutil import copyfile
@@ -23,25 +23,40 @@ logger = logging.getLogger(__name__)
 
 
 class ImageField(Field, FileGroup, JsonMixin):
-    """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:
@@ -50,16 +65,12 @@ class ImageField(Field, FileGroup, JsonMixin):
                     if not isinstance(default, str):
                         raise AssertionError("Parameter `default` - Not а `str` type!")
                     if len(default) == 0:
-                        raise AssertionError(
-                            "The `default` parameter should not contain an empty string!"
-                        )
+                        raise AssertionError("The `default` parameter should not contain an empty string!")
                 if thumbnails is not None:
                     if not isinstance(thumbnails, dict):
                         raise AssertionError("Parameter `thumbnails` - Not а `dict` type!")
                     if len(thumbnails) == 0:
-                        raise AssertionError(
-                            "The `thumbnails` parameter should not contain an empty dictionary!"
-                        )
+                        raise AssertionError("The `thumbnails` parameter should not contain an empty dictionary!")
                     size_name_list = ["lg", "md", "sm", "xs"]
                     curr_size_thumb: int = 0
                     for size_name in thumbnails.keys():
@@ -130,7 +141,6 @@ class ImageField(Field, FileGroup, JsonMixin):
 
         self.value: dict[str, str | int | bool] | None = None
         # Available 4 sizes from lg to xs or None.
-        # Example: {"lg": 1200, "md": 600, "sm": 300, "xs": 150 }
         self.thumbnails = thumbnails
 
     async def from_base64(
@@ -163,7 +173,7 @@ class ImageField(Field, FileGroup, JsonMixin):
                 if item[0] == 40:
                     break
             # Create the current date for the directory name.
-            date_str: str = str(date.today())
+            date_str: str = str(datetime.now().date())  # noqa: DTZ005
             # Directory name for the original image and its thumbnails.
             general_dir = uuid.uuid4()
             # Create path to target directory with images.
@@ -222,7 +232,7 @@ class ImageField(Field, FileGroup, JsonMixin):
                 logger.error(msg)
                 raise FileHasNoExtensionError(msg)
             # Create the current date for the directory name.
-            date_str: str = str(date.today())
+            date_str: str = str(datetime.now().date())  # noqa: DTZ005
             # Directory name for the original image and its thumbnails.
             general_dir = uuid.uuid4()
             # Create path to target directory with images.

ramifice/fields/integer_field.py

@@ -14,18 +14,36 @@ logger = logging.getLogger(__name__)
 
 
 class IntegerField(Field, NumberGroup, JsonMixin):
-    """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,

ramifice/fields/ip_field.py

@@ -14,18 +14,32 @@ logger = logging.getLogger(__name__)
 
 
 class IPField(Field, TextGroup, JsonMixin):
-    """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,
@@ -42,7 +56,7 @@ class IPField(Field, TextGroup, JsonMixin):
                     try:
                         ipaddress.ip_address(default)
                     except ValueError:
-                        raise AssertionError("Parameter `default` - Invalid IP address!")
+                        raise AssertionError("Parameter `default` - Invalid IP address!")  # noqa: B904
                 if not isinstance(label, str):
                     raise AssertionError("Parameter `default` - Not а `str` type!")
                 if not isinstance(disabled, bool):

ramifice/fields/password_field.py

@@ -16,20 +16,29 @@ logger = logging.getLogger(__name__)
 class PasswordField(Field):
     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:

ramifice/fields/phone_field.py

@@ -17,19 +17,33 @@ logger = logging.getLogger(__name__)
 class PhoneField(Field, TextGroup, JsonMixin):
     """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,
@@ -48,7 +62,7 @@ class PhoneField(Field, TextGroup, JsonMixin):
                         if not phonenumbers.is_valid_number(phone_default):
                             raise AssertionError()
                     except phonenumbers.phonenumberutil.NumberParseException:
-                        raise AssertionError("Parameter `default` - Invalid Phone number!")
+                        raise AssertionError("Parameter `default` - Invalid Phone number!")  # noqa: B904
                 if not isinstance(label, str):
                     raise AssertionError("Parameter `default` - Not а `str` type!")
                 if not isinstance(disabled, bool):

ramifice/fields/slug_field.py

@@ -16,19 +16,30 @@ class SlugField(Field, TextGroup, JsonMixin):
     """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"],
+        slug_sources: list[str] = ["_id"],  # noqa: B006
     ) -> None:
         if constants.DEBUG:
             try:

ramifice/fields/text_field.py

@@ -12,19 +12,36 @@ logger = logging.getLogger(__name__)
 
 
 class TextField(Field, JsonMixin):
-    """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,

ramifice/fields/url_field.py

@@ -16,30 +16,30 @@ logger = logging.getLogger(__name__)
 class URLField(Field, TextGroup, JsonMixin):
     """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,

ramifice/models/__init__.py

@@ -1 +1,7 @@
-"""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

@@ -61,13 +61,13 @@ def model(
             if not exists(fixture_path):
                 msg = (
                     f"Model: `{cls.__module__}.{cls.__name__}` > "
-                    + f"META param: `fixture_name` => "
+                    + "META param: `fixture_name` => "
                     + f"Fixture the `{fixture_path}` not exists!"
                 )
                 logger.critical(msg)
                 raise PanicError(msg)
 
-        attrs = {key: val for key, val in cls.__dict__.items()}
+        attrs = dict(cls.__dict__)
         attrs["__dict__"] = Model.__dict__["__dict__"]
         metadata = {
             "service_name": service_name,

ramifice/models/model.py

@@ -2,8 +2,8 @@
 
 __all__ = ("Model",)
 
-from abc import ABCMeta, abstractmethod
-from typing import Any
+from abc import abstractmethod
+from typing import Any, ClassVar
 
 import orjson
 from babel.dates import format_date, format_datetime
@@ -15,10 +15,10 @@ from ramifice.fields import DateTimeField, IDField
 from ramifice.utils import translations
 
 
-class Model(metaclass=ABCMeta):
+class Model:
     """Converting Python Class into Ramifice Model."""
 
-    META: dict[str, Any] = {}
+    META: ClassVar[dict[str, Any]] = {}
 
     def __init__(self) -> None:  # noqa: D107
         _ = translations._
@@ -81,9 +81,7 @@ class Model(metaclass=ABCMeta):
                     if "Dyn" in f_type.field_type:
                         dyn_data = data_dynamic_fields[f_name]
                         if dyn_data is not None:
-                            f_type.choices = [
-                                [item["value"], item["title"][lang]] for item in dyn_data
-                            ]
+                            f_type.choices = [[item["value"], item["title"][lang]] for item in dyn_data]
                         else:
                             # This is necessary for
                             # `paladins > refrash > RefrashMixin > refrash_from_db`.

ramifice/paladins/__init__.py

@@ -1,4 +1,19 @@
-"""Paladins - Model instance methods."""
+"""Paladins - Model instance methods.
+
+This module provides:
+
+- `add_validation`: Contains an abstract method for additional validation of fields.
+- `check`: Validation of Model data before saving to the database.
+- `delete`: Delete document from database.
+- `Hooks`: A set of abstract methods for creating hooks.
+- `indexing`: Contains the method for indexing the model in the database.
+- `password`: Verification, replacement and recoverang of password.
+- `refrash_from_db`: Update Model instance from database.
+- `save`: Create or update document in database.
+- `Tools`: A set of auxiliary methods.
+- `is_valid`: Validation of Model.
+- `print_err`: Printing errors to console.
+"""
 
 __all__ = ("QPaladinsMixin",)
 

ramifice/paladins/add_valid.py

@@ -2,14 +2,15 @@
 
 __all__ = ("AddValidMixin",)
 
-from abc import ABCMeta
+from abc import abstractmethod
 
 from xloft import NamedTuple
 
 
-class AddValidMixin(metaclass=ABCMeta):
+class AddValidMixin:
     """Contains an abstract method for additional validation of fields."""
 
+    @abstractmethod
     async def add_validation(self) -> NamedTuple:
         """Additional validation of fields."""
         return NamedTuple()