ramifice 0.3.20__py3-none-any.whl → 0.3.21__py3-none-any.whl

ramifice/decorators.py

@@ -12,6 +12,7 @@ from .hooks import HooksMixin
 from .indexing import IndexMixin
 from .model import Model
 from .paladins import CheckMixin, QPaladinsMixin, ValidationMixin  # type: ignore[attr-defined]
+from .pseudo_model import PseudoModel
 from .store import REGEX
 
 
@@ -55,7 +56,10 @@ def model(
                 raise PanicError(msg)
 
         attrs = {key: val for key, val in cls.__dict__.items()}
-        attrs["__dict__"] = Model.__dict__["__dict__"]
+        if is_migrate_model:
+            attrs["__dict__"] = Model.__dict__["__dict__"]
+        else:
+            attrs["__dict__"] = PseudoModel.__dict__["__dict__"]
         metadata = {
             "service_name": service_name,
             "fixture_name": fixture_name,
@@ -67,7 +71,7 @@ def model(
         }
         attrs["META"] = {
             **metadata,
-            **caching(cls, service_name),
+            **caching(cls, service_name, is_migrate_model),
         }
 
         if is_migrate_model:
@@ -87,7 +91,7 @@ def model(
             return type(
                 cls.__name__,
                 (
-                    Model,
+                    PseudoModel,
                     ValidationMixin,
                     CheckMixin,
                     AddValidMixin,
@@ -98,7 +102,7 @@ def model(
     return decorator
 
 
-def caching(cls: Any, service_name: str) -> dict[str, Any]:
+def caching(cls: Any, service_name: str, is_migrate_model: bool) -> dict[str, Any]:
     """Add additional metadata to `Model.META`."""
     metadata: dict[str, Any] = {}
     model_name = cls.__name__
@@ -122,11 +126,10 @@ def caching(cls: Any, service_name: str) -> dict[str, Any]:
 
     raw_model = cls()
     raw_model.fields()
-    default_fields: dict[str, Any] = {
-        "_id": IDField(),
-        "created_at": DateTimeField(),
-        "updated_at": DateTimeField(),
-    }
+    default_fields: dict[str, Any] = {"_id": IDField()}
+    if is_migrate_model:
+        default_fields["created_at"] = DateTimeField()
+        default_fields["updated_at"] = DateTimeField()
     fields = {**raw_model.__dict__, **default_fields}
     for f_name, f_type in fields.items():
         if not callable(f_type):
@@ -141,7 +144,8 @@ def caching(cls: Any, service_name: str) -> dict[str, Any]:
             #
             if not f_type.ignored:
                 # Count fields for migrating.
-                count_fields_for_migrating += 1
+                if is_migrate_model:
+                    count_fields_for_migrating += 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.

ramifice/model.py

@@ -1,8 +1,6 @@
 """For converting Python classes into Ramifice Model."""
 
 import json
-import os
-import shutil
 from abc import ABCMeta, abstractmethod
 from typing import Any
 
@@ -15,7 +13,7 @@ from .fields import DateTimeField, IDField  # type: ignore[attr-defined]
 
 
 class Model(metaclass=ABCMeta):
-    """For converting Python classes into Ramifice Model."""
+    """For converting Python Class into Ramifice Model."""
 
     META: dict[str, Any] = {}
 
@@ -46,29 +44,6 @@ class Model(metaclass=ABCMeta):
         )
         self.fields()
         self.inject()
-        if not self.__class__.META["is_migrate_model"]:
-            for _, f_type in self.__dict__.items():
-                if not callable(f_type):
-                    if f_type.group == "img":
-                        f_type.__dict__["add_width_height"] = True
-
-    def __del__(self) -> None:  # noqa: D105
-        # If the model is not migrated,
-        # it must delete files and images in the destructor.
-        if not self.__class__.META["is_migrate_model"]:
-            for _, f_type in self.__dict__.items():
-                if not callable(f_type):
-                    value = f_type.value
-                    if value is None:
-                        continue
-                    if f_type.group == "file":
-                        value = value.get("path")
-                        if value is not None:
-                            os.remove(value)
-                    elif f_type.group == "img":
-                        value = value.get("imgs_dir_path")
-                        if value is not None:
-                            shutil.rmtree(value)
 
     @abstractmethod
     def fields(self) -> None:

ramifice/pseudo_model.py

@@ -0,0 +1,183 @@
+"""For converting Python classes into Ramifice Model."""
+
+import json
+import os
+import shutil
+from abc import ABCMeta, abstractmethod
+from typing import Any
+
+from babel.dates import format_date, format_datetime
+from bson.objectid import ObjectId
+from dateutil.parser import parse
+
+from . import translations
+from .fields import IDField  # type: ignore[attr-defined]
+
+
+class PseudoModel(metaclass=ABCMeta):
+    """For convert the Python class into a pseudo model Ramifice.
+
+    Used for a Model that do not migrate into the database.
+    """
+
+    META: dict[str, Any] = {}
+
+    def __init__(self) -> None:  # noqa: D107
+        self._id = IDField(
+            label="Stub",
+            placeholder="Stub",
+            hint="Stub",
+            hide=True,
+            disabled=True,
+        )
+        self.fields()
+        self.inject()
+        for _, f_type in self.__dict__.items():
+            if not callable(f_type):
+                if f_type.group == "img":
+                    f_type.__dict__["add_width_height"] = True
+
+    def __del__(self) -> None:  # noqa: D105
+        # If the model is not migrated,
+        # it must delete files and images in the destructor.
+        for _, f_type in self.__dict__.items():
+            if not callable(f_type):
+                value = f_type.value
+                if value is None:
+                    continue
+                if f_type.group == "file":
+                    value = value.get("path")
+                    if value is not None:
+                        os.remove(value)
+                elif f_type.group == "img":
+                    value = value.get("imgs_dir_path")
+                    if value is not None:
+                        shutil.rmtree(value)
+
+    @abstractmethod
+    def fields(self) -> None:
+        """For adding fields."""
+        pass
+
+    def model_name(self) -> str:
+        """Get Model name - Class name."""
+        return self.__class__.__name__
+
+    def full_model_name(self) -> str:
+        """Get full Model name - module_name + . + ClassName."""
+        cls = self.__class__
+        return f"{cls.__module__}.{cls.__name__}"
+
+    def inject(self) -> None:
+        """Injecting metadata from Model.META in params of fields."""
+        metadata = self.__class__.META
+        if bool(metadata):
+            field_attrs = metadata["field_attrs"]
+            data_dynamic_fields = metadata["data_dynamic_fields"]
+            for f_name, f_type in self.__dict__.items():
+                if not callable(f_type):
+                    f_type.id = field_attrs[f_name]["id"]
+                    f_type.name = field_attrs[f_name]["name"]
+                    if "Dyn" in f_type.field_type:
+                        f_type.choices = data_dynamic_fields[f_name]
+
+    # Complect of methods for converting Model to JSON and back.
+    # --------------------------------------------------------------------------
+    def to_dict(self) -> dict[str, Any]:
+        """Convert object instance to a dictionary."""
+        json_dict: dict[str, Any] = {}
+        for name, data in self.__dict__.items():
+            if not callable(data):
+                json_dict[name] = data.to_dict()
+        return json_dict
+
+    def to_json(self) -> str:
+        """Convert object instance to a JSON string."""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_dict(cls, json_dict: dict[str, Any]) -> Any:
+        """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)
+        return obj
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Any:
+        """Convert JSON string to a object instance."""
+        json_dict = json.loads(json_str)
+        return cls.from_dict(json_dict)
+
+    # --------------------------------------------------------------------------
+    def to_dict_only_value(self) -> dict[str, Any]:
+        """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():
+            if callable(data):
+                continue
+            value = data.value
+            if value is not None:
+                group = data.group
+                if group == "date":
+                    value = (
+                        format_date(
+                            date=value,
+                            format="short",
+                            locale=current_locale,
+                        )
+                        if data.field_type == "DateField"
+                        else format_datetime(
+                            datetime=value,
+                            format="short",
+                            locale=current_locale,
+                        )
+                    )
+                elif group == "id":
+                    value = str(value)
+                elif group == "pass":
+                    value = None
+            json_dict[name] = value
+        return json_dict
+
+    def to_json_only_value(self) -> str:
+        """Convert model.field.value (only the `value` attribute) to a JSON string."""
+        return json.dumps(self.to_dict_only_value())
+
+    @classmethod
+    def from_dict_only_value(cls, json_dict: dict[str, Any]) -> Any:
+        """Convert JSON string to a object instance."""
+        obj = cls()
+        for name, data in obj.__dict__.items():
+            if callable(data):
+                continue
+            value = json_dict.get(name)
+            if value is not None:
+                group = data.group
+                if group == "date":
+                    value = parse(value)
+                elif group == "id":
+                    value = ObjectId(value)
+            obj.__dict__[name].value = value
+        return obj
+
+    @classmethod
+    def from_json_only_value(cls, json_str: str) -> Any:
+        """Convert JSON string to a object instance."""
+        json_dict = json.loads(json_str)
+        return cls.from_dict_only_value(json_dict)
+
+    def refrash_fields(self, only_value_dict: dict[str, Any]) -> None:
+        """Partial or complete update a `value` of fields."""
+        for name, data in self.__dict__.items():
+            if callable(data):
+                continue
+            value = only_value_dict.get(name)
+            if value is not None:
+                group = data.group
+                if group == "date":
+                    value = parse(value)
+                elif group == "id":
+                    value = ObjectId(value)
+            self.__dict__[name].value = value

{ramifice-0.3.20.dist-info → ramifice-0.3.21.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ramifice
-Version: 0.3.20
+Version: 0.3.21
 Summary: ORM-like API MongoDB for Python language.
 Project-URL: Homepage, https://github.com/kebasyaty/ramifice
 Project-URL: Documentation, https://kebasyaty.github.io/ramifice/

{ramifice-0.3.20.dist-info → ramifice-0.3.21.dist-info}/RECORD

@@ -1,13 +1,14 @@
 ramifice/__init__.py,sha256=ISlaL2BprlJLE_N1fvtAqGrB3Dhniy9IZGoyWEYZhRU,678
 ramifice/add_valid.py,sha256=kvpMg7snL9tor0A23XRdgwiXazRwHfb8baoJUNjM_4Y,327
-ramifice/decorators.py,sha256=txbTYnKw5AtRZb7IshOzEHuoy8MAPB8wBcCTbk-6CcE,6181
+ramifice/decorators.py,sha256=X4UnHrbuMObv10dooNip3u9ihfdNvFqeMcfLNuhLlbg,6466
 ramifice/errors.py,sha256=iuhq7fzpUmsOyeXeg2fJjta8yAuqlXLKsZVMpfUhtHE,1901
 ramifice/fixtures.py,sha256=NtxOnZslYJb4yvRpZbs3ckugmTwHQFS_9iCt2zddOC0,3102
 ramifice/hooks.py,sha256=Ri-ISfMT-IHaLO2eAqg8CODCTs3HRTxSylqspUKnVf4,873
 ramifice/indexing.py,sha256=wQpX2qei5Zc7iIq5yIV93Skp8Aa8ZD0vybnEk7cRuXs,271
 ramifice/migration.py,sha256=t_Rm1OUQYrlaPQQd1uS5S7EYMvSuKUcWzi7P4JMkrOw,11114
 ramifice/mixins.py,sha256=gKLmWQ-QrGO3K5_k-h1tDa08lkCql_dte2Jy05q1wsM,1125
-ramifice/model.py,sha256=hKA_BrGBWcn-mYB9dHIJoSJYEteO6SdJdgwgjdaV7mc,7632
+ramifice/model.py,sha256=xhLKosxnT3HkPr6j_BSkB7pvG2WNY_7uylcHo3Oq0vM,6521
+ramifice/pseudo_model.py,sha256=AdETZEvffFvHogtL0NYzp1rqLaI5lq3XcVX1n5v62bw,6816
 ramifice/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ramifice/store.py,sha256=MpDEPvUvbs11FXjakNtHPm9MekIv5p1U3as2Y80lTyc,1860
 ramifice/translations.py,sha256=GNGE0ULAA0aOY5pTxUd3MQW-nVaKvp6BeXWEcsR0s0o,4048
@@ -75,7 +76,7 @@ ramifice/paladins/groups/num_group.py,sha256=Jvb-lwHxapQybbLerC4t-_yO8N7Coo1fIlZ
 ramifice/paladins/groups/pass_group.py,sha256=SEKpR2voNQtmywugDXJKY4XqPTL91CrJ87h0QNMqQqs,1952
 ramifice/paladins/groups/slug_group.py,sha256=_IRil2PwpY7cH7WaExNksKz61kQjvc27blrEufgUB30,2323
 ramifice/paladins/groups/text_group.py,sha256=nYZGwAIsJD-tX8RBtFlWvngO9RU4V0CnREUhxvV2UDo,3493
-ramifice-0.3.20.dist-info/METADATA,sha256=ZpWGFOazkmaGbW9rMKja65dApz_DHCrA2_PBCynIqzw,18904
-ramifice-0.3.20.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-ramifice-0.3.20.dist-info/licenses/LICENSE,sha256=LrEL0aTZx90HDwFUQCJutORiDjJL9AnuVvCtspXIqt4,1095
-ramifice-0.3.20.dist-info/RECORD,,
+ramifice-0.3.21.dist-info/METADATA,sha256=4pWgH5EVC0dvdG2SGf4smhNUkvdXzbOEymF3YcYfvzQ,18904
+ramifice-0.3.21.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ramifice-0.3.21.dist-info/licenses/LICENSE,sha256=LrEL0aTZx90HDwFUQCJutORiDjJL9AnuVvCtspXIqt4,1095
+ramifice-0.3.21.dist-info/RECORD,,