validators.slug

Slug.

@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')
True
>>> slug('my.slug')
ValidationError(func=slug, args={'value': 'my.slug'})
Arguments:
  • value: Slug string to validate.
Returns:

(Literal[True]): If value is a valid slug. (ValidationError): If value is an invalid slug.