ramifice 0.8.2__py3-none-any.whl → 0.8.4__py3-none-any.whl

ramifice/fields/file_field.py

@@ -1,17 +1,19 @@
 """Field of Model for upload file."""
 
-import os
 import uuid
 from base64 import b64decode
 from datetime import date
+from os.path import basename
 from pathlib import Path
 
-import aiofiles
+from aiofiles import open as async_open
+from aiofiles import os as async_os
 from aioshutil import copyfile
 
 from ramifice.fields.general.field import Field
 from ramifice.fields.general.file_group import FileGroup
 from ramifice.utils import constants
+from ramifice.utils.constants import MEDIA_ROOT, MEDIA_URL
 from ramifice.utils.errors import FileHasNoExtensionError
 from ramifice.utils.mixins.json_converter import JsonMixin
 
@@ -124,25 +126,25 @@ class FileField(Field, FileGroup, JsonMixin):
             # Create the current date for the directory name.
             date_str: str = str(date.today())
             # Create path to target directory.
-            dir_target_path = f"{self.media_root}/{self.target_dir}/{date_str}"
+            dir_target_path = f"{MEDIA_ROOT}/uploads/{self.target_dir}/{date_str}"
             # Create target directory if it does not exist.
-            if not await aiofiles.os.path.exists(dir_target_path):
-                await aiofiles.os.makedirs(dir_target_path)
+            if not await async_os.path.exists(dir_target_path):
+                await async_os.makedirs(dir_target_path)
             # Create path to target file.
             f_target_path = f"{dir_target_path}/{f_uuid_name}"
             # Save file in target directory.
-            async with aiofiles.open(f_target_path, mode="wb") as open_f:
+            async with async_open(f_target_path, mode="wb") as open_f:
                 f_content = b64decode(base64_str)
                 await open_f.write(f_content)
             # Add paths to target file.
             file_info["path"] = f_target_path
-            file_info["url"] = f"{self.media_url}/{self.target_dir}/{date_str}/{f_uuid_name}"
+            file_info["url"] = f"{MEDIA_URL}/uploads/{self.target_dir}/{date_str}/{f_uuid_name}"
             # Add original file name.
             file_info["name"] = filename
             # Add file extension.
             file_info["extension"] = extension
             # Add file size (in bytes).
-            file_info["size"] = await aiofiles.os.path.getsize(f_target_path)
+            file_info["size"] = await async_os.path.getsize(f_target_path)
         #
         # to value.
         self.value = file_info
@@ -169,23 +171,23 @@ class FileField(Field, FileGroup, JsonMixin):
             # Create the current date for the directory name.
             date_str: str = str(date.today())
             # Create path to target directory.
-            dir_target_path = f"{self.media_root}/{self.target_dir}/{date_str}"
+            dir_target_path = f"{MEDIA_ROOT}/uploads/{self.target_dir}/{date_str}"
             # Create target directory if it does not exist.
-            if not await aiofiles.os.path.exists(dir_target_path):
-                await aiofiles.os.makedirs(dir_target_path)
+            if not await async_os.path.exists(dir_target_path):
+                await async_os.makedirs(dir_target_path)
             # Create path to target file.
             f_target_path = f"{dir_target_path}/{f_uuid_name}"
             # Save file in target directory.
             await copyfile(src_path, f_target_path)
             # Add paths to target file.
             file_info["path"] = f_target_path
-            file_info["url"] = f"{self.media_url}/{self.target_dir}/{date_str}/{f_uuid_name}"
+            file_info["url"] = f"{MEDIA_URL}/uploads/{self.target_dir}/{date_str}/{f_uuid_name}"
             # Add original file name.
-            file_info["name"] = os.path.basename(src_path)
+            file_info["name"] = basename(src_path)
             # Add file extension.
             file_info["extension"] = extension
             # Add file size (in bytes).
-            file_info["size"] = await aiofiles.os.path.getsize(f_target_path)
+            file_info["size"] = await async_os.path.getsize(f_target_path)
         #
         # to value.
         self.value = file_info

ramifice/fields/general/file_group.py

@@ -31,5 +31,3 @@ class FileGroup(metaclass=ABCMeta):
         self.default = default
         self.target_dir = target_dir
         self.accept = accept
-        self.media_root: str = "public/media/uploads"
-        self.media_url: str = "/media/uploads"

ramifice/fields/image_field.py

@@ -1,17 +1,19 @@
 """Field of Model for upload image."""
 
-import os
 import uuid
 from base64 import b64decode
 from datetime import date
+from os.path import basename
 from pathlib import Path
 
-import aiofiles
+from aiofiles import open as async_open
+from aiofiles import os as async_os
 from aioshutil import copyfile
 
 from ramifice.fields.general.field import Field
 from ramifice.fields.general.file_group import FileGroup
 from ramifice.utils import constants
+from ramifice.utils.constants import MEDIA_ROOT, MEDIA_URL
 from ramifice.utils.errors import FileHasNoExtensionError
 from ramifice.utils.mixins.json_converter import JsonMixin
 
@@ -155,18 +157,18 @@ class ImageField(Field, FileGroup, JsonMixin):
             # Directory name for the original image and its thumbnails.
             general_dir = uuid.uuid4()
             # Create path to target directory with images.
-            imgs_dir_path = f"{self.media_root}/{self.target_dir}/{date_str}/{general_dir}"
+            imgs_dir_path = f"{MEDIA_ROOT}/uploads/{self.target_dir}/{date_str}/{general_dir}"
             # Create url path to target directory with images.
-            imgs_dir_url = f"{self.media_url}/{self.target_dir}/{date_str}/{general_dir}"
+            imgs_dir_url = f"{MEDIA_URL}/uploads/{self.target_dir}/{date_str}/{general_dir}"
             # Create a new name for the original image.
             new_original_name = f"original{extension}"
             # 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 await aiofiles.os.path.exists(imgs_dir_path):
-                await aiofiles.os.makedirs(imgs_dir_path)
+            if not await async_os.path.exists(imgs_dir_path):
+                await async_os.makedirs(imgs_dir_path)
             # Save main image in target directory.
-            async with aiofiles.open(main_img_path, mode="wb") as open_f:
+            async with async_open(main_img_path, mode="wb") as open_f:
                 f_content = b64decode(base64_str)
                 await open_f.write(f_content)
             # Add paths for main image.
@@ -186,7 +188,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"] = await aiofiles.os.path.getsize(main_img_path)
+            img_info["size"] = await async_os.path.getsize(main_img_path)
         #
         # to value.
         self.value = img_info
@@ -213,23 +215,23 @@ class ImageField(Field, FileGroup, JsonMixin):
             # Directory name for the original image and its thumbnails.
             general_dir = uuid.uuid4()
             # Create path to target directory with images.
-            imgs_dir_path = f"{self.media_root}/{self.target_dir}/{date_str}/{general_dir}"
+            imgs_dir_path = f"{MEDIA_ROOT}/uploads/{self.target_dir}/{date_str}/{general_dir}"
             # Create url path to target directory with images.
-            imgs_dir_url = f"{self.media_url}/{self.target_dir}/{date_str}/{general_dir}"
+            imgs_dir_url = f"{MEDIA_URL}/uploads/{self.target_dir}/{date_str}/{general_dir}"
             # Create a new name for the original image.
             new_original_name = f"original{extension}"
             # 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 await aiofiles.os.path.exists(imgs_dir_path):
-                await aiofiles.os.makedirs(imgs_dir_path)
+            if not await async_os.path.exists(imgs_dir_path):
+                await async_os.makedirs(imgs_dir_path)
             # Save main image in target directory.
             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 original image name.
-            img_info["name"] = os.path.basename(src_path)
+            img_info["name"] = basename(src_path)
             # Add image extension.
             img_info["extension"] = extension
             # Transform extension to the upper register and delete the point.
@@ -242,7 +244,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"] = await aiofiles.os.path.getsize(main_img_path)
+            img_info["size"] = await async_os.path.getsize(main_img_path)
         #
         # to value.
         self.value = img_info

ramifice/models/decorator.py

@@ -42,6 +42,7 @@ def model(
             raise DoesNotMatchRegexError("^[A-Z][a-zA-Z0-9]{0,24}$")
         if fixture_name is not None:
             fixture_path = f"config/fixtures/{fixture_name}.yml"
+
             if not os.path.exists(fixture_path):
                 msg = (
                     f"Model: `{cls.__module__}.{cls.__name__}` > "

ramifice/paladins/check.py

@@ -2,7 +2,7 @@
 
 from typing import Any
 
-from aiofiles import os
+from aiofiles import os as async_os
 from aioshutil import rmtree
 from bson.objectid import ObjectId
 from pymongo.asynchronous.collection import AsyncCollection
@@ -133,7 +133,7 @@ class CheckMixin(
                         file_data = result_map.get(field_name)
                         if file_data is not None:
                             if file_data["is_new_file"]:
-                                await os.remove(file_data["path"])
+                                await async_os.remove(file_data["path"])
                             field_data.value = None
                         if curr_doc is not None:
                             field_data.value = curr_doc[field_name]

ramifice/paladins/delete.py

@@ -2,7 +2,7 @@
 
 from typing import Any
 
-from aiofiles import os
+from aiofiles import os as async_os
 from aioshutil import rmtree
 from pymongo.asynchronous.collection import AsyncCollection
 
@@ -77,7 +77,7 @@ class DeleteMixin:
                 if group == "file":
                     file_data = mongo_doc[field_name]
                     if file_data is not None and len(file_data["path"]) > 0:
-                        await os.remove(file_data["path"])
+                        await async_os.remove(file_data["path"])
                     file_data = None
                 elif group == "img":
                     file_data = mongo_doc[field_name]

ramifice/utils/constants.py

@@ -7,9 +7,11 @@ List of variables:
 - `MONGO_DATABASE` - Caching a Mongo database.
 - `DATABASE_NAME` - Caching a database name.
 - `SUPER_COLLECTION_NAME` - Caching a super collection name.
+- `MEDIA_ROOT` - Absolute filesystem path to the directory that will hold user-uploaded files.
+- `MEDIA_URL` - URL that handles the media served from MEDIA_ROOT, used for managing stored files.
+- `STATIC_ROOT` - The absolute path to the directory where static files are located.
+- `STATIC_URL` - URL to use when referring to static files located in STATIC_ROOT.
 - `REGEX` - Caching a patterns of regular expression.
-- `FILE_INFO_DICT` - Caching a dictionary to transmit information about the file.
-- `IMG_INFO_DICT` - Caching a dictionary to transmit information about the image.
 """
 
 import re
@@ -30,6 +32,18 @@ DATABASE_NAME: str | None = None
 # Store technical data for Models migration into a database.
 # Store dynamic field data for simulate relationship Many-to-One and Many-to-Manyю.
 SUPER_COLLECTION_NAME: str = "SUPER_COLLECTION"
+# Absolute filesystem path to the
+# directory that will hold user-uploaded files.
+MEDIA_ROOT: str = "public/media"
+# URL that handles the media served from MEDIA_ROOT,
+# used for managing stored files.
+MEDIA_URL: str = "/media"
+# The absolute path to the
+# directory where static files are located.
+STATIC_ROOT: str = "public/static"
+# URL to use when referring to
+# static files located in STATIC_ROOT.
+STATIC_URL: str = "/static"
 # Caching a patterns of regular expression.
 REGEX: dict[str, re.Pattern] = {
     "database_name": re.compile(r"^[a-zA-Z][-_a-zA-Z0-9]{0,59}$"),

ramifice/utils/tools.py

@@ -3,11 +3,11 @@
 import asyncio
 import ipaddress
 import math
-import os
 from typing import Any
 from urllib.parse import urlparse
 
 import phonenumbers
+from aiofiles import ospath
 from bson.objectid import ObjectId
 from email_validator import EmailNotValidError, validate_email
 
@@ -29,9 +29,9 @@ def to_human_size(size: int) -> str:
     return f"{size} {order}"
 
 
-def get_file_size(path: str) -> int:
+async def get_file_size(path: str) -> int:
     """Get file size in bytes."""
-    size: int = os.path.getsize(path)
+    size: int = await ospath.getsize(path)
     return size
 
 

ramifice/utils/translations.py

@@ -30,11 +30,11 @@ from typing import Any
 
 from ramifice.utils.errors import PanicError
 
-# Language code by default.
+# Language by default.
 DEFAULT_LOCALE: str = "en"
 # Code of current language.
 CURRENT_LOCALE: str = copy.deepcopy(DEFAULT_LOCALE)
-# List of codes supported by languages.
+# List of supported languages.
 LANGUAGES: frozenset[str] = frozenset(("en", "ru"))
 
 if not DEFAULT_LOCALE in LANGUAGES:

{ramifice-0.8.2.dist-info → ramifice-0.8.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ramifice
-Version: 0.8.2
+Version: 0.8.4
 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.8.2.dist-info → ramifice-0.8.4.dist-info}/RECORD

@@ -25,10 +25,10 @@ ramifice/fields/color_field.py,sha256=K-lYp8f08HTZt6WU0kY3CQWaAmx6I3-uyKHBq7xAeS
 ramifice/fields/date_field.py,sha256=-M_dD8tVUXcDCQD5Hy5Ns9Z2QGlRya0qbvoWgA4qpmg,5277
 ramifice/fields/date_time_field.py,sha256=ahjX-cD5Qj-V7JUi5QAZ8qgv9UePhYYYzJghiasKdqE,5312
 ramifice/fields/email_field.py,sha256=4Kxy1K6CXJUJ8Db0CQuopjodiY4ybe7V0GT756t7Nks,3481
-ramifice/fields/file_field.py,sha256=icckL_LGfPlotHO7j32lMre9J0O0k-WVjMQg5QdQav4,8130
+ramifice/fields/file_field.py,sha256=CSCHSExyXUsvLGGCj3WmBHM0YUUcK9QZZb3kB8r8HQs,8253
 ramifice/fields/float_field.py,sha256=JeVwoIi6j-dovXarZ3NgmSQI7f3qZzydlRs_yqp3Faw,4637
 ramifice/fields/id_field.py,sha256=YO5oIwXtqgURjjd2oYe2ouXxdpaiJp5ZhUgUA2pkNeo,4183
-ramifice/fields/image_field.py,sha256=qoUAkZW2b-EkU5IDvlbxEOFwWpLYFXs9ZFnxL55an6M,11549
+ramifice/fields/image_field.py,sha256=ZBbraEI0P5qWK1_xDnZ42YXhqgK4LdcL28vg9zgPBiw,11672
 ramifice/fields/integer_field.py,sha256=xPwpdhYNz4MyHgOypqa29oGNdKZic05yyUYHg5CDD3E,4609
 ramifice/fields/ip_field.py,sha256=tBFGFMC_zwAyLGtVRNNfiu4vQoxXPcgVHhX_aoHrvns,3390
 ramifice/fields/password_field.py,sha256=USD4Y8MTI89QZVT6zqLGBmb5kqOKrXqh73-z99cOvtk,3266
@@ -40,15 +40,15 @@ ramifice/fields/general/__init__.py,sha256=JzgIDseNQLB_IDwY9-JSiT_bONxvhJmbKl5Ph
 ramifice/fields/general/choice_group.py,sha256=aNO8LnsafGOOQ7d2lAppI9YtzVHbWUZ6t1znEEIbAv8,962
 ramifice/fields/general/date_group.py,sha256=C5VgR0CBEGgG7nIYEeI82hVXttngSJAGFvEdXC_OpGY,1213
 ramifice/fields/general/field.py,sha256=qm7N-U5H1V6BK_6quJeGGpTmb9IqA-vxZlNHwoABye0,1384
-ramifice/fields/general/file_group.py,sha256=T-IwFnlJAWaRcQKVn09IJCdFNGgnUfMkjLzWFFqn7gY,1117
+ramifice/fields/general/file_group.py,sha256=pC9bGUpDeu7FLJVD6NMCzq18aPETotipknSly2GH7Q0,1014
 ramifice/fields/general/number_group.py,sha256=LOPHbKAnIuqW4DEh2fH78w6qOQjp0OhkuP7MoikhlkA,761
 ramifice/fields/general/text_group.py,sha256=m9EnlYGwqlck-JIYOCUd0hUYAVr8jH4YCnTmm9QlCkQ,1103
 ramifice/models/__init__.py,sha256=h_QQ5rSJNZ-7kmx7wIFd8E8RmUS94b_x4jdwMbq8zm4,15
-ramifice/models/decorator.py,sha256=fL9xc7-_BEiFEqfwgql6CihYWB6MC-JgiC0FSSK_JHA,5956
+ramifice/models/decorator.py,sha256=dzwC489KBjamQxrWNy8lrdXVLb3e8OKPWbPGJZqxaFA,5958
 ramifice/models/model.py,sha256=e5UWHKIHwm7saxQ4bbamsTkz1VVBIqTRlAmJCOg5uRE,7160
 ramifice/paladins/__init__.py,sha256=EJ6EEKXUcMG5P1bDmlEa4W3fsxSz5u6mzDG_oU1efMQ,618
-ramifice/paladins/check.py,sha256=9lLJ6SnNQBI9eyAwWSqjFa7_F2A2QbTg4WHyrPL3E20,6584
-ramifice/paladins/delete.py,sha256=90ZiTzYxa2bnhOJhkEBe7XR_Yi4gaTvrJ3u4dSik0mU,3430
+ramifice/paladins/check.py,sha256=c-7jbFV5qzE9nF8Cl6VSPA8DtziADOuV6j1rldnZBKI,6602
+ramifice/paladins/delete.py,sha256=teUyj-sosObatoaFpMC3wodC4GvWbzgJCCxsI_Z9vyk,3448
 ramifice/paladins/password.py,sha256=G-tMz2dIiOYEhOeSHYgAmc2e4tG_TJ2gt5tzPwBapkw,3047
 ramifice/paladins/refrash.py,sha256=hIZQEBGtoIhuGGg2KQYGApCaMb8WhK_QZlzi1_-zzU0,1100
 ramifice/paladins/save.py,sha256=mFau65uWYy4dSVyTVdZGR3VUnP-I_NPdMvq7F5n1sFo,3899
@@ -66,19 +66,19 @@ ramifice/paladins/groups/pass_group.py,sha256=uuIIqMBXsYG7vTHc_AhdgWuNCivxTgQMjk
 ramifice/paladins/groups/slug_group.py,sha256=ztiA2v7e5lQYRZtlLw8WGOhSWaYQfOdZ6wkKbx3ZbTM,2329
 ramifice/paladins/groups/text_group.py,sha256=cdwUZoomw61A7CmDIbds_oOaia2tD-J5LLuj5b8E8O4,4472
 ramifice/utils/__init__.py,sha256=xixHoOX4ja5jIUZemem1qn4k4aonv3G3Q76azQK_pkU,43
-ramifice/utils/constants.py,sha256=uR20um3Qg_1SG1t7WyWbpq8kQD-9Mslyr_c1yh5Hw9w,1751
+ramifice/utils/constants.py,sha256=dTSk07FVc6hgXwG1IF0_klPnbfxlFHiaRmym5zWgzIM,2395
 ramifice/utils/errors.py,sha256=iuhq7fzpUmsOyeXeg2fJjta8yAuqlXLKsZVMpfUhtHE,1901
 ramifice/utils/fixtures.py,sha256=PMRl1Ud0Ek0eX5F7BPiL7az_H7YKtIVKB8MJ17CeBdw,3179
 ramifice/utils/migration.py,sha256=5VYYB7DFMzLCRYWdlwtqGRSUPFdXp5SMxuMWraofVCw,11106
-ramifice/utils/tools.py,sha256=dJjG92nevSq_US30pUdbBy37pvqBdxXHBeHZxpOInKM,2843
-ramifice/utils/translations.py,sha256=aEkNKilD7RlJjBixqhh0cfIMw9lg13woaIwd3dyR8G4,4247
+ramifice/utils/tools.py,sha256=DSSR__sHgfDlYF4vhtR8vmeFtgquonkM5W_3V3SX6Y0,2872
+ramifice/utils/translations.py,sha256=Ibx6HqPcnsNxuBfXDs9mCLEA7xu4mkl3q39vqFaK-GI,4233
 ramifice/utils/unit.py,sha256=PPNKWYFJ8cz0nwbBPaTdL58_Nr7N0fIHFJBpKG2ZLKI,2482
 ramifice/utils/mixins/__init__.py,sha256=GrxJDsw73bEkitIh0-0BCxNnUK-N5uRXMCRlaPoaz1o,265
 ramifice/utils/mixins/add_valid.py,sha256=TLOObedzXNA9eCylfAVbVCqIKE5sV-P5AdIN7avj-GA,407
 ramifice/utils/mixins/hooks.py,sha256=33jvJRhfnJeL2Hd_YFXk3M_7wjqHaByU2wRjKyboL6s,914
 ramifice/utils/mixins/indexing.py,sha256=Z0427HoaVRyNmSNN8Fx0mSICgAKV-gDdu3iR5qYUEbs,329
 ramifice/utils/mixins/json_converter.py,sha256=2K_PZ34AzpesusgyyQFOLXFPcjXez3TWn-m9CHIKwRo,1131
-ramifice-0.8.2.dist-info/METADATA,sha256=GJe52VrqCxHD3lZ3UqDtg01-cRnwjC6UumDJxieVlR4,21016
-ramifice-0.8.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-ramifice-0.8.2.dist-info/licenses/LICENSE,sha256=LrEL0aTZx90HDwFUQCJutORiDjJL9AnuVvCtspXIqt4,1095
-ramifice-0.8.2.dist-info/RECORD,,
+ramifice-0.8.4.dist-info/METADATA,sha256=D7LCsTfcUITuLa2XzN_DS5sSgED6Scv9JfaXcu5b84k,21016
+ramifice-0.8.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ramifice-0.8.4.dist-info/licenses/LICENSE,sha256=LrEL0aTZx90HDwFUQCJutORiDjJL9AnuVvCtspXIqt4,1095
+ramifice-0.8.4.dist-info/RECORD,,