encoding

validators.encoding.base16(value)

Return whether or not given value is a valid base16 encoding.

Examples:

>>> base16('a3f4b2')
# Output: True
>>> base16('a3f4Z1')
# Output: ValidationError(func=base16, args={'value': 'a3f4Z1'})

Parameters:

Name	Type	Description	Default
value	str	base16 string to validate.	required

Returns:

Type	Description
Literal[True]	If value is a valid base16 encoding.
ValidationError	If value is an invalid base16 encoding.

Source code in src/validators/encoding.py

@validator
def base16(value: str, /):
    """Return whether or not given value is a valid base16 encoding.

    Examples:
        >>> base16('a3f4b2')
        # Output: True
        >>> base16('a3f4Z1')
        # Output: ValidationError(func=base16, args={'value': 'a3f4Z1'})

    Args:
        value:
            base16 string to validate.

    Returns:
        (Literal[True]): If `value` is a valid base16 encoding.
        (ValidationError): If `value` is an invalid base16 encoding.
    """
    return re.match(r"^[0-9A-Fa-f]+$", value) if value else False

validators.encoding.base32(value)

Return whether or not given value is a valid base32 encoding.

Examples:

>>> base32('MFZWIZLTOQ======')
# Output: True
>>> base32('MfZW3zLT9Q======')
# Output: ValidationError(func=base32, args={'value': 'MfZW3zLT9Q======'})

Parameters:

Name	Type	Description	Default
value	str	base32 string to validate.	required

Returns:

Type	Description
Literal[True]	If value is a valid base32 encoding.
ValidationError	If value is an invalid base32 encoding.

Source code in src/validators/encoding.py

@validator
def base32(value: str, /):
    """Return whether or not given value is a valid base32 encoding.

    Examples:
        >>> base32('MFZWIZLTOQ======')
        # Output: True
        >>> base32('MfZW3zLT9Q======')
        # Output: ValidationError(func=base32, args={'value': 'MfZW3zLT9Q======'})

    Args:
        value:
            base32 string to validate.

    Returns:
        (Literal[True]): If `value` is a valid base32 encoding.
        (ValidationError): If `value` is an invalid base32 encoding.
    """
    return re.match(r"^[A-Z2-7]+=*$", value) if value else False

validators.encoding.base58(value)

Return whether or not given value is a valid base58 encoding.

Examples:

>>> base58('14pq6y9H2DLGahPsM4s7ugsNSD2uxpHsJx')
# Output: True
>>> base58('cUSECm5YzcXJwP')
# Output: ValidationError(func=base58, args={'value': 'cUSECm5YzcXJwP'})

Parameters:

Name	Type	Description	Default
value	str	base58 string to validate.	required

Returns:

Type	Description
Literal[True]	If value is a valid base58 encoding.
ValidationError	If value is an invalid base58 encoding.

Source code in src/validators/encoding.py

@validator
def base58(value: str, /):
    """Return whether or not given value is a valid base58 encoding.

    Examples:
        >>> base58('14pq6y9H2DLGahPsM4s7ugsNSD2uxpHsJx')
        # Output: True
        >>> base58('cUSECm5YzcXJwP')
        # Output: ValidationError(func=base58, args={'value': 'cUSECm5YzcXJwP'})

    Args:
        value:
            base58 string to validate.

    Returns:
        (Literal[True]): If `value` is a valid base58 encoding.
        (ValidationError): If `value` is an invalid base58 encoding.
    """
    return re.match(r"^[1-9A-HJ-NP-Za-km-z]+$", value) if value else False

validators.encoding.base64(value)

Return whether or not given value is a valid base64 encoding.

Examples:

>>> base64('Y2hhcmFjdGVyIHNldA==')
# Output: True
>>> base64('cUSECm5YzcXJwP')
# Output: ValidationError(func=base64, args={'value': 'cUSECm5YzcXJwP'})

Parameters:

Name	Type	Description	Default
value	str	base64 string to validate.	required

Returns:

Type	Description
Literal[True]	If value is a valid base64 encoding.
ValidationError	If value is an invalid base64 encoding.

Source code in src/validators/encoding.py

@validator
def base64(value: str, /):
    """Return whether or not given value is a valid base64 encoding.

    Examples:
        >>> base64('Y2hhcmFjdGVyIHNldA==')
        # Output: True
        >>> base64('cUSECm5YzcXJwP')
        # Output: ValidationError(func=base64, args={'value': 'cUSECm5YzcXJwP'})

    Args:
        value:
            base64 string to validate.

    Returns:
        (Literal[True]): If `value` is a valid base64 encoding.
        (ValidationError): If `value` is an invalid base64 encoding.
    """
    return (
        re.match(r"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", value)
        if value
        else False
    )