validators/src/validators/uuid.py at master · python-validators/validators · GitHub

Repository navigation

43 lines (34 loc) · 1.07 KB

"""UUID."""

# standard

import re

from typing import Union

from uuid import UUID

# local

from .utils import validator

@validator

def uuid(value: Union[str, UUID], /):

"""Return whether or not given value is a valid UUID-v4 string.

This validator is based on [WTForms UUID validator][1].

[1]: https://github.com/wtforms/wtforms/blob/master/src/wtforms/validators.py#L539

Examples:

>>> uuid('2bc1c94f-0deb-43e9-92a1-4775189ec9f8')

True

>>> uuid('2bc1c94f 0deb-43e9-92a1-4775189ec9f8')

ValidationError(func=uuid, args={'value': '2bc1c94f 0deb-43e9-92a1-4775189ec9f8'})

Args:

value:

UUID string or object to validate.

Returns:

(Literal[True]): If `value` is a valid UUID.

(ValidationError): If `value` is an invalid UUID.

"""

if not value:

return False

if isinstance(value, UUID):

return True

try:

return UUID(value) or re.match(

r"^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$", value

)

except ValueError:

return False