length

validators.length.length(value, /, *, min_val=None, max_val=None)

Return whether or not the length of given string is within a specified range.

Examples:

>>> length('something', min_val=2)
# Output: True
>>> length('something', min_val=9, max_val=9)
# Output: True
>>> length('something', max_val=5)
# Output: ValidationError(func=length, ...)

Parameters:

Name	Type	Description	Default
value	str	The string to validate.	required
min_val	Union[int, None]	The minimum required length of the string. If not provided, minimum length will not be checked.	None
max_val	Union[int, None]	The maximum length of the string. If not provided, maximum length will not be checked.	None

Returns:

Type	Description
Literal[True]	If len(value) is in between the given conditions.
ValidationError	If len(value) is not in between the given conditions.

Raises:

Type	Description
ValueError	If either min_val or max_val is negative.

Source code in src/validators/length.py

@validator
def length(value: str, /, *, min_val: Union[int, None] = None, max_val: Union[int, None] = None):
    """Return whether or not the length of given string is within a specified range.

    Examples:
        >>> length('something', min_val=2)
        # Output: True
        >>> length('something', min_val=9, max_val=9)
        # Output: True
        >>> length('something', max_val=5)
        # Output: ValidationError(func=length, ...)

    Args:
        value:
            The string to validate.
        min_val:
            The minimum required length of the string. If not provided,
            minimum length will not be checked.
        max_val:
            The maximum length of the string. If not provided,
            maximum length will not be checked.

    Returns:
        (Literal[True]): If `len(value)` is in between the given conditions.
        (ValidationError): If `len(value)` is not in between the given conditions.

    Raises:
        (ValueError): If either `min_val` or `max_val` is negative.
    """
    if min_val is not None and min_val < 0:
        raise ValueError("Length cannot be negative. `min_val` is less than zero.")
    if max_val is not None and max_val < 0:
        raise ValueError("Length cannot be negative. `max_val` is less than zero.")

    return bool(between(len(value), min_val=min_val, max_val=max_val))