python-validators/src/validators/slug.py at master · sysfce2/python-validators · GitHub

Repository navigation

30 lines (22 loc) · 750 Bytes

"""Slug."""

# standard

import re

# local

from .utils import validator

@validator

def slug(value: str, /):

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

Valid slug can contain only lowercase alphanumeric characters and hyphens.

It starts and ends with these lowercase alphanumeric characters.

Examples:

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

# Output: True

>>> slug('my.slug')

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

Args:

value: Slug string to validate.

Returns:

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

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

"""

return re.match(r"^[a-z0-9]+(?:-[a-z0-9]+)*$", value) if value else False