ramifice 0.3.26__py3-none-any.whl → 0.3.28__py3-none-any.whl

ramifice/__init__.py

@@ -14,4 +14,5 @@
 
 """ORM-like API MongoDB for Python language."""
 
-from .decorators import model
+from .models.decorator import model
+from .utils import migration, translations

ramifice/commons/__init__.py

@@ -4,12 +4,10 @@ from .general import GeneralMixin
 from .indexes import IndexMixin
 from .many import ManyMixin
 from .one import OneMixin
-from .tools import ToolMixin
-from .units import UnitMixin
+from .unit_manager import UnitMixin
 
 
 class QCommonsMixin(
-    ToolMixin,
     GeneralMixin,
     OneMixin,
     ManyMixin,

ramifice/commons/general.py

@@ -6,7 +6,7 @@ from pymongo.asynchronous.collection import AsyncCollection
 from pymongo.asynchronous.command_cursor import AsyncCommandCursor
 from pymongo.asynchronous.database import AsyncDatabase
 
-from .. import store
+from ..utils import store
 
 
 class GeneralMixin:

ramifice/commons/indexes.py

@@ -4,7 +4,7 @@ from typing import Any
 
 from pymongo.asynchronous.collection import AsyncCollection
 
-from .. import store
+from ..utils import store
 
 
 class IndexMixin:

ramifice/commons/many.py

@@ -7,8 +7,9 @@ from pymongo.asynchronous.collection import AsyncCollection
 from pymongo.asynchronous.cursor import AsyncCursor, CursorType  # type: ignore[attr-defined]
 from pymongo.results import DeleteResult
 
-from .. import store
-from ..errors import PanicError
+from ..utils import store
+from ..utils.errors import PanicError
+from .tools import mongo_doc_to_raw_doc, password_to_none
 
 
 class ManyMixin:
@@ -67,8 +68,9 @@ class ManyMixin:
             session=session,
             allow_disk_use=allow_disk_use,
         )
+        field_name_and_type = cls.META["field_name_and_type"]  # type: ignore[attr-defined]
         async for mongo_doc in cursor:
-            doc_list.append(cls.password_to_none(mongo_doc))  # type: ignore[attr-defined]
+            doc_list.append(password_to_none(field_name_and_type, mongo_doc))
         return doc_list
 
     @classmethod
@@ -131,8 +133,9 @@ class ManyMixin:
             session=session,
             allow_disk_use=allow_disk_use,
         )
+        field_name_and_type = cls.META["field_name_and_type"]  # type: ignore[attr-defined]
         async for mongo_doc in cursor:
-            doc_list.append(cls.mongo_doc_to_raw_doc(mongo_doc))  # type: ignore[attr-defined]
+            doc_list.append(mongo_doc_to_raw_doc(field_name_and_type, mongo_doc))
         return doc_list
 
     @classmethod
@@ -188,8 +191,9 @@ class ManyMixin:
             session=session,
             allow_disk_use=allow_disk_use,
         )
+        field_name_and_type = cls.META["field_name_and_type"]  # type: ignore[attr-defined]
         async for mongo_doc in cursor:
-            doc_list.append(cls.mongo_doc_to_raw_doc(mongo_doc))  # type: ignore[attr-defined]
+            doc_list.append(mongo_doc_to_raw_doc(field_name_and_type, mongo_doc))
         return json.dumps(doc_list) if len(doc_list) > 0 else None
 
     @classmethod

ramifice/commons/one.py

@@ -5,8 +5,9 @@ from typing import Any
 from pymongo.asynchronous.collection import AsyncCollection
 from pymongo.results import DeleteResult
 
-from .. import store
-from ..errors import PanicError
+from ..utils import store
+from ..utils.errors import PanicError
+from .tools import from_mongo_doc, mongo_doc_to_raw_doc, password_to_none
 
 
 class OneMixin:
@@ -25,7 +26,10 @@ class OneMixin:
         # Get document.
         mongo_doc = await collection.find_one(filter, *args, **kwargs)
         if mongo_doc is not None:
-            mongo_doc = cls.password_to_none(mongo_doc)
+            mongo_doc = password_to_none(
+                cls.META["field_name_and_type"],
+                mongo_doc,
+            )
         return mongo_doc
 
     @classmethod
@@ -42,7 +46,10 @@ class OneMixin:
         raw_doc = None
         mongo_doc = await collection.find_one(filter, *args, **kwargs)
         if mongo_doc is not None:
-            raw_doc = cls.mongo_doc_to_raw_doc(mongo_doc)
+            raw_doc = mongo_doc_to_raw_doc(
+                cls.META["field_name_and_type"],
+                mongo_doc,
+            )
         return raw_doc
 
     @classmethod
@@ -60,7 +67,7 @@ class OneMixin:
         mongo_doc = await collection.find_one(filter, *args, **kwargs)
         if mongo_doc is not None:
             # Convert document to Model instance.
-            inst_model = cls.from_mongo_doc(mongo_doc)
+            inst_model = from_mongo_doc(cls, mongo_doc)
         return inst_model
 
     @classmethod
@@ -78,7 +85,7 @@ class OneMixin:
         mongo_doc = await collection.find_one(filter, *args, **kwargs)
         if mongo_doc is not None:
             # Convert document to Model instance.
-            inst_model = cls.from_mongo_doc(mongo_doc)
+            inst_model = from_mongo_doc(cls, mongo_doc)
             json_str = inst_model.to_json()
         return json_str
 
@@ -149,5 +156,8 @@ class OneMixin:
             **kwargs,
         )
         if mongo_doc is not None:
-            mongo_doc = cls.password_to_none(mongo_doc)
+            mongo_doc = password_to_none(
+                cls.META["field_name_and_type"],
+                mongo_doc,
+            )
         return mongo_doc

ramifice/commons/tools.py

@@ -4,60 +4,65 @@ from typing import Any
 
 from babel.dates import format_date, format_datetime
 
-from .. import translations
-
-
-class ToolMixin:
-    """Tool of Commons - A set of auxiliary methods."""
-
-    @classmethod
-    def password_to_none(cls: Any, mongo_doc: dict[str, Any]) -> dict[str, Any]:
-        """Create object instance from Mongo document."""
-        for f_name, t_name in cls.META["field_name_and_type"].items():
-            if "Pass" in t_name:
-                mongo_doc[f_name] = None
-        return mongo_doc
-
-    @classmethod
-    def from_mongo_doc(cls: Any, mongo_doc: dict[str, Any]) -> Any:
-        """Create object instance from Mongo document."""
-        obj = cls()
-        for name, data in mongo_doc.items():
-            field = obj.__dict__[name]
-            field.value = data if field.group != "pass" else None
-        return obj
-
-    @classmethod
-    def mongo_doc_to_raw_doc(cls: Any, mongo_doc: dict[str, Any]) -> dict[str, Any]:
-        """Convert the Mongo document to the raw document.
-
-        Special changes:
-            _id to str
-            password to None
-            date to str
-            datetime to str
-        """
-        doc: dict[str, Any] = {}
-        current_locale = translations.CURRENT_LOCALE
-        for f_name, t_name in cls.META["field_name_and_type"].items():
-            value = mongo_doc[f_name]
-            if value is not None:
-                if "Date" in t_name:
-                    if "Time" in t_name:
-                        value = format_datetime(
-                            datetime=value,
-                            format="short",
-                            locale=current_locale,
-                        )
-                    else:
-                        value = format_date(
-                            date=value.date(),
-                            format="short",
-                            locale=current_locale,
-                        )
-                elif "ID" in t_name:
-                    value = str(value)
-                elif "Pass" in t_name:
-                    value = None
-            doc[f_name] = value
-        return doc
+from ..utils import translations
+
+
+def password_to_none(
+    field_name_and_type: dict[str, str],
+    mongo_doc: dict[str, Any],
+) -> dict[str, Any]:
+    """Create object instance from Mongo document."""
+    for f_name, t_name in field_name_and_type.items():
+        if "Pass" in t_name:
+            mongo_doc[f_name] = None
+    return mongo_doc
+
+
+def from_mongo_doc(
+    cls_model: Any,
+    mongo_doc: dict[str, Any],
+) -> Any:
+    """Create object instance from Mongo document."""
+    obj = cls_model()
+    for name, data in mongo_doc.items():
+        field = obj.__dict__[name]
+        field.value = data if field.group != "pass" else None
+    return obj
+
+
+def mongo_doc_to_raw_doc(
+    field_name_and_type: dict[str, str],
+    mongo_doc: dict[str, Any],
+) -> dict[str, Any]:
+    """Convert the Mongo document to the raw document.
+
+    Special changes:
+        _id to str
+        password to None
+        date to str
+        datetime to str
+    """
+    doc: dict[str, Any] = {}
+    current_locale = translations.CURRENT_LOCALE
+    for f_name, t_name in field_name_and_type.items():
+        value = mongo_doc[f_name]
+        if value is not None:
+            if "Date" in t_name:
+                if "Time" in t_name:
+                    value = format_datetime(
+                        datetime=value,
+                        format="short",
+                        locale=current_locale,
+                    )
+                else:
+                    value = format_date(
+                        date=value.date(),
+                        format="short",
+                        locale=current_locale,
+                    )
+            elif "ID" in t_name:
+                value = str(value)
+            elif "Pass" in t_name:
+                value = None
+        doc[f_name] = value
+    return doc

ramifice/commons/{units.py → unit_manager.py}

@@ -7,9 +7,9 @@ from typing import Any
 
 from pymongo.asynchronous.collection import AsyncCollection
 
-from .. import store
-from ..errors import PanicError
-from ..types import Unit
+from ..utils import store
+from ..utils.errors import PanicError
+from ..utils.unit import Unit
 
 
 class UnitMixin:

ramifice/fields/bool_field.py

@@ -1,7 +1,7 @@
 """Field of Model for enter boolean value."""
 
-from .. import store
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.mixins.json_converter import JsonMixin
 from .general.field import Field
 
 

ramifice/fields/choice_float_dyn_field.py

@@ -3,8 +3,8 @@
 Type of selective float field with dynamic addition of elements.
 """
 
-from .. import store
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.mixins.json_converter import JsonMixin
 from .general.choice_group import ChoiceGroup
 from .general.field import Field
 

ramifice/fields/choice_float_field.py

@@ -3,8 +3,8 @@
 Type of selective float field with static of elements.
 """
 
-from .. import store
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.mixins.json_converter import JsonMixin
 from .general.choice_group import ChoiceGroup
 from .general.field import Field
 

ramifice/fields/choice_float_mult_dyn_field.py

@@ -3,8 +3,8 @@
 Type of selective float field with dynamic addition of elements.
 """
 
-from .. import store
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.mixins.json_converter import JsonMixin
 from .general.choice_group import ChoiceGroup
 from .general.field import Field
 

ramifice/fields/choice_float_mult_field.py

@@ -3,8 +3,8 @@
 Type of selective float field with static of elements.
 """
 
-from .. import store
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.mixins.json_converter import JsonMixin
 from .general.choice_group import ChoiceGroup
 from .general.field import Field
 

ramifice/fields/choice_int_dyn_field.py

@@ -3,8 +3,8 @@
 Type of selective integer field with dynamic addition of elements.
 """
 
-from .. import store
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.mixins.json_converter import JsonMixin
 from .general.choice_group import ChoiceGroup
 from .general.field import Field
 

ramifice/fields/choice_int_field.py

@@ -3,8 +3,8 @@
 Type of selective integer field with static of elements.
 """
 
-from .. import store
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.mixins.json_converter import JsonMixin
 from .general.choice_group import ChoiceGroup
 from .general.field import Field
 

ramifice/fields/choice_int_mult_dyn_field.py

@@ -3,8 +3,8 @@
 Type of selective integer field with dynamic addition of elements.
 """
 
-from .. import store
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.mixins.json_converter import JsonMixin
 from .general.choice_group import ChoiceGroup
 from .general.field import Field
 

ramifice/fields/choice_int_mult_field.py

@@ -3,8 +3,8 @@
 Type of selective integer field with static of elements.
 """
 
-from .. import store
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.mixins.json_converter import JsonMixin
 from .general.choice_group import ChoiceGroup
 from .general.field import Field
 

ramifice/fields/choice_text_dyn_field.py

@@ -3,8 +3,8 @@
 Type of selective text field with dynamic addition of elements.
 """
 
-from .. import store
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.mixins.json_converter import JsonMixin
 from .general.choice_group import ChoiceGroup
 from .general.field import Field
 

ramifice/fields/choice_text_field.py

@@ -3,8 +3,8 @@
 Type of selective text field with static of elements.
 """
 
-from .. import store
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.mixins.json_converter import JsonMixin
 from .general.choice_group import ChoiceGroup
 from .general.field import Field
 

ramifice/fields/choice_text_mult_dyn_field.py

@@ -3,8 +3,8 @@
 Type of selective text field with dynamic addition of elements.
 """
 
-from .. import store
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.mixins.json_converter import JsonMixin
 from .general.choice_group import ChoiceGroup
 from .general.field import Field
 

ramifice/fields/choice_text_mult_field.py

@@ -3,8 +3,8 @@
 Type of selective text field with static of elements.
 """
 
-from .. import store
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.mixins.json_converter import JsonMixin
 from .general.choice_group import ChoiceGroup
 from .general.field import Field
 

ramifice/fields/color_field.py

@@ -1,7 +1,7 @@
 """Field of Model for enter color code."""
 
-from .. import store
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.mixins.json_converter import JsonMixin
 from .general.field import Field
 from .general.text_group import TextGroup
 

ramifice/fields/date_field.py

@@ -7,7 +7,7 @@ from typing import Any
 from babel.dates import format_date
 from dateutil.parser import parse
 
-from .. import store, translations
+from ..utils import store, translations
 from .general.date_group import DateGroup
 from .general.field import Field
 

ramifice/fields/date_time_field.py

@@ -7,7 +7,7 @@ from typing import Any
 from babel.dates import format_datetime
 from dateutil.parser import parse
 
-from .. import store, translations
+from ..utils import store, translations
 from .general.date_group import DateGroup
 from .general.field import Field
 

ramifice/fields/email_field.py

@@ -2,8 +2,8 @@
 
 from email_validator import EmailNotValidError, validate_email
 
-from .. import store
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.mixins.json_converter import JsonMixin
 from .general.field import Field
 from .general.text_group import TextGroup
 

ramifice/fields/file_field.py

@@ -8,9 +8,9 @@ from datetime import date
 from pathlib import Path
 from typing import Any
 
-from .. import store
-from ..errors import FileHasNoExtensionError
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.errors import FileHasNoExtensionError
+from ..utils.mixins.json_converter import JsonMixin
 from .general.field import Field
 from .general.file_group import FileGroup
 

ramifice/fields/float_field.py

@@ -1,7 +1,7 @@
 """Field of Model for enter (float) number."""
 
-from .. import store
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.mixins.json_converter import JsonMixin
 from .general.field import Field
 from .general.number_group import NumberGroup
 

ramifice/fields/id_field.py

@@ -5,7 +5,7 @@ from typing import Any
 
 from bson.objectid import ObjectId
 
-from .. import store
+from ..utils import store
 from .general.field import Field
 
 

ramifice/fields/image_field.py

@@ -10,9 +10,9 @@ from typing import Any
 
 from PIL import Image
 
-from .. import store
-from ..errors import FileHasNoExtensionError
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.errors import FileHasNoExtensionError
+from ..utils.mixins.json_converter import JsonMixin
 from .general.field import Field
 from .general.file_group import FileGroup
 

ramifice/fields/integer_field.py

@@ -1,7 +1,7 @@
 """Field of Model for enter (int) number."""
 
-from .. import store
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.mixins.json_converter import JsonMixin
 from .general.field import Field
 from .general.number_group import NumberGroup
 

ramifice/fields/ip_field.py

@@ -2,8 +2,8 @@
 
 import ipaddress
 
-from .. import store
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.mixins.json_converter import JsonMixin
 from .general.field import Field
 from .general.text_group import TextGroup
 

ramifice/fields/password_field.py

@@ -3,7 +3,7 @@
 import json
 from typing import Any
 
-from .. import store
+from ..utils import store
 from .general.field import Field
 
 

ramifice/fields/phone_field.py

@@ -2,8 +2,8 @@
 
 import phonenumbers
 
-from .. import store
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.mixins.json_converter import JsonMixin
 from .general.field import Field
 from .general.text_group import TextGroup
 

ramifice/fields/slug_field.py

@@ -1,7 +1,7 @@
 """Field of Model for automatic generation of string `slug`."""
 
-from .. import store
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.mixins.json_converter import JsonMixin
 from .general.field import Field
 from .general.text_group import TextGroup
 

ramifice/fields/text_field.py

@@ -1,7 +1,7 @@
 """Field of Model for enter text."""
 
-from .. import store
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.mixins.json_converter import JsonMixin
 from .general.field import Field
 from .general.text_group import TextGroup
 

ramifice/fields/url_field.py

@@ -2,8 +2,8 @@
 
 from urllib.parse import urlparse
 
-from .. import store
-from ..mixins import JsonMixin
+from ..utils import store
+from ..utils.mixins.json_converter import JsonMixin
 from .general.field import Field
 from .general.text_group import TextGroup
 

ramifice/models/__init__.py

@@ -0,0 +1 @@
+"""Models."""