cuenca-validations 2.0.5.dev4__py3-none-any.whl → 2.0.5.dev6__py3-none-any.whl

cuenca_validations/types/general.py

@@ -89,3 +89,4 @@ def get_state_name(state: State):
 class LogConfig:
     masked: bool = False
     unmasked_chars_length: int = 0
+    excluded: bool = False

cuenca_validations/types/helpers.py

@@ -1,6 +1,8 @@
 import uuid
 from base64 import urlsafe_b64encode
-from typing import Callable
+from typing import Callable, Optional
+
+from pydantic.fields import FieldInfo
 
 from .general import LogConfig
 
@@ -12,6 +14,9 @@ def uuid_field(prefix: str = '') -> Callable[[], str]:
     return base64_uuid_func
 
 
-def get_log_config(field) -> LogConfig:
+def get_log_config(field: FieldInfo) -> Optional[LogConfig]:
     """Helper function to find LogConfig in field metadata"""
-    return next(m for m in field.metadata if isinstance(m, LogConfig))
+    try:
+        return next(m for m in field.metadata if isinstance(m, LogConfig))
+    except StopIteration:
+        return None

cuenca_validations/version.py

@@ -1 +1 @@
-__version__ = '2.0.5.dev4'
+__version__ = '2.0.5.dev6'

{cuenca_validations-2.0.5.dev4.dist-info → cuenca_validations-2.0.5.dev6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: cuenca_validations
-Version: 2.0.5.dev4
+Version: 2.0.5.dev6
 Summary: Cuenca common validations
 Home-page: https://github.com/cuenca-mx/cuenca-validations
 Author: Cuenca

{cuenca_validations-2.0.5.dev4.dist-info → cuenca_validations-2.0.5.dev6.dist-info}/RECORD

@@ -4,13 +4,13 @@ cuenca_validations/errors.py,sha256=OtM8EgiKqYdz9Hn66AbBO96orL1or7efkyt0vh0Zxbs,
 cuenca_validations/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cuenca_validations/typing.py,sha256=1QCu81IbVZZpyInjyeAuO-nF36gpT5Gi4o6V9PozuOU,204
 cuenca_validations/validators.py,sha256=wzwLnJ4wHggZvqp3mearbFkzvDERGeTNvJkuofQnuMc,1484
-cuenca_validations/version.py,sha256=J-AVT3MMt_Bx5yrfH9pqBApN4wu2VT9f5b0js4qbDGA,27
+cuenca_validations/version.py,sha256=7vju1xXby-uZTLStSB9WeN-8fQQFIeT93MoMNabJaqQ,27
 cuenca_validations/types/__init__.py,sha256=8fiuz26oYQT2DriQ7sbD740yFJergVhB1OYoUGETB5A,4783
 cuenca_validations/types/card.py,sha256=UGzz8NTFAverUmdUKAK1oGHnOnjSNTpIRUm93vKSSGY,1295
 cuenca_validations/types/enums.py,sha256=1ACr7I1iknXfm49y0YeP2sY1ZdZfreFC5cV4_6OJCw8,18825
 cuenca_validations/types/files.py,sha256=2CszbwF9ytXV9suFFwyDjYG4XxY8UhCjRw3HttVXXNw,269
-cuenca_validations/types/general.py,sha256=hC8zeiJttPdTE4U5VFJ9IfuwXV_aos--Aj-pZsMPrIk,2222
-cuenca_validations/types/helpers.py,sha256=vCZ-iPt8beT2AdbXioIjYOYmgBjESaPAIXIHbxVJ_n0,481
+cuenca_validations/types/general.py,sha256=c3j5Iv42yEpIGbylZ-64uoURgNiTmaZPiV5WOht0jTI,2249
+cuenca_validations/types/helpers.py,sha256=6rHUhwoQ7jJZtGcW3LX-W5ZDl42PWE1RoBpGme7KCkk,610
 cuenca_validations/types/identities.py,sha256=TivJcz0I_zolAWXZB3RTwt80OUAyW_wGdCL_6VJlxSM,4735
 cuenca_validations/types/morals.py,sha256=m8kAedevmwfSPTA9GYe03l7pkgipynwYgKfejyVtnuI,1813
 cuenca_validations/types/queries.py,sha256=KCRx0sPzWDtDDbZysmFGVgANgfqil17EITWaG7tGQ-A,4700
@@ -20,9 +20,9 @@ tests/test_card.py,sha256=QAfRz7e11gWICPnFJZ2tiYgUsFV3C9TwzJXrDnDNXFw,1202
 tests/test_errors.py,sha256=ixiIgEuBuzfsL5p4uCFdF32XqFRtTPF6EVhGJ0keOrI,930
 tests/test_helpers.py,sha256=ubzpi1UXCryLQdgsT_Zm2IX-XE_4L0dnHnhLwH06xK8,748
 tests/test_statement.py,sha256=IOE0rRRBgBZSJv_FLaETEyn5NzzXKMNTqgjv99GX-68,1436
-tests/test_types.py,sha256=FMYLLYKooM7jHigwgrteO5kq-aX-9Pjbb6W__Czcqw4,17279
-cuenca_validations-2.0.5.dev4.dist-info/LICENSE,sha256=wR76FmxBbfnQpwELkkE5iMF8sFIafEMgXLTE4N4WPTc,1063
-cuenca_validations-2.0.5.dev4.dist-info/METADATA,sha256=F1CnROeHe1LHOWtJNlrJvQCEL-WDA7CctlSEPPuYcOM,1577
-cuenca_validations-2.0.5.dev4.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-cuenca_validations-2.0.5.dev4.dist-info/top_level.txt,sha256=4233xdOs2HtuT-GFRjcDcwK0IwdwvWdczOtk0fPB6Gw,25
-cuenca_validations-2.0.5.dev4.dist-info/RECORD,,
+tests/test_types.py,sha256=XpFDDO1N6kRARFLr8cXyY7jDRICAwrhNYkFst7cCKQE,17737
+cuenca_validations-2.0.5.dev6.dist-info/LICENSE,sha256=wR76FmxBbfnQpwELkkE5iMF8sFIafEMgXLTE4N4WPTc,1063
+cuenca_validations-2.0.5.dev6.dist-info/METADATA,sha256=m9_i-NdDzVvZVpYPeNnhpImNwnnUPTUlSRZJu4qO2uA,1577
+cuenca_validations-2.0.5.dev6.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+cuenca_validations-2.0.5.dev6.dist-info/top_level.txt,sha256=4233xdOs2HtuT-GFRjcDcwK0IwdwvWdczOtk0fPB6Gw,25
+cuenca_validations-2.0.5.dev6.dist-info/RECORD,,

tests/test_types.py

@@ -7,6 +7,7 @@ from typing import Annotated
 import pytest
 from freezegun import freeze_time
 from pydantic import AfterValidator, BaseModel, SecretStr, ValidationError
+from pydantic.fields import FieldInfo
 
 from cuenca_validations.types import (
     Address,
@@ -27,6 +28,7 @@ from cuenca_validations.types.enums import (
 )
 from cuenca_validations.types.general import LogConfig, StrictPositiveInt
 from cuenca_validations.types.helpers import get_log_config
+from cuenca_validations.types.identities import Password
 from cuenca_validations.types.requests import (
     ApiKeyUpdateRequest,
     BankAccountValidationRequest,
@@ -590,48 +592,61 @@ def test_strict_positive_int_invalid(value, expected_error, expected_message):
         IntModel(value=value)
 
 
-def validate_password(password: str) -> str:
+def validate_repeated_digits(password: str) -> str:
     """
     Example of a custom validator
-    Check if the password contains repeated numbers
+    Check if the str contains repeated numbers
     """
     import re
 
     if re.search(r'(\d).*\1', password):
-        raise ValueError("Password cannot contain repeated digits")
+        raise ValueError("str cannot contain repeated digits")
     return password
 
 
-class MetadataModel(BaseModel):
-    password: Annotated[
-        str, AfterValidator(validate_password), LogConfig(masked=True)
+class LogConfigModel(BaseModel):
+    password: Annotated[Password, LogConfig(masked=True)]
+    validated: Annotated[
+        str, AfterValidator(validate_repeated_digits), LogConfig(masked=True)
     ]
     secret: Annotated[str, LogConfig(masked=True)]
     partial_secret: Annotated[
         str, LogConfig(masked=True, unmasked_chars_length=4)
     ]
+    unmasked: Annotated[str, LogConfig(masked=False)]
+    excluded: Annotated[str, LogConfig(excluded=True)]
 
 
-def test_metadata():
-    model = MetadataModel(
-        password="Mypass123",
+@pytest.mark.parametrize(
+    "field_name,expected_masked,expected_unmasked_length,expected_excluded",
+    [
+        ("password", True, 0, False),
+        ("validated", True, 0, False),
+        ("secret", True, 0, False),
+        ("partial_secret", True, 4, False),
+        ("unmasked", False, 0, False),
+        ("excluded", False, 0, True),
+    ],
+)
+def test_log_config(
+    field_name, expected_masked, expected_unmasked_length, expected_excluded
+):
+    model = LogConfigModel(
+        password="Mypass123.",
+        validated="str123",
         secret="super-secret",
         partial_secret="1234567890",
+        unmasked="unmasked",
+        excluded="excluded",
     )
 
-    password_field = MetadataModel.model_fields["password"]
-    secret_field = MetadataModel.model_fields["secret"]
-    partial_field = MetadataModel.model_fields["partial_secret"]
-
-    assert get_log_config(password_field).masked is True
-    assert get_log_config(password_field).unmasked_chars_length == 0
-
-    assert get_log_config(secret_field).masked is True
-    assert get_log_config(secret_field).unmasked_chars_length == 0
+    field = model.model_fields[field_name]
+    config = get_log_config(field)
+    assert config.masked is expected_masked
+    assert config.unmasked_chars_length == expected_unmasked_length
+    assert config.excluded is expected_excluded
 
-    assert get_log_config(partial_field).masked is True
-    assert get_log_config(partial_field).unmasked_chars_length == 4
 
-    assert model.password == "Mypass123"
-    assert model.secret == "super-secret"
-    assert model.partial_secret == "1234567890"
+def test_get_log_config_no_log_config():
+    field = FieldInfo(default=None)
+    assert get_log_config(field) is None