-
Notifications
You must be signed in to change notification settings - Fork 181
Expand file tree
/
Copy pathlength.py
More file actions
39 lines (32 loc) · 1.15 KB
/
Copy pathlength.py
File metadata and controls
39 lines (32 loc) · 1.15 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
"""Length."""
# -*- coding: utf-8 -*-
# local
from .utils import validator
from .between import between
@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: ValidationFailure(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.
(ValidationFailure):
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