slug

validators.slug.slug(value)

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'})

Parameters:

Name	Type	Description	Default
value	str	Slug string to validate.	required

Returns:

Type	Description
Literal[True]	If value is a valid slug.
ValidationError	If value is an invalid slug.

New in version 0.6.0.

Source code in /opt/hostedtoolcache/Python/3.11.7/x64/lib/python3.11/site-packages/validators/slug.py

@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.

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