ramifice 0.5.11__py3-none-any.whl → 0.6.0__py3-none-any.whl

ramifice/fields/image_field.py

@@ -1,20 +1,19 @@
 """Field of Model for upload image."""
 
 import os
-import shutil
 import uuid
 from base64 import b64decode
 from datetime import date
 from pathlib import Path
-from typing import Any
 
-from PIL import Image
+import aiofiles
+from aioshutil import copyfile
 
-from ..utils import globals
-from ..utils.errors import FileHasNoExtensionError
-from ..utils.mixins.json_converter import JsonMixin
-from .general.field import Field
-from .general.file_group import FileGroup
+from ramifice.fields.general.field import Field
+from ramifice.fields.general.file_group import FileGroup
+from ramifice.utils import globals
+from ramifice.utils.errors import FileHasNoExtensionError
+from ramifice.utils.mixins.json_converter import JsonMixin
 
 
 class ImageField(Field, FileGroup, JsonMixin):
@@ -38,8 +37,6 @@ class ImageField(Field, FileGroup, JsonMixin):
         # Available 4 sizes from lg to xs or None.
         # Example: {"lg": 1200, "md": 600, "sm": 300, "xs": 150 }
         thumbnails: dict[str, int] | None = None,
-        # True - high quality and low performance for thumbnails.
-        high_quality: bool = False,
     ):
         if globals.DEBUG:
             if default is not None:
@@ -98,8 +95,6 @@ class ImageField(Field, FileGroup, JsonMixin):
                 raise AssertionError("Parameter `target_dir` - Not а `str` type!")
             if not isinstance(accept, str):
                 raise AssertionError("Parameter `accept` - Not а `str` type!")
-            if not isinstance(high_quality, bool):
-                raise AssertionError("Parameter `high_quality` - Not а `bool` type!")
 
         Field.__init__(
             self,
@@ -127,10 +122,8 @@ class ImageField(Field, FileGroup, JsonMixin):
         # Available 4 sizes from lg to xs or None.
         # Example: {"lg": 1200, "md": 600, "sm": 300, "xs": 150 }
         self.thumbnails = thumbnails
-        # True is high quality and low performance.
-        self.high_quality = high_quality
 
-    def from_base64(
+    async def from_base64(
         self,
         base64_str: str | None = None,
         filename: str | None = None,
@@ -170,21 +163,15 @@ class ImageField(Field, FileGroup, JsonMixin):
             # Create path to main image.
             main_img_path = f"{imgs_dir_path}/{new_original_name}"
             # Create target directory if it does not exist.
-            if not os.path.exists(imgs_dir_path):
-                os.makedirs(imgs_dir_path)
+            if not await aiofiles.os.path.exists(imgs_dir_path):
+                await aiofiles.os.makedirs(imgs_dir_path)
             # Save main image in target directory.
-            with open(main_img_path, mode="wb") as open_f:
+            async with aiofiles.open(main_img_path, mode="wb") as open_f:
                 f_content = b64decode(base64_str)
-                open_f.write(f_content)
+                await open_f.write(f_content)
             # Add paths for main image.
             img_info["path"] = main_img_path
             img_info["url"] = f"{imgs_dir_url}/{new_original_name}"
-            # Add width and height.
-            if self.__dict__.get("add_width_height", False):
-                with Image.open(main_img_path) as img:
-                    width, height = img.size
-                    img_info["width"] = width
-                    img_info["height"] = height
             # Add original image name.
             img_info["name"] = filename
             # Add image extension.
@@ -199,12 +186,12 @@ class ImageField(Field, FileGroup, JsonMixin):
             # Add url path to target directory with images.
             img_info["imgs_dir_url"] = imgs_dir_url
             # Add size of main image (in bytes).
-            img_info["size"] = os.path.getsize(main_img_path)
+            img_info["size"] = await aiofiles.os.path.getsize(main_img_path)
         #
         # to value.
         self.value = img_info
 
-    def from_path(
+    async def from_path(
         self,
         src_path: str | None = None,
         is_delete: bool = False,
@@ -234,19 +221,13 @@ class ImageField(Field, FileGroup, JsonMixin):
             # Create path to main image.
             main_img_path = f"{imgs_dir_path}/{new_original_name}"
             # Create target directory if it does not exist.
-            if not os.path.exists(imgs_dir_path):
-                os.makedirs(imgs_dir_path)
+            if not await aiofiles.os.path.exists(imgs_dir_path):
+                await aiofiles.os.makedirs(imgs_dir_path)
             # Save main image in target directory.
-            shutil.copyfile(src_path, main_img_path)
+            await copyfile(src_path, main_img_path)
             # Add paths for main image.
             img_info["path"] = main_img_path
             img_info["url"] = f"{imgs_dir_url}/{new_original_name}"
-            # Add width and height.
-            if self.__dict__.get("add_width_height", False):
-                with Image.open(main_img_path) as img:
-                    width, height = img.size
-                    img_info["width"] = width
-                    img_info["height"] = height
             # Add original image name.
             img_info["name"] = os.path.basename(src_path)
             # Add image extension.
@@ -261,7 +242,7 @@ class ImageField(Field, FileGroup, JsonMixin):
             # Add url path to target directory with images.
             img_info["imgs_dir_url"] = imgs_dir_url
             # Add size of main image (in bytes).
-            img_info["size"] = os.path.getsize(main_img_path)
+            img_info["size"] = await aiofiles.os.path.getsize(main_img_path)
         #
         # to value.
         self.value = img_info

ramifice/fields/integer_field.py

@@ -1,9 +1,9 @@
 """Field of Model for enter (int) number."""
 
-from ..utils import globals
-from ..utils.mixins.json_converter import JsonMixin
-from .general.field import Field
-from .general.number_group import NumberGroup
+from ramifice.fields.general.field import Field
+from ramifice.fields.general.number_group import NumberGroup
+from ramifice.utils import globals
+from ramifice.utils.mixins.json_converter import JsonMixin
 
 
 class IntegerField(Field, NumberGroup, JsonMixin):

ramifice/fields/ip_field.py

@@ -2,10 +2,10 @@
 
 import ipaddress
 
-from ..utils import globals
-from ..utils.mixins.json_converter import JsonMixin
-from .general.field import Field
-from .general.text_group import TextGroup
+from ramifice.fields.general.field import Field
+from ramifice.fields.general.text_group import TextGroup
+from ramifice.utils import globals
+from ramifice.utils.mixins.json_converter import JsonMixin
 
 
 class IPField(Field, TextGroup, JsonMixin):

ramifice/fields/password_field.py

@@ -3,8 +3,8 @@
 import json
 from typing import Any
 
-from ..utils import globals
-from .general.field import Field
+from ramifice.fields.general.field import Field
+from ramifice.utils import globals
 
 
 class PasswordField(Field):

ramifice/fields/phone_field.py

@@ -2,10 +2,10 @@
 
 import phonenumbers
 
-from ..utils import globals
-from ..utils.mixins.json_converter import JsonMixin
-from .general.field import Field
-from .general.text_group import TextGroup
+from ramifice.fields.general.field import Field
+from ramifice.fields.general.text_group import TextGroup
+from ramifice.utils import globals
+from ramifice.utils.mixins.json_converter import JsonMixin
 
 
 class PhoneField(Field, TextGroup, JsonMixin):

ramifice/fields/slug_field.py

@@ -1,9 +1,9 @@
 """Field of Model for automatic generation of string `slug`."""
 
-from ..utils import globals
-from ..utils.mixins.json_converter import JsonMixin
-from .general.field import Field
-from .general.text_group import TextGroup
+from ramifice.fields.general.field import Field
+from ramifice.fields.general.text_group import TextGroup
+from ramifice.utils import globals
+from ramifice.utils.mixins.json_converter import JsonMixin
 
 
 class SlugField(Field, TextGroup, JsonMixin):

ramifice/fields/text_field.py

@@ -1,8 +1,8 @@
 """Field of Model for enter text."""
 
-from ..utils import globals
-from ..utils.mixins.json_converter import JsonMixin
-from .general.field import Field
+from ramifice.fields.general.field import Field
+from ramifice.utils import globals
+from ramifice.utils.mixins.json_converter import JsonMixin
 
 
 class TextField(Field, JsonMixin):

ramifice/fields/url_field.py

@@ -2,10 +2,10 @@
 
 from urllib.parse import urlparse
 
-from ..utils import globals
-from ..utils.mixins.json_converter import JsonMixin
-from .general.field import Field
-from .general.text_group import TextGroup
+from ramifice.fields.general.field import Field
+from ramifice.fields.general.text_group import TextGroup
+from ramifice.utils import globals
+from ramifice.utils.mixins.json_converter import JsonMixin
 
 
 class URLField(Field, TextGroup, JsonMixin):

ramifice/models/decorator.py

@@ -4,23 +4,21 @@ import os
 import re
 from typing import Any
 
-from ..commons import QCommonsMixin
-from ..fields import DateTimeField, IDField
-from ..paladins import CheckMixin, QPaladinsMixin, ValidationMixin
-from ..utils.errors import DoesNotMatchRegexError, PanicError
-from ..utils.globals import REGEX
-from ..utils.mixins.add_valid import AddValidMixin
-from ..utils.mixins.hooks import HooksMixin
-from ..utils.mixins.indexing import IndexMixin
-from .model import Model
-from .pseudo import PseudoModel
+from ramifice.commons import QCommonsMixin
+from ramifice.fields import DateTimeField, IDField
+from ramifice.models.model import Model
+from ramifice.paladins import QPaladinsMixin
+from ramifice.utils.errors import DoesNotMatchRegexError, PanicError
+from ramifice.utils.globals import REGEX
+from ramifice.utils.mixins.add_valid import AddValidMixin
+from ramifice.utils.mixins.hooks import HooksMixin
+from ramifice.utils.mixins.indexing import IndexMixin
 
 
 def model(
     service_name: str,
     fixture_name: str | None = None,
     db_query_docs_limit: int = 1000,
-    is_migrate_model: bool = True,
     is_create_doc: bool = True,
     is_update_doc: bool = True,
     is_delete_doc: bool = True,
@@ -32,8 +30,6 @@ def model(
         raise AssertionError("Parameter `fixture_name` - Must be `str | None` type!")
     if not isinstance(db_query_docs_limit, int):
         raise AssertionError("Parameter `db_query_docs_limit` - Must be `int` type!")
-    if not isinstance(is_migrate_model, bool):
-        raise AssertionError("Parameter `is_migrate_model` - Must be `bool` type!")
     if not isinstance(is_create_doc, bool):
         raise AssertionError("Parameter `is_create_doc` - Must be `bool` type!")
     if not isinstance(is_update_doc, bool):
@@ -55,53 +51,37 @@ def model(
                 raise PanicError(msg)
 
         attrs = {key: val for key, val in cls.__dict__.items()}
-        if is_migrate_model:
-            attrs["__dict__"] = Model.__dict__["__dict__"]
-        else:
-            attrs["__dict__"] = PseudoModel.__dict__["__dict__"]
+        attrs["__dict__"] = Model.__dict__["__dict__"]
         metadata = {
             "service_name": service_name,
             "fixture_name": fixture_name,
             "db_query_docs_limit": db_query_docs_limit,
-            "is_migrate_model": is_migrate_model,
-            "is_create_doc": is_create_doc if is_migrate_model else False,
-            "is_update_doc": is_update_doc if is_migrate_model else False,
-            "is_delete_doc": is_delete_doc if is_migrate_model else False,
+            "is_create_doc": is_create_doc,
+            "is_update_doc": is_update_doc,
+            "is_delete_doc": is_delete_doc,
         }
         attrs["META"] = {
             **metadata,
-            **caching(cls, service_name, is_migrate_model),
+            **caching(cls, service_name),
         }
 
-        if is_migrate_model:
-            return type(
-                cls.__name__,
-                (
-                    Model,
-                    QPaladinsMixin,
-                    QCommonsMixin,
-                    AddValidMixin,
-                    IndexMixin,
-                    HooksMixin,
-                ),
-                attrs,
-            )
-        else:
-            return type(
-                cls.__name__,
-                (
-                    PseudoModel,
-                    ValidationMixin,
-                    CheckMixin,
-                    AddValidMixin,
-                ),
-                attrs,
-            )
+        return type(
+            cls.__name__,
+            (
+                Model,
+                QPaladinsMixin,
+                QCommonsMixin,
+                AddValidMixin,
+                IndexMixin,
+                HooksMixin,
+            ),
+            attrs,
+        )
 
     return decorator
 
 
-def caching(cls: Any, service_name: str, is_migrate_model: bool) -> dict[str, Any]:
+def caching(cls: Any, service_name: str) -> dict[str, Any]:
     """Add additional metadata to `Model.META`."""
     metadata: dict[str, Any] = {}
     model_name: str = cls.__name__
@@ -128,11 +108,11 @@ def caching(cls: Any, service_name: str, is_migrate_model: bool) -> dict[str, An
 
     raw_model = cls()
     raw_model.fields()
-    default_fields: dict[str, Any] = {}
-    if is_migrate_model:
-        default_fields["_id"] = IDField()
-        default_fields["created_at"] = DateTimeField()
-        default_fields["updated_at"] = DateTimeField()
+    default_fields: dict[str, Any] = {
+        "_id": IDField(),
+        "created_at": DateTimeField(),
+        "updated_at": DateTimeField(),
+    }
     fields = {**raw_model.__dict__, **default_fields}
     for f_name, f_data in fields.items():
         if not callable(f_data):
@@ -147,19 +127,11 @@ def caching(cls: Any, service_name: str, is_migrate_model: bool) -> dict[str, An
             #
             if not f_data.ignored:
                 # Count fields for migrating.
-                if is_migrate_model:
-                    count_fields_no_ignored += 1
+                count_fields_no_ignored += 1
                 # Get a dictionary of field names and types.
                 field_name_and_type[f_name] = f_type_str
                 # Build data migration storage for dynamic fields.
                 if "Dyn" in f_data.field_type:
-                    if not is_migrate_model:
-                        msg = (
-                            f"Model: `{cls.__module__}.{model_name}` > "
-                            + f"Field: `{f_name}` => "
-                            + "Dynamic field only for a migrated Model."
-                        )
-                        raise PanicError(msg)
                     data_dynamic_fields[f_name] = None
                 if f_data.field_type == "TextField" and f_data.multi_language:
                     supported_lang_fields.append(f_name)

ramifice/models/model.py

@@ -8,8 +8,8 @@ from babel.dates import format_date, format_datetime
 from bson.objectid import ObjectId
 from dateutil.parser import parse
 
-from ..fields import DateTimeField, IDField
-from ..utils import translations
+from ramifice.fields import DateTimeField, IDField
+from ramifice.utils import translations
 
 
 class Model(metaclass=ABCMeta):

ramifice/paladins/__init__.py

@@ -1,11 +1,11 @@
 """Paladins - Model instance methods."""
 
-from .check import CheckMixin
-from .delete import DeleteMixin
-from .password import PasswordMixin
-from .refrash import RefrashMixin
-from .save import SaveMixin
-from .validation import ValidationMixin
+from ramifice.paladins.check import CheckMixin
+from ramifice.paladins.delete import DeleteMixin
+from ramifice.paladins.password import PasswordMixin
+from ramifice.paladins.refrash import RefrashMixin
+from ramifice.paladins.save import SaveMixin
+from ramifice.paladins.validation import ValidationMixin
 
 
 class QPaladinsMixin(

ramifice/paladins/check.py

@@ -1,15 +1,13 @@
 """Validation of Model data before saving to the database."""
 
-import os
-import shutil
 from typing import Any
 
+from aiofiles import os
+from aioshutil import rmtree
 from bson.objectid import ObjectId
 from pymongo.asynchronous.collection import AsyncCollection
 
-from ..utils import globals
-from ..utils.errors import PanicError
-from .groups import (
+from ramifice.paladins.groups import (
     BoolGroupMixin,
     ChoiceGroupMixin,
     DateGroupMixin,
@@ -21,6 +19,8 @@ from .groups import (
     SlugGroupMixin,
     TextGroupMixin,
 )
+from ramifice.utils import globals
+from ramifice.utils.errors import PanicError
 
 
 class CheckMixin(
@@ -48,27 +48,15 @@ class CheckMixin(
         It is also used to verify Models that do not migrate to the database.
         """
         cls_model = self.__class__
-        is_migrate_model: bool = cls_model.META["is_migrate_model"]
 
-        if not is_migrate_model and is_save:
-            msg = (
-                f"Model: `{self.full_model_name()}` > "
-                + "Method: `check` => "
-                + "For a non -migrating Model, the `is_save` parameter must be equal to` False` !"
-            )
-            raise PanicError(msg)
-
-        doc_id: ObjectId | None = None
-        is_update: bool = False
-        if is_migrate_model:
-            # Get the document ID.
-            doc_id = self._id.value
-            # Does the document exist in the database?
-            is_update = doc_id is not None
-            # Create an identifier for a new document.
-            if is_save and not is_update:
-                doc_id = ObjectId()
-                self._id.value = doc_id
+        # Get the document ID.
+        doc_id: ObjectId | None = self._id.value
+        # Does the document exist in the database?
+        is_update: bool = doc_id is not None
+        # Create an identifier for a new document.
+        if is_save and not is_update:
+            doc_id = ObjectId()
+            self._id.value = doc_id
 
         result_map: dict[str, Any] = {}
         # Errors from additional validation of fields.
@@ -86,7 +74,6 @@ class CheckMixin(
             "collection": collection,
             "field_data": None,
             "full_model_name": cls_model.META["full_model_name"],
-            "is_migrate_model": is_migrate_model,
             "is_migration_process": is_migration_process,
             "curr_doc": (
                 await collection.find_one({"_id": doc_id}) if is_save and is_update else None
@@ -116,9 +103,9 @@ class CheckMixin(
                 elif group == "date":
                     self.date_group(params)
                 elif group == "img":
-                    self.img_group(params)
+                    await self.img_group(params)
                 elif group == "file":
-                    self.file_group(params)
+                    await self.file_group(params)
                 elif group == "choice":
                     self.choice_group(params)
                 elif group == "bool":
@@ -146,7 +133,7 @@ class CheckMixin(
                         file_data = result_map.get(field_name)
                         if file_data is not None:
                             if file_data["is_new_file"]:
-                                os.remove(file_data["path"])
+                                await os.remove(file_data["path"])
                             field_data.value = None
                         if curr_doc is not None:
                             field_data.value = curr_doc[field_name]
@@ -154,7 +141,7 @@ class CheckMixin(
                         img_data = result_map.get(field_name)
                         if img_data is not None:
                             if img_data["is_new_img"]:
-                                shutil.rmtree(img_data["imgs_dir_path"])
+                                await rmtree(img_data["imgs_dir_path"])  # type: ignore[call-arg]
                             field_data.value = None
                         if curr_doc is not None:
                             field_data.value = curr_doc[field_name]

ramifice/paladins/delete.py

@@ -1,13 +1,13 @@
 """Delete document from database."""
 
-import os
-import shutil
 from typing import Any
 
+from aiofiles import os
+from aioshutil import rmtree
 from pymongo.asynchronous.collection import AsyncCollection
 
-from ..utils import globals
-from ..utils.errors import PanicError
+from ramifice.utils import globals
+from ramifice.utils.errors import PanicError
 
 
 class DeleteMixin:
@@ -77,12 +77,12 @@ class DeleteMixin:
                 if group == "file":
                     file_data = mongo_doc[field_name]
                     if file_data is not None and len(file_data["path"]) > 0:
-                        os.remove(file_data["path"])
+                        await os.remove(file_data["path"])
                     file_data = None
                 elif group == "img":
                     file_data = mongo_doc[field_name]
                     if file_data is not None and len(file_data["imgs_dir_path"]) > 0:
-                        shutil.rmtree(file_data["imgs_dir_path"])
+                        await rmtree(file_data["imgs_dir_path"])  # type: ignore[call-arg]
                     file_data = None
             field_data.value = None
         # Run hook.

ramifice/paladins/groups/__init__.py

@@ -1,12 +1,12 @@
 """Groups - Model instance methods for specific processing of fields."""
 
-from .bool_group import BoolGroupMixin
-from .choice_group import ChoiceGroupMixin
-from .date_group import DateGroupMixin
-from .file_group import FileGroupMixin
-from .id_group import IDGroupMixin
-from .img_group import ImgGroupMixin
-from .num_group import NumGroupMixin
-from .pass_group import PassGroupMixin
-from .slug_group import SlugGroupMixin
-from .text_group import TextGroupMixin
+from ramifice.paladins.groups.bool_group import BoolGroupMixin
+from ramifice.paladins.groups.choice_group import ChoiceGroupMixin
+from ramifice.paladins.groups.date_group import DateGroupMixin
+from ramifice.paladins.groups.file_group import FileGroupMixin
+from ramifice.paladins.groups.id_group import IDGroupMixin
+from ramifice.paladins.groups.img_group import ImgGroupMixin
+from ramifice.paladins.groups.num_group import NumGroupMixin
+from ramifice.paladins.groups.pass_group import PassGroupMixin
+from ramifice.paladins.groups.slug_group import SlugGroupMixin
+from ramifice.paladins.groups.text_group import TextGroupMixin

ramifice/paladins/groups/bool_group.py

@@ -6,7 +6,7 @@ Supported fields:
 
 from typing import Any
 
-from ..tools import panic_type_error
+from ramifice.paladins.tools import panic_type_error
 
 
 class BoolGroupMixin:

ramifice/paladins/groups/choice_group.py

@@ -9,8 +9,8 @@ Supported fields:
 
 from typing import Any
 
-from ...utils import translations
-from ..tools import accumulate_error
+from ramifice.paladins.tools import accumulate_error
+from ramifice.utils import translations
 
 
 class ChoiceGroupMixin:

ramifice/paladins/groups/date_group.py

@@ -9,8 +9,11 @@ from typing import Any
 
 from babel.dates import format_date, format_datetime
 
-from ...utils import translations
-from ..tools import accumulate_error, panic_type_error
+from ramifice.paladins.tools import (
+    accumulate_error,
+    panic_type_error,
+)
+from ramifice.utils import translations
 
 
 class DateGroupMixin:

ramifice/paladins/groups/file_group.py

@@ -5,9 +5,12 @@ Supported fields: FileField
 
 from typing import Any
 
-from ...utils import translations
-from ...utils.tools import to_human_size
-from ..tools import accumulate_error, panic_type_error
+from ramifice.paladins.tools import (
+    accumulate_error,
+    panic_type_error,
+)
+from ramifice.utils import translations
+from ramifice.utils.tools import to_human_size
 
 
 class FileGroupMixin:
@@ -16,7 +19,7 @@ class FileGroupMixin:
     Supported fields: FileField
     """
 
-    def file_group(self, params: dict[str, Any]) -> None:
+    async def file_group(self, params: dict[str, Any]) -> None:
         """Checking file fields."""
         field = params["field_data"]
         value = field.value or None

ramifice/paladins/groups/id_group.py

@@ -8,8 +8,8 @@ from typing import Any
 
 from bson.objectid import ObjectId
 
-from ...utils import translations
-from ..tools import accumulate_error, panic_type_error
+from ramifice.paladins.tools import accumulate_error, panic_type_error
+from ramifice.utils import translations
 
 
 class IDGroupMixin: