|
Server : LiteSpeed System : Linux srv104790275 5.15.0-161-generic #171-Ubuntu SMP Sat Oct 11 08:17:01 UTC 2025 x86_64 User : dewac4139 ( 1077) PHP Version : 8.0.30 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, Directory : /usr/local/CyberPanel/lib/python3.10/site-packages/validators/ |
Upload File : |
"""Length."""
# standard
from typing import Union
# local
from .between import between
from .utils import validator
@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))