Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.11/site-packages/validators/slug.py: 100%

1"""Slug.""" 

2 

3# standard 

4import re 

5 

6# local 

7from .utils import validator 

8 

9_SLUG_REGEXP = re.compile(r"^[a-z0-9]+(?:-[a-z0-9]+)*$") 

10 

11 

12@validator 

13def slug(value: str, /): 

14 """Validate whether or not given value is valid slug. 

15 

16 Valid slug can contain only lowercase alphanumeric characters and hyphens. 

17 It starts and ends with these lowercase alphanumeric characters. 

18 

19 Examples: 

20 >>> slug('my-slug-2134') 

21 True 

22 >>> slug('my.slug') 

23 ValidationError(func=slug, args={'value': 'my.slug'}) 

24 

25 Args: 

26 value: Slug string to validate. 

27 

28 Returns: 

29 (Literal[True]): If `value` is a valid slug. 

30 (ValidationError): If `value` is an invalid slug. 

31 """ 

32 return _SLUG_REGEXP.fullmatch(value) is not None