Skip to content

Commit 80a5868

Browse files
committed
Add slug validator
1 parent 50055bc commit 80a5868

6 files changed

Lines changed: 64 additions & 4 deletions

File tree

‎CHANGES.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@ Changelog
22
---------
33

44

5+
0.6.0 (2014-06-25)
6+
^^^^^^^^^^^^^^^^^^
7+
8+
- Added new validator: slug
9+
10+
511
0.5.0 (2013-10-31)
612
^^^^^^^^^^^^^^^^^^
713

‎docs/index.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,14 @@ mac_address
108108
.. autofunction:: mac_address
109109

110110

111+
slug
112+
----
113+
114+
.. module:: validators.slug
115+
116+
.. autofunction:: slug
117+
118+
111119
truthy
112120
------
113121

‎setup.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@
2222

2323
setup(
2424
name='validators',
25-
version='0.5.0',
25+
version='0.6.0',
2626
url='https://github.com/kvesteri/validators',
2727
license='BSD',
2828
author='Konsta Vesterinen',
2929
author_email='konsta@fastmonkeys.com',
3030
description='Python Data Validation for Humans™.',
3131
long_description=__doc__,
32-
packages=find_packages('.'),
32+
packages=find_packages('.', exclude=['tests', 'tests.*']),
3333
zip_safe=False,
3434
include_package_data=True,
3535
platforms='any',

‎tests/test_slug.py‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# -*- coding: utf-8 -*-
2+
import pytest
3+
from validators import slug, ValidationFailure
4+
5+
6+
@pytest.mark.parametrize('value', [
7+
'123-12312-asdasda',
8+
'123____123',
9+
'dsadasd-dsadas',
10+
])
11+
def test_returns_true_on_valid_slug(value):
12+
assert slug(value)
13+
14+
15+
@pytest.mark.parametrize('value', [
16+
'some.slug',
17+
'1231321%',
18+
' 21312',
19+
'123asda&',
20+
])
21+
def test_returns_failed_validation_on_invalid_slug(value):
22+
assert isinstance(slug(value), ValidationFailure)

‎validators/__init__.py‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@
22
from .email import email
33
from .extremes import Min, Max
44
from .ip_address import ipv4, ipv6
5+
from .i18n import fi_business_id, fi_ssn
56
from .length import length
67
from .mac_address import mac_address
8+
from .slug import slug
79
from .truthy import truthy
810
from .url import url
911
from .utils import ValidationFailure, validator
1012
from .uuid import uuid
11-
from .i18n import fi_business_id, fi_ssn
1213

1314

1415
__all__ = (
@@ -20,6 +21,7 @@
2021
ipv6,
2122
length,
2223
mac_address,
24+
slug,
2325
truthy,
2426
url,
2527
uuid,
@@ -30,4 +32,4 @@
3032
)
3133

3234

33-
__version__ = '0.5'
35+
__version__ = '0.6'

‎validators/slug.py‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
import re
2+
from .utils import validator
3+
4+
5+
slug_regex = re.compile(r'^[-a-zA-Z0-9_]+$')
6+
7+
8+
@validator
9+
def slug(value):
10+
"""
11+
Validates whether or not given value is valid slug (contains only
12+
alphanumeric characters, hyphens or underscores).
13+
14+
>>> assert not slug('my.slug')
15+
16+
>>> assert slug('my-slug-2134')
17+
18+
.. versionadded:: 0.6
19+
20+
:param value: value to validate
21+
"""
22+
return slug_regex.match(value)

0 commit comments

Comments
 (0)