Skip to content

Commit

Permalink
ran black, fixed docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
sg495 committed Jan 30, 2024
1 parent 5aa9182 commit 63d60c7
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 7 deletions.
2 changes: 1 addition & 1 deletion typing_validation/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
validation_aliases,
validated,
validated_iter,
is_valid
is_valid,
)
from .validation_failure import (
get_validation_failure,
Expand Down
4 changes: 3 additions & 1 deletion typing_validation/validation.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
MissingKeysValidationFailure,
UnionValidationFailure,
ValidationFailure,
_set_latest_validation_failure
_set_latest_validation_failure,
)
from .inspector import TypeInspector

Expand Down Expand Up @@ -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
Expand All @@ -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``
Expand Down
13 changes: 8 additions & 5 deletions typing_validation/validation_failure.py
Original file line number Diff line number Diff line change
Expand Up @@ -481,8 +481,9 @@ def latest_validation_failure() -> Optional[ValidationFailure]:
ValidationFailure([2, 'hi'], list[int],
ValidationFailure('hi', <class 'int'>)))
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:
Expand All @@ -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

0 comments on commit 63d60c7

Please sign in to comment.