length

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

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	int	The minimum required length of the string. If not provided, minimum length will not be checked.	0
max_val	int	The maximum length of the string. If not provided, maximum length will not be checked.	0

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.

New in version 0.2.0.

Source code in /opt/hostedtoolcache/Python/3.11.7/x64/lib/python3.11/site-packages/validators/length.py

@validator
def length(value: str, /, *, min_val: int = 0, max_val: int = 0):
    """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.

    > *New in version 0.2.0*.
    """
    return between(len(value), min_val=min_val, max_val=max_val) if value else False