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

ramifice/fields/email_field.py

@@ -2,7 +2,7 @@
 
 from email_validator import EmailNotValidError, validate_email
 
-from ..utils import store
+from ..utils import globals
 from ..utils.mixins.json_converter import JsonMixin
 from .general.field import Field
 from .general.text_group import TextGroup
@@ -25,7 +25,7 @@ class EmailField(Field, TextGroup, JsonMixin):
         readonly: bool = False,
         unique: bool = False,
     ):
-        if store.DEBUG:
+        if globals.DEBUG:
             if default is not None:
                 if not isinstance(default, str):
                     raise AssertionError("Parameter `default` - Not а `str` type!")

ramifice/fields/file_field.py

@@ -8,7 +8,7 @@ from datetime import date
 from pathlib import Path
 from typing import Any
 
-from ..utils import store
+from ..utils import globals
 from ..utils.errors import FileHasNoExtensionError
 from ..utils.mixins.json_converter import JsonMixin
 from .general.field import Field
@@ -34,7 +34,7 @@ class FileField(Field, FileGroup, JsonMixin):
         target_dir: str = "files",
         accept: str = "",
     ):
-        if store.DEBUG:
+        if globals.DEBUG:
             if default is not None:
                 if not isinstance(default, str):
                     raise AssertionError("Parameter `default` - Not а `str` type!")

ramifice/fields/float_field.py

@@ -1,6 +1,6 @@
 """Field of Model for enter (float) number."""
 
-from ..utils import store
+from ..utils import globals
 from ..utils.mixins.json_converter import JsonMixin
 from .general.field import Field
 from .general.number_group import NumberGroup
@@ -27,7 +27,7 @@ class FloatField(Field, NumberGroup, JsonMixin):
         step: float = 1.0,
         input_type: str = "number",  # number | range
     ):
-        if store.DEBUG:
+        if globals.DEBUG:
             if input_type not in ["number", "range"]:
                 raise AssertionError(
                     "Parameter `input_type` - Invalid input type! "

ramifice/fields/id_field.py

@@ -5,7 +5,7 @@ from typing import Any
 
 from bson.objectid import ObjectId
 
-from ..utils import store
+from ..utils import globals
 from .general.field import Field
 
 
@@ -33,7 +33,7 @@ class IDField(Field):
         readonly: bool = False,
         unique: bool = False,
     ):
-        if store.DEBUG:
+        if globals.DEBUG:
             if not isinstance(label, str):
                 raise AssertionError("Parameter `default` - Not а `str` type!")
             if not isinstance(disabled, bool):

ramifice/fields/image_field.py

@@ -10,7 +10,7 @@ from typing import Any
 
 from PIL import Image
 
-from ..utils import store
+from ..utils import globals
 from ..utils.errors import FileHasNoExtensionError
 from ..utils.mixins.json_converter import JsonMixin
 from .general.field import Field
@@ -41,7 +41,7 @@ class ImageField(Field, FileGroup, JsonMixin):
         # True - high quality and low performance for thumbnails.
         high_quality: bool = False,
     ):
-        if store.DEBUG:
+        if globals.DEBUG:
             if default is not None:
                 if not isinstance(default, str):
                     raise AssertionError("Parameter `default` - Not а `str` type!")

ramifice/fields/integer_field.py

@@ -1,6 +1,6 @@
 """Field of Model for enter (int) number."""
 
-from ..utils import store
+from ..utils import globals
 from ..utils.mixins.json_converter import JsonMixin
 from .general.field import Field
 from .general.number_group import NumberGroup
@@ -27,7 +27,7 @@ class IntegerField(Field, NumberGroup, JsonMixin):
         step: int = 1,
         input_type: str = "number",  # number | range
     ):
-        if store.DEBUG:
+        if globals.DEBUG:
             if input_type not in ["number", "range"]:
                 raise AssertionError(
                     "Parameter `input_type` - Invalid input type! "

ramifice/fields/ip_field.py

@@ -2,7 +2,7 @@
 
 import ipaddress
 
-from ..utils import store
+from ..utils import globals
 from ..utils.mixins.json_converter import JsonMixin
 from .general.field import Field
 from .general.text_group import TextGroup
@@ -25,7 +25,7 @@ class IPField(Field, TextGroup, JsonMixin):
         readonly: bool = False,
         unique: bool = False,
     ):
-        if store.DEBUG:
+        if globals.DEBUG:
             if default is not None:
                 if not isinstance(default, str):
                     raise AssertionError("Parameter `default` - Not а `str` type!")

ramifice/fields/password_field.py

@@ -3,7 +3,7 @@
 import json
 from typing import Any
 
-from ..utils import store
+from ..utils import globals
 from .general.field import Field
 
 
@@ -26,7 +26,7 @@ class PasswordField(Field):
         placeholder: str = "",
         required: bool = False,
     ):
-        if store.DEBUG:
+        if globals.DEBUG:
             if not isinstance(label, str):
                 raise AssertionError("Parameter `default` - Not а `str` type!")
             if not isinstance(hide, bool):

ramifice/fields/phone_field.py

@@ -2,7 +2,7 @@
 
 import phonenumbers
 
-from ..utils import store
+from ..utils import globals
 from ..utils.mixins.json_converter import JsonMixin
 from .general.field import Field
 from .general.text_group import TextGroup
@@ -28,7 +28,7 @@ class PhoneField(Field, TextGroup, JsonMixin):
         readonly: bool = False,
         unique: bool = False,
     ):
-        if store.DEBUG:
+        if globals.DEBUG:
             if default is not None:
                 if not isinstance(default, str):
                     raise AssertionError("Parameter `default` - Not а `str` type!")

ramifice/fields/slug_field.py

@@ -1,6 +1,6 @@
 """Field of Model for automatic generation of string `slug`."""
 
-from ..utils import store
+from ..utils import globals
 from ..utils.mixins.json_converter import JsonMixin
 from .general.field import Field
 from .general.text_group import TextGroup
@@ -24,7 +24,7 @@ class SlugField(Field, TextGroup, JsonMixin):
         readonly: bool = False,
         slug_sources: list[str] = ["_id"],
     ):
-        if store.DEBUG:
+        if globals.DEBUG:
             if not isinstance(label, str):
                 raise AssertionError("Parameter `default` - Not а `str` type!")
             if not isinstance(disabled, bool):

ramifice/fields/text_field.py

@@ -1,6 +1,6 @@
 """Field of Model for enter text."""
 
-from ..utils import store
+from ..utils import globals
 from ..utils.mixins.json_converter import JsonMixin
 from .general.field import Field
 from .general.text_group import TextGroup
@@ -26,7 +26,7 @@ class TextField(Field, TextGroup, JsonMixin):
         unique: bool = False,
         maxlength: int = 256,
     ):
-        if store.DEBUG:
+        if globals.DEBUG:
             if not isinstance(maxlength, int):
                 raise AssertionError("Parameter `maxlength` - Not а `int` type!")
             if default is not None:

ramifice/fields/url_field.py

@@ -2,7 +2,7 @@
 
 from urllib.parse import urlparse
 
-from ..utils import store
+from ..utils import globals
 from ..utils.mixins.json_converter import JsonMixin
 from .general.field import Field
 from .general.text_group import TextGroup
@@ -39,7 +39,7 @@ class URLField(Field, TextGroup, JsonMixin):
         readonly: bool = False,
         unique: bool = False,
     ):
-        if store.DEBUG:
+        if globals.DEBUG:
             if default is not None:
                 if not isinstance(default, str):
                     raise AssertionError("Parameter `default` - Not а `str` type!")

ramifice/models/decorator.py

@@ -4,13 +4,13 @@ import os
 from typing import Any
 
 from ..commons import QCommonsMixin
-from ..fields import DateTimeField, IDField  # type: ignore[attr-defined]
-from ..paladins import CheckMixin, QPaladinsMixin, ValidationMixin  # type: ignore[attr-defined]
+from ..fields import DateTimeField, IDField
+from ..paladins import CheckMixin, QPaladinsMixin, ValidationMixin
 from ..utils.errors import DoesNotMatchRegexError, PanicError
 from ..utils.mixins.add_valid import AddValidMixin
 from ..utils.mixins.hooks import HooksMixin
 from ..utils.mixins.indexing import IndexMixin
-from ..utils.store import REGEX
+from ..utils.globals import REGEX
 from .model import Model
 from .pseudo import PseudoModel
 

ramifice/models/model.py

@@ -8,7 +8,7 @@ from babel.dates import format_date, format_datetime
 from bson.objectid import ObjectId
 from dateutil.parser import parse
 
-from ..fields import DateTimeField, IDField  # type: ignore[attr-defined]
+from ..fields import DateTimeField, IDField
 from ..utils import translations
 
 

ramifice/paladins/check.py

@@ -7,9 +7,9 @@ from typing import Any
 from bson.objectid import ObjectId
 from pymongo.asynchronous.collection import AsyncCollection
 
-from ..utils import store
+from ..utils import globals
 from ..utils.errors import PanicError
-from .groups import (  # type: ignore[attr-defined]
+from .groups import (
     BoolGroupMixin,
     ChoiceGroupMixin,
     DateGroupMixin,
@@ -45,11 +45,11 @@ 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"]  # type: ignore[attr-defined]
+        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()}` > "  # type: ignore[attr-defined]
+                f"Model: `{self.full_model_name()}` > "
                 + "Method: `check` => "
                 + "For a non -migrating Model, the `is_save` parameter must be equal to` False` !"
             )
@@ -59,20 +59,20 @@ class CheckMixin(
         is_update: bool = False
         if is_migrate_model:
             # Get the document ID.
-            doc_id = self._id.value  # type: ignore[attr-defined]
+            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  # type: ignore[attr-defined]
+                self._id.value = doc_id
 
         result_map: dict[str, Any] = {}
         # Errors from additional validation of fields.
-        error_map: dict[str, str] = await self.add_validation() or {}  # type: ignore[attr-defined]
+        error_map: dict[str, str] = await self.add_validation() or {}
         # Get Model collection.
         if collection is None:
-            collection = store.MONGO_DATABASE[cls_model.META["collection_name"]]  # type: ignore[index, attr-defined]
+            collection = globals.MONGO_DATABASE[cls_model.META["collection_name"]]
         # Create params for *_group methods.
         params: dict[str, Any] = {
             "doc_id": doc_id,
@@ -82,7 +82,7 @@ class CheckMixin(
             "result_map": result_map,  # Data to save or update to the database.
             "collection": collection,
             "field_data": None,
-            "full_model_name": cls_model.META["full_model_name"],  # type: ignore[attr-defined]
+            "full_model_name": cls_model.META["full_model_name"],
             "is_migrate_model": is_migrate_model,
         }
 
@@ -126,7 +126,7 @@ class CheckMixin(
             if params["is_error_symptom"]:
                 # Reset the ObjectId for a new document.
                 if not is_update:
-                    self._id.value = None  # type: ignore[attr-defined]
+                    self._id.value = None
                 # Delete orphaned files.
                 curr_doc: dict[str, Any] | None = (
                     await collection.find_one({"_id": doc_id}) if is_update else None

ramifice/paladins/delete.py

@@ -6,7 +6,7 @@ from typing import Any
 
 from pymongo.asynchronous.collection import AsyncCollection
 
-from ..utils import store
+from ..utils import globals
 from ..utils.errors import PanicError
 
 
@@ -27,26 +27,26 @@ class DeleteMixin:
         """Delete document from database."""
         cls_model = self.__class__
         # Raises a panic if the Model cannot be removed.
-        if not cls_model.META["is_delete_doc"]:  # type: ignore[attr-defined]
+        if not cls_model.META["is_delete_doc"]:
             msg = (
-                f"Model: `{cls_model.META['full_model_name']}` > "  # type: ignore[attr-defined]
+                f"Model: `{cls_model.META['full_model_name']}` > "
                 + "META param: `is_delete_doc` (False) => "
                 + "Documents of this Model cannot be removed from the database!"
             )
             raise PanicError(msg)
         # Get documet ID.
-        doc_id = self._id.value  # type: ignore[attr-defined]
+        doc_id = self._id.value
         if doc_id is None:
             msg = (
-                f"Model: `{cls_model.META['full_model_name']}` > "  # type: ignore[attr-defined]
+                f"Model: `{cls_model.META['full_model_name']}` > "
                 + "Field: `_id` > "
                 + "Param: `value` => ID is missing."
             )
             raise PanicError(msg)
         # Run hook.
-        await self.pre_delete()  # type: ignore[attr-defined]
+        await self.pre_delete()
         # Get collection for current Model.
-        collection: AsyncCollection = store.MONGO_DATABASE[cls_model.META["collection_name"]]  # type: ignore[index, attr-defined]
+        collection: AsyncCollection = globals.MONGO_DATABASE[cls_model.META["collection_name"]]
         # Delete document.
         mongo_doc: dict[str, Any] = {}
         mongo_doc = await collection.find_one_and_delete(
@@ -62,7 +62,7 @@ class DeleteMixin:
         # If the document failed to delete.
         if not bool(mongo_doc):
             msg = (
-                f"Model: `{cls_model.META['full_model_name']}` > "  # type: ignore[attr-defined]
+                f"Model: `{cls_model.META['full_model_name']}` > "
                 + "Method: `delete` => "
                 + "The document was not deleted, the document is absent in the database."
             )
@@ -86,6 +86,6 @@ class DeleteMixin:
                     file_data = None
             field_data.value = None
         # Run hook.
-        await self.post_delete()  # type: ignore[attr-defined]
+        await self.post_delete()
         #
         return mongo_doc

ramifice/paladins/groups/text_group.py

@@ -53,7 +53,7 @@ class TextGroupMixin:
             try:
                 emailinfo = validate_email(
                     str(value),
-                    check_deliverability=self.__class__.META["is_migrate_model"],  # type: ignore[attr-defined]
+                    check_deliverability=self.__class__.META["is_migrate_model"],
                 )
                 value = emailinfo.normalized
                 params["field_data"].value = value

ramifice/paladins/password.py

@@ -5,7 +5,7 @@ from typing import Any
 from argon2 import PasswordHasher
 from pymongo.asynchronous.collection import AsyncCollection
 
-from ..utils import store
+from ..utils import globals
 from ..utils.errors import OldPassNotMatchError, PanicError
 
 
@@ -20,30 +20,30 @@ class PasswordMixin:
         """For password verification."""
         cls_model = self.__class__
         # Get documet ID.
-        doc_id = self._id.value  # type: ignore[attr-defined]
+        doc_id = self._id.value
         if doc_id is None:
             msg = (
-                f"Model: `{cls_model.META['full_model_name']}` > "  # type: ignore[attr-defined]
+                f"Model: `{cls_model.META['full_model_name']}` > "
                 + "Method: `verify_password` => "
                 + "Cannot get document ID - ID field is empty."
             )
             raise PanicError(msg)
         # Get collection for current Model.
-        collection: AsyncCollection = store.MONGO_DATABASE[cls_model.META["collection_name"]]  # type: ignore[index, attr-defined]
+        collection: AsyncCollection = globals.MONGO_DATABASE[cls_model.META["collection_name"]]
         # Get document.
         mongo_doc: dict[str, Any] | None = await collection.find_one({"_id": doc_id})
         if mongo_doc is None:
             msg = (
-                f"Model: `{cls_model.META['full_model_name']}` > "  # type: ignore[attr-defined]
+                f"Model: `{cls_model.META['full_model_name']}` > "
                 + "Method: `verify_password` => "
-                + f"There is no document with ID `{self._id.value}` in the database."  # type: ignore[attr-defined]
+                + f"There is no document with ID `{self._id.value}` in the database."
             )
             raise PanicError(msg)
         # Get password hash.
         hash: str | None = mongo_doc.get(field_name)
         if hash is None:
             msg = (
-                f"Model: `{cls_model.META['full_model_name']}` > "  # type: ignore[attr-defined]
+                f"Model: `{cls_model.META['full_model_name']}` > "
                 + "Method: `verify_password` => "
                 + f"The model does not have a field `{field_name}`."
             )
@@ -73,9 +73,9 @@ class PasswordMixin:
         if not await self.verify_password(old_password, field_name):
             raise OldPassNotMatchError()
         # Get documet ID.
-        doc_id = self._id.value  # type: ignore[attr-defined]
+        doc_id = self._id.value
         # Get collection for current Model.
-        collection: AsyncCollection = store.MONGO_DATABASE[cls_model.META["collection_name"]]  # type: ignore[index, attr-defined]
+        collection: AsyncCollection = globals.MONGO_DATABASE[cls_model.META["collection_name"]]
         # Create hash of new passwor.
         ph = PasswordHasher()
         hash: str = ph.hash(new_password)

ramifice/paladins/refrash.py

@@ -4,7 +4,7 @@ from typing import Any
 
 from pymongo.asynchronous.collection import AsyncCollection
 
-from ..utils import store
+from ..utils import globals
 from ..utils.errors import PanicError
 from .tools import refresh_from_mongo_doc
 
@@ -16,14 +16,14 @@ class RefrashMixin:
         """Update Model instance from database."""
         cls_model = self.__class__
         # Get collection.
-        collection: AsyncCollection = store.MONGO_DATABASE[cls_model.META["collection_name"]]  # type: ignore[index, attr-defined]
-        mongo_doc: dict[str, Any] | None = await collection.find_one(filter={"_id": self._id.value})  # type: ignore[attr-defined]
+        collection: AsyncCollection = globals.MONGO_DATABASE[cls_model.META["collection_name"]]
+        mongo_doc: dict[str, Any] | None = await collection.find_one(filter={"_id": self._id.value})
         if mongo_doc is None:
             msg = (
-                f"Model: `{self.full_model_name()}` > "  # type: ignore[attr-defined]
+                f"Model: `{self.full_model_name()}` > "
                 + "Method: `refrash_from_db` => "
-                + f"A document with an identifier `{self._id.value}` is not exists in the database!"  # type: ignore[attr-defined]
+                + f"A document with an identifier `{self._id.value}` is not exists in the database!"
             )
             raise PanicError(msg)
-        self.inject()  # type: ignore[attr-defined]
+        self.inject()
         refresh_from_mongo_doc(self, mongo_doc)

ramifice/paladins/save.py

@@ -5,7 +5,7 @@ from typing import Any
 
 from pymongo.asynchronous.collection import AsyncCollection
 
-from ..utils import store
+from ..utils import globals
 from ..utils.errors import PanicError
 from .tools import ignored_fields_to_none, refresh_from_mongo_doc
 
@@ -20,17 +20,17 @@ class SaveMixin:
         """
         cls_model = self.__class__
         # Get collection.
-        collection: AsyncCollection = store.MONGO_DATABASE[cls_model.META["collection_name"]]  # type: ignore[index, attr-defined]
+        collection: AsyncCollection = globals.MONGO_DATABASE[cls_model.META["collection_name"]]
         # Check Model.
-        result_check: dict[str, Any] = await self.check(is_save=True, collection=collection)  # type: ignore[attr-defined]
+        result_check: dict[str, Any] = await self.check(is_save=True, collection=collection)
         # Reset the alerts to exclude duplicates.
-        self._id.alerts = []  # type: ignore[attr-defined]
+        self._id.alerts = []
         # Check the conditions and, if necessary, define a message for the web form.
-        if not result_check["is_update"] and not cls_model.META["is_create_doc"]:  # type: ignore[attr-defined]
-            self._id.alerts.append("It is forbidden to create new documents !")  # type: ignore[attr-defined]
+        if not result_check["is_update"] and not cls_model.META["is_create_doc"]:
+            self._id.alerts.append("It is forbidden to create new documents !")
             result_check["is_valid"] = False
-        if result_check["is_update"] and not cls_model.META["is_update_doc"]:  # type: ignore[attr-defined]
-            self._id.alerts.append("It is forbidden to update documents !")  # type: ignore[attr-defined]
+        if result_check["is_update"] and not cls_model.META["is_update_doc"]:
+            self._id.alerts.append("It is forbidden to update documents !")
             result_check["is_valid"] = False
         # Leave the method if the check fails.
         if not result_check["is_valid"]:
@@ -43,18 +43,18 @@ class SaveMixin:
             # Update date and time.
             checked_data["updated_at"] = datetime.now()
             # Run hook.
-            await self.pre_update()  # type: ignore[attr-defined]
+            await self.pre_update()
             # Update doc.
             await collection.update_one({"_id": checked_data["_id"]}, {"$set": checked_data})
             # Run hook.
-            await self.post_update()  # type: ignore[attr-defined]
+            await self.post_update()
             # Refresh Model.
             mongo_doc: dict[str, Any] | None = await collection.find_one(
                 {"_id": checked_data["_id"]}
             )
             if mongo_doc is None:
                 msg = (
-                    f"Model: `{self.full_model_name()}` > "  # type: ignore[attr-defined]
+                    f"Model: `{self.full_model_name()}` > "
                     + "Method: `save` => "
                     + "Geted value is None - it is impossible to refresh the current Model."
                 )
@@ -66,16 +66,16 @@ class SaveMixin:
             checked_data["created_at"] = today
             checked_data["updated_at"] = today
             # Run hook.
-            await self.pre_create()  # type: ignore[attr-defined]
+            await self.pre_create()
             # Insert doc.
             await collection.insert_one(checked_data)
             # Run hook.
-            await self.post_create()  # type: ignore[attr-defined]
+            await self.post_create()
             # Refresh Model.
             mongo_doc = await collection.find_one({"_id": checked_data["_id"]})
             if mongo_doc is None:
                 msg = (
-                    f"Model: `{self.full_model_name()}` > "  # type: ignore[attr-defined]
+                    f"Model: `{self.full_model_name()}` > "
                     + "Method: `save` => "
                     + "Geted value is None - it is impossible to refresh the current Model."
                 )
@@ -84,7 +84,7 @@ class SaveMixin:
                 refresh_from_mongo_doc(self, mongo_doc)
             else:
                 msg = (
-                    f"Model: `{self.full_model_name()}` > "  # type: ignore[attr-defined]
+                    f"Model: `{self.full_model_name()}` > "
                     + "Method: `save` => "
                     + "The document was not created."
                 )

ramifice/paladins/validation.py

@@ -14,7 +14,7 @@ class ValidationMixin:
         The main use is to check data from web forms.
         It is also used to verify Models that do not migrate to the database.
         """
-        result_check: dict[str, Any] = await self.check()  # type: ignore[attr-defined]
+        result_check: dict[str, Any] = await self.check()
         return result_check["is_valid"]
 
     def print_err(self) -> None:
@@ -31,17 +31,17 @@ class ValidationMixin:
                 if not is_err:
                     print(colored("\nERRORS:", "red", attrs=["bold"]))
                     print(colored("Model: ", "blue", attrs=["bold"]), end="")
-                    print(colored(f"`{self.full_model_name()}`", "blue"))  # type: ignore[attr-defined]
+                    print(colored(f"`{self.full_model_name()}`", "blue"))
                     is_err = True
                 # field name
                 print(colored("Field: ", "green", attrs=["bold"]), end="")
                 print(colored(f"`{field_name}`:", "green"))
                 # error messages
                 print(colored("\n".join(field_data.errors), "red"))
-        if len(self._id.alerts) > 0:  # type: ignore[attr-defined]
+        if len(self._id.alerts) > 0:
             # title
             print(colored("AlERTS:", "yellow", attrs=["bold"]))
             # messages
-            print(colored("\n".join(self._id.alerts), "yellow"), end="\n\n")  # type: ignore[attr-defined]
+            print(colored("\n".join(self._id.alerts), "yellow"), end="\n\n")
         else:
             print(end="\n\n")

ramifice/utils/{store.py → globals.py}

@@ -1,8 +1,6 @@
-"""Global storage for caching auxiliary variables.
+"""Global variables.
 
-The purpose of caching is production optimization.
-
-The module contains the following elements:
+List of variables:
 
 - `DEBUG` - Caching a condition for the verification code.
 - `MONGO_CLIENT` - Caching a Mongo client.