ramifice 0.3.23__py3-none-any.whl → 0.3.25__py3-none-any.whl

ramifice/fields/color_field.py

@@ -86,10 +86,3 @@ class ColorField(Field, TextGroup, JsonMixin):
         JsonMixin.__init__(self)
 
         self.default = default
-
-    def is_valid(self, value: str | None = None) -> bool:
-        """Validate Color code."""
-        color_code = str(value or self.value or self.default)
-        if store.REGEX["color_code"].match(color_code) is None:
-            return False
-        return True

ramifice/fields/email_field.py

@@ -82,12 +82,3 @@ class EmailField(Field, TextGroup, JsonMixin):
         JsonMixin.__init__(self)
 
         self.default = default
-
-    def is_valid(self, value: str | None = None) -> bool:
-        """Validate Email address."""
-        email = str(value or self.value or self.default)
-        try:
-            validate_email(email, check_deliverability=True)
-        except EmailNotValidError:
-            return False
-        return True

ramifice/fields/ip_field.py

@@ -82,12 +82,3 @@ class IPField(Field, TextGroup, JsonMixin):
         JsonMixin.__init__(self)
 
         self.default = default
-
-    def is_valid(self, value: str | None = None) -> bool:
-        """Validate IP address."""
-        address = str(value or self.value or self.default)
-        try:
-            ipaddress.ip_address(address)
-        except ValueError:
-            return False
-        return True

ramifice/fields/password_field.py

@@ -61,13 +61,6 @@ class PasswordField(Field):
         self.placeholder = placeholder
         self.required = required
 
-    def is_valid(self, value: str | None = None) -> bool:
-        """Validate Password."""
-        password = str(value or self.value)
-        if not store.REGEX["password"].match(password):
-            return False
-        return True
-
     def to_dict(self) -> dict[str, Any]:
         """Convert object instance to a dictionary."""
         json_dict: dict[str, Any] = {}

ramifice/fields/phone_field.py

@@ -87,14 +87,3 @@ class PhoneField(Field, TextGroup, JsonMixin):
         JsonMixin.__init__(self)
 
         self.default = default
-
-    def is_valid(self, value: str | None = None) -> bool:
-        """Validate Phone number."""
-        number = str(value or self.value or self.default)
-        try:
-            phone = phonenumbers.parse(number)
-            if not phonenumbers.is_valid_number(phone):
-                return False
-        except phonenumbers.phonenumberutil.NumberParseException:
-            return False
-        return True

ramifice/fields/url_field.py

@@ -95,11 +95,3 @@ class URLField(Field, TextGroup, JsonMixin):
         JsonMixin.__init__(self)
 
         self.default = default
-
-    def is_valid(self, value: str | None = None) -> bool:
-        """Validate URL address."""
-        url = str(value or self.value or self.default)
-        result = urlparse(url)
-        if not result.scheme or not result.netloc:
-            return False
-        return True

ramifice/paladins/groups/pass_group.py

@@ -8,6 +8,7 @@ from typing import Any
 from argon2 import PasswordHasher
 
 from ... import translations
+from ...utilities import is_password
 from ..tools import accumulate_error, panic_type_error
 
 
@@ -38,7 +39,7 @@ class PassGroupMixin:
                 params["result_map"][field.name] = None
             return
         # Validation Passwor.
-        if not field.is_valid(value):
+        if not is_password(value):
             err_msg = translations._("Invalid Password !")
             accumulate_error(err_msg, params)
             chars = "a-z A-Z 0-9 - . _ ! \" ` ' # % & , : ; < > = @ { } ~ $ ( ) * + / \\ ? [ ] ^ |"

ramifice/paladins/groups/text_group.py

@@ -10,6 +10,7 @@ from typing import Any
 from email_validator import EmailNotValidError, validate_email
 
 from ... import translations
+from ...utilities import is_color, is_ip, is_phone, is_url
 from ..tools import accumulate_error, check_uniqueness, panic_type_error
 
 
@@ -59,16 +60,16 @@ class TextGroupMixin:
             except EmailNotValidError:
                 err_msg = translations._("Invalid Email address !")
                 accumulate_error(err_msg, params)
-        elif "URL" in field_type and not field.is_valid(value):
+        elif "URL" in field_type and not is_url(value):
             err_msg = translations._("Invalid URL address !")
             accumulate_error(err_msg, params)
-        elif "IP" in field_type and not field.is_valid(value):
+        elif "IP" in field_type and not is_ip(value):
             err_msg = translations._("Invalid IP address !")
             accumulate_error(err_msg, params)
-        elif "Color" in field_type and not field.is_valid(value):
+        elif "Color" in field_type and not is_color(value):
             err_msg = translations._("Invalid Color code !")
             accumulate_error(err_msg, params)
-        elif "Phone" in field_type and not field.is_valid(value):
+        elif "Phone" in field_type and not is_phone(value):
             err_msg = translations._("Invalid Phone number !")
             accumulate_error(err_msg, params)
         # Insert result.

ramifice/utilities.py

@@ -13,6 +13,13 @@ from email_validator import EmailNotValidError, validate_email
 from .store import REGEX
 
 
+def is_password(password: str | None) -> bool:
+    """Validate Password."""
+    if not REGEX["password"].match(str(password)):
+        return False
+    return True
+
+
 def to_human_size(size: int) -> str:
     """Convert number of bytes to readable format."""
     idx = int(math.floor(math.log(size) / math.log(1024)))
@@ -21,13 +28,13 @@ def to_human_size(size: int) -> str:
     return f"{size} {order}"
 
 
-def get_file_size(path: str) -> str:
+def get_file_size(path: str) -> int:
     """Get human readable version of file size."""
-    size = os.path.getsize(path)
-    return to_human_size(size)
+    size: int = os.path.getsize(path)
+    return size
 
 
-def normal_email(email: str) -> str | None:
+def normal_email(email: str | None) -> str | None:
     """Normalizing email address."""
     normal: str | None = None
     try:
@@ -38,7 +45,7 @@ def normal_email(email: str) -> str | None:
     return normal
 
 
-def is_email(email: str) -> bool:
+def is_email(email: str | None) -> bool:
     """Validate Email address."""
     try:
         validate_email(str(email), check_deliverability=True)
@@ -47,7 +54,7 @@ def is_email(email: str) -> bool:
     return True
 
 
-def is_url(url: str) -> bool:
+def is_url(url: str | None) -> bool:
     """Validate URL address."""
     result = urlparse(str(url))
     if not result.scheme or not result.netloc:
@@ -55,7 +62,7 @@ def is_url(url: str) -> bool:
     return True
 
 
-def is_ip(address: str | int) -> bool:
+def is_ip(address: str | int | None) -> bool:
     """Validate IP address."""
     try:
         ipaddress.ip_address(str(address))
@@ -64,14 +71,14 @@ def is_ip(address: str | int) -> bool:
     return True
 
 
-def is_color(color_code: str) -> bool:
+def is_color(color_code: str | None) -> bool:
     """Validate Color code."""
     if REGEX["color_code"].match(str(color_code)) is None:
         return False
     return True
 
 
-def is_phone(number: str) -> bool:
+def is_phone(number: str | None) -> bool:
     """Validate Phone number."""
     try:
         phone = phonenumbers.parse(str(number))
@@ -87,6 +94,6 @@ def is_mongo_id(oid: Any) -> bool:
     return ObjectId.is_valid(oid)
 
 
-def hash_to_obj_id(hash: str) -> ObjectId | None:
+def hash_to_obj_id(hash: str | None) -> ObjectId | None:
     """Get ObjectId from hash string."""
     return ObjectId(hash) if bool(hash) else None

{ramifice-0.3.23.dist-info → ramifice-0.3.25.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ramifice
-Version: 0.3.23
+Version: 0.3.25
 Summary: ORM-like API MongoDB for Python language.
 Project-URL: Homepage, https://github.com/kebasyaty/ramifice
 Project-URL: Documentation, https://kebasyaty.github.io/ramifice/
@@ -144,7 +144,7 @@ class User:
     def fields(self):
         # For custom translations.
         gettext = translations.gettext
-        # ngettext = translations.ngettext
+        ngettext = translations.ngettext
         self.avatar = ImageField(
             label=gettext("Avatar"),
             default="public/media/default/no-photo.png",
@@ -231,7 +231,7 @@ if __name__ == "__main__":
     asyncio.run(main())
 ```
 
-### For create custom translations
+### How to create custom translations ?
 
 ```python
 from ramifice import translations
@@ -247,21 +247,40 @@ uv run pybabel extract -o config/translations/custom.pot src
 uv run pybabel init -i config/translations/custom.pot -d config/translations/custom -l en
 uv run pybabel init -i config/translations/custom.pot -d config/translations/custom -l ru
 ...
+
+# Hint: Do not forget to add translations for new languages.
 uv run pybabel compile -d config/translations/custom
+
 # Update your custom translations:
 uv run pybabel extract -o config/translations/custom.pot src
 uv run pybabel update -i config/translations/custom.pot -d config/translations/custom
+# Hint: Do not forget to check the translations for existing languages.
 uv run pybabel compile -d config/translations/custom
-#
-# Add new languages ​​to Ramifice:
+```
+
+### How to add new languages ​​to Ramifice ?
+
+```python
+from ramifice import translations
+
+translations.DEFAULT_LOCALE = "en"  # For Ramifice by default = "en"
+translations.LANGUAGES = ["en", "ru", "de", "de_ch"]  # For Ramifice by default = ["en", "ru"]
+```
+
+```shell
+cd project_name
 # Example:
 uv run pybabel init -i config/translations/ramifice.pot -d config/translations/ramifice -l de
 uv run pybabel init -i config/translations/ramifice.pot -d config/translations/ramifice -l de_ch
 ...
+
+# Hint: Do not forget to add translations for new languages.
 uv run pybabel compile -d config/translations/ramifice
+
 # Update translations to Ramifice:
 uv run pybabel extract -o config/translations/ramifice.pot ramifice
 uv run pybabel update -i config/translations/ramifice.pot -d config/translations/ramifice
+# Hint: Do not forget to check the translations for existing languages.
 uv run pybabel compile -d config/translations/ramifice
 ```
 
@@ -500,6 +519,55 @@ await user.update_password(  # uses verify_password
 )
 ```
 
+## General auxiliary methods
+
+```python
+from ramifice.utilities import (
+    get_file_size,
+    hash_to_obj_id,
+    is_color,
+    is_email,
+    is_ip,
+    is_mongo_id,
+    is_password,
+    is_phone,
+    is_url,
+    normal_email,
+    to_human_size,
+)
+
+if is_password("12345678"):
+    ...
+
+if is_email("kebasyaty@gmail.com"):
+    ...
+
+email = normal_email("kebasyaty@gmail.com")  # + validate_email
+
+if is_url("https://www.google.com"):
+    ...
+
+if is_ip("127.0.0.1"):
+    ...
+
+if is_color("#000"):
+    ...
+
+if is_phone("+447986123456"):
+    ...
+
+if is_mongo_id("666f6f2d6261722d71757578"):
+    ...
+
+from bson.objectid import ObjectId
+_id: ObjectId | None = hash_to_obj_id("666f6f2d6261722d71757578")
+
+size: str = to_human_size(2097152)  # => 2.0 MB
+
+path = "public/media/default/no_doc.odt"
+size: int = get_file_size(path)  # => 9843
+```
+
 ## Contributing
 
 1. Fork it (<https://github.com/kebasyaty/ramifice/fork>)

{ramifice-0.3.23.dist-info → ramifice-0.3.25.dist-info}/RECORD

@@ -13,7 +13,7 @@ ramifice/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ramifice/store.py,sha256=MpDEPvUvbs11FXjakNtHPm9MekIv5p1U3as2Y80lTyc,1860
 ramifice/translations.py,sha256=GNGE0ULAA0aOY5pTxUd3MQW-nVaKvp6BeXWEcsR0s0o,4048
 ramifice/types.py,sha256=ljo6VscUGWEJ4Km4JYo8GEfxd1YK1CUbS8CfHp_MlEA,2390
-ramifice/utilities.py,sha256=c662nwFcWXSXNYfwqDnGlLWpA01KaK79GwTdApqtMh8,2442
+ramifice/utilities.py,sha256=2qfdSvqlL3rhT8-7MW83IoMjKQ0CZz0e24UTxMcOq90,2654
 ramifice/commons/__init__.py,sha256=LHCsdpl4z8W-xUvAlOr1ad0ras9hspvCpuce4SAdfP0,472
 ramifice/commons/general.py,sha256=fTnIRA3IGbi0lMKBCgeqkI7BGJWTbZVu0nOJYoNRSRU,4571
 ramifice/commons/indexes.py,sha256=ABNRXeWZSreAE4_EDlsTN9aS8QiZbzhsatUJFn2EuOo,3849
@@ -35,21 +35,21 @@ ramifice/fields/choice_text_dyn_field.py,sha256=FyXeaTOfg3YfpgZ5TjXGGvFe2LasmbsM
 ramifice/fields/choice_text_field.py,sha256=oy_yB_0cuWNM2CWZAC9ZMzkMtkyb7ViCvB3YcWJG41Y,3812
 ramifice/fields/choice_text_mult_dyn_field.py,sha256=L-pmeIMa8Vh8O6G7f1TnmEI26dlyHbSOc2fPKN6tJoU,3043
 ramifice/fields/choice_text_mult_field.py,sha256=1R1z7hzmdhhlEBoltxL67KwrId6WEapEuCxMI-O46_Q,4166
-ramifice/fields/color_field.py,sha256=sjVSoJU6TIZ66wzPx0WRl5zQsx-kINMMuxa_pSUpW6M,3766
+ramifice/fields/color_field.py,sha256=zoqNw7o8VNE7qogd-7yV2Kh3SDb-u76FskpE2RTKHuQ,3494
 ramifice/fields/date_field.py,sha256=Vlaxgp3WeDNMwbnQcTGu8kyQ7gc7M-7sFBPfzu-4MVw,5205
 ramifice/fields/date_time_field.py,sha256=VpLeYJHs0df45fz4gnprtn7aipVFKGY4n02eRep7in0,5240
-ramifice/fields/email_field.py,sha256=wOM07nQ5fOSOTydQhg3b4dV_95F1bd97peQ_XAnV0MY,3720
+ramifice/fields/email_field.py,sha256=NrP87ZpYsEFbI2jd4MiiLHi6MpE3uRr5XVm1GRwcWpM,3403
 ramifice/fields/file_field.py,sha256=NMM9k-kVes7VarxvTQmsl2f2nvRKp-upjPHMDjNIrwY,7892
 ramifice/fields/float_field.py,sha256=4l7gzg46qQ7ZbXS6Z8GUhiUBR26rXChvO_uFx-lbUds,4555
 ramifice/fields/id_field.py,sha256=5wlY2j051TB2GPsw0iQkFiQBV_Y_o1W_QnCtBlaDuYQ,4126
 ramifice/fields/image_field.py,sha256=u4YJ3vFtGj5uhVLjgrvV9gNLwLXT4jfVPUN2mlPKHfg,12269
 ramifice/fields/integer_field.py,sha256=Gnm5IBSvWtCLGbg5pOSAdKa5xLzqXgiigVbzw8zcjas,4531
-ramifice/fields/ip_field.py,sha256=D7xR3A-O049TQ_pEEKVTLsKF5cdr5O7ULyz4Pj3-cwQ,3601
-ramifice/fields/password_field.py,sha256=5BlZZ4mXM0CAYDHguwsK8KFnvkOOmr8R0yowHByNVD4,3451
-ramifice/fields/phone_field.py,sha256=ymMbeWq3QI15BzsVUfuuhlHfqtaE_6AvyKkX4PG3zNk,4006
+ramifice/fields/ip_field.py,sha256=inImogNq0ldYZ8ceOG9vMj_cqbykmgnsTcsRzV_vWWg,3312
+ramifice/fields/password_field.py,sha256=_O2VGcKAfrMkFSWFIE7foVB5r3K4EoO8TIQNNNooQxo,3207
+ramifice/fields/phone_field.py,sha256=dPpEdiiaZtf1eYV7AgzrM_-ZfkGPQVaGZmMsnwXECto,3585
 ramifice/fields/slug_field.py,sha256=t-9ckQ6ki7lNis7U05t4MDd0cE_cdm29es8zfRlHfSs,2655
 ramifice/fields/text_field.py,sha256=AFkXCEI_4QjBdyYtp1DClwaCLkwjKurmLcrDtxhSGxc,3971
-ramifice/fields/url_field.py,sha256=2TbaSfNdD5nxgoVXNgeN0vrpYltmglPHukLWKv2psxc,4248
+ramifice/fields/url_field.py,sha256=FPfpJGeRSdiVVQ1Wf8USZ7BxOm25v3Kp2FLmd-mxvMw,3963
 ramifice/fields/general/__init__.py,sha256=5OE0TwPQjvpB3lBPuEwKrhjR_1ehOWxB98OJP_n32MA,20
 ramifice/fields/general/choice_group.py,sha256=TBJblwH8mB71wd1z2jcSs28H-zx3JZVBfkk4YCE1-pI,916
 ramifice/fields/general/date_group.py,sha256=RKockc_X1bYAbpzxTzXdc0kxgx51MK0bjko_j34ixWU,1169
@@ -73,10 +73,10 @@ ramifice/paladins/groups/file_group.py,sha256=AtGu2sQ9A64dPo2Kpt4milp5HWPdULdPdQ
 ramifice/paladins/groups/id_group.py,sha256=zAlJrDTOdRY9e7eFYSXPjjsD05A4EsgSE6ibN3KKOMU,1263
 ramifice/paladins/groups/img_group.py,sha256=o0bMI1WIA6t1QrhLaR2bBAAJUKCgHg7SiIFQsGTr2Cg,5535
 ramifice/paladins/groups/num_group.py,sha256=lpyFG9a6WGOzu9f_9jwYVWZNFHxG0B0AVWvvbv_2mV0,2224
-ramifice/paladins/groups/pass_group.py,sha256=7EXqssszWQaDldJgvyNFFPxj1KSdCN89xFXrfYTTZTQ,1817
+ramifice/paladins/groups/pass_group.py,sha256=tjBSovPSCKATF46FazT0a1EQ2YiztRqOjBq0uu2nTU8,1852
 ramifice/paladins/groups/slug_group.py,sha256=SVYxHcSSgCA51C18LVGxMQYuUw-6ryQlTi6B9T8Dzsw,2185
-ramifice/paladins/groups/text_group.py,sha256=N_uHsL-JJnNp2JIzNxmNyK9hRupdZGTx9Cbe6muKSmI,3128
-ramifice-0.3.23.dist-info/METADATA,sha256=yvhJPp8JUOSszvNnN1oZwHJfRunW0sX4b4Xzk_L724Y,18939
-ramifice-0.3.23.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-ramifice-0.3.23.dist-info/licenses/LICENSE,sha256=LrEL0aTZx90HDwFUQCJutORiDjJL9AnuVvCtspXIqt4,1095
-ramifice-0.3.23.dist-info/RECORD,,
+ramifice/paladins/groups/text_group.py,sha256=o5DnlptN93vsHtb36qO-noEnPv7CSAiqVj1j603zKw0,3159
+ramifice-0.3.25.dist-info/METADATA,sha256=RCix9UrN67JO5bCxjhQ4lgWYtiX-RlQJHzm7erzuuN8,20303
+ramifice-0.3.25.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ramifice-0.3.25.dist-info/licenses/LICENSE,sha256=LrEL0aTZx90HDwFUQCJutORiDjJL9AnuVvCtspXIqt4,1095
+ramifice-0.3.25.dist-info/RECORD,,