-
Notifications
You must be signed in to change notification settings - Fork 174
Expand file tree
/
Copy pathlength.py
More file actions
45 lines (36 loc) · 1.45 KB
/
length.py
File metadata and controls
45 lines (36 loc) · 1.45 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
"""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))