From 63d60c797dbff1f386a112b13e89a6a8c427b906 Mon Sep 17 00:00:00 2001 From: sg495 Date: Tue, 30 Jan 2024 10:44:57 +0000 Subject: [PATCH] ran black, fixed docstring --- typing_validation/__init__.py | 2 +- typing_validation/validation.py | 4 +++- typing_validation/validation_failure.py | 13 ++++++++----- 3 files changed, 12 insertions(+), 7 deletions(-) diff --git a/typing_validation/__init__.py b/typing_validation/__init__.py index 46b8c93..ea70364 100644 --- a/typing_validation/__init__.py +++ b/typing_validation/__init__.py @@ -11,7 +11,7 @@ validation_aliases, validated, validated_iter, - is_valid + is_valid, ) from .validation_failure import ( get_validation_failure, diff --git a/typing_validation/validation.py b/typing_validation/validation.py index ae670f1..7bb974e 100644 --- a/typing_validation/validation.py +++ b/typing_validation/validation.py @@ -19,7 +19,7 @@ MissingKeysValidationFailure, UnionValidationFailure, ValidationFailure, - _set_latest_validation_failure + _set_latest_validation_failure, ) from .inspector import TypeInspector @@ -736,6 +736,7 @@ def can_validate(t: Any) -> TypeInspector: and :func:`validated_iter`. """ + def is_valid(val: T, t: Any) -> bool: """ Performs the same functionality as :func:`validate`, but returning @@ -752,6 +753,7 @@ def is_valid(val: T, t: Any) -> bool: _set_latest_validation_failure(getattr(e, "validation_failure")) return False + def validated(val: T, t: Any) -> T: """ Performs the same functionality as :func:`validate`, but returns ``val`` diff --git a/typing_validation/validation_failure.py b/typing_validation/validation_failure.py index b1e4e8a..26e9e25 100644 --- a/typing_validation/validation_failure.py +++ b/typing_validation/validation_failure.py @@ -481,8 +481,9 @@ def latest_validation_failure() -> Optional[ValidationFailure]: ValidationFailure([2, 'hi'], list[int], ValidationFailure('hi', ))) - This validation failure information is also set by :func:`is_valid` in case - of failed validation, even though no error is raised. + This validation failure information is also set by + :func:`~typing_validation.validation.is_valid` in case of failed validation, + even though no error is raised. """ type_err: Optional[TypeError] = None try: @@ -496,16 +497,18 @@ def latest_validation_failure() -> Optional[ValidationFailure]: return get_validation_failure(type_err) return latest_validation_failure + _latest_validation_failure: Optional[ValidationFailure] = None + def _set_latest_validation_failure( - failure: Optional[ValidationFailure] - ) -> Optional[ValidationFailure]: + failure: Optional[ValidationFailure], +) -> Optional[ValidationFailure]: """ Sets a new value for ``_latest_validation_failure`` and returns the previous value. """ - global _latest_validation_failure # pylint: disable = global-statement + global _latest_validation_failure # pylint: disable = global-statement prev_failure = _latest_validation_failure _latest_validation_failure = failure return prev_failure