Fixed imports, is_email -> email

kvesteri · kvesteri · commit f3c3400ddcb9 · 2013-10-21T14:44:59.000+03:00
diff --git a/docs/index.rst b/docs/index.rst
@@ -35,7 +35,7 @@ API
 
 Each validator in `validators` is a simple function that takes the value to validate and possibly some additional key-value arguments. Each function returns `True` when validation succeeds and ValidationFailure object when validation fails.
 
-ValidationFailure class implements __bool__ method so you can easily check if validation failed with:
+ValidationFailure class implements __bool__ method so you can easily check if validation failed:
 
 ::
 
@@ -65,7 +65,7 @@ ValidationFailure object also holds all the arguments passed to original functio
 email
 -----
 
-.. autofunction:: is_email
+.. autofunction:: email
 
 ipv4
 ----
diff --git a/tests/test_email.py b/tests/test_email.py
@@ -1,9 +1,9 @@
 # -*- coding: utf-8 -*-
 import pytest
-from validators import is_email, FailedValidation
+from validators import email, ValidationFailure
 
 
-@pytest.mark.parametrize(('email', 'whitelist'), [
+@pytest.mark.parametrize(('value', 'whitelist'), [
     ('email@here.com', None),
     ('weirder-email@here.and.there.com', None),
     ('email@[127.0.0.1]', None),
@@ -15,11 +15,11 @@
     ('"test@test"@example.com', None),
     ('"\\\011"@here.com', None),
 ])
-def test_returns_true_on_valid_email(email, whitelist):
-    assert is_email(email, whitelist=whitelist)
+def test_returns_true_on_valid_email(value, whitelist):
+    assert email(value, whitelist=whitelist)
 
 
-@pytest.mark.parametrize(('email',), [
+@pytest.mark.parametrize(('value',), [
     (None,),
     ('',),
     ('abc',),
@@ -36,5 +36,5 @@ def test_returns_true_on_valid_email(email, whitelist):
     # Quoted-string format (CR not allowed)
     ('"\\\012"@here.com',),
 ])
-def test_returns_failed_validation_on_invalid_email(email):
-    assert isinstance(is_email(email), FailedValidation)
+def test_returns_failed_validation_on_invalid_email(value):
+    assert isinstance(email(value), ValidationFailure)
diff --git a/tests/test_ipv4.py b/tests/test_ipv4.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 import pytest
-from validators import ipv4, FailedValidation
+from validators import ipv4, ValidationFailure
 
 
 @pytest.mark.parametrize(('address',), [
@@ -19,4 +19,4 @@ def test_returns_true_on_valid_ipv4_address(address):
     ('900.200.100.75',),
 ])
 def test_returns_failed_validation_on_invalid_ipv4_address(address):
-    assert isinstance(ipv4(address), FailedValidation)
+    assert isinstance(ipv4(address), ValidationFailure)
diff --git a/tests/test_ipv6.py b/tests/test_ipv6.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 import pytest
-from validators import ipv6, FailedValidation
+from validators import ipv6, ValidationFailure
 
 
 @pytest.mark.parametrize(('address',), [
@@ -19,4 +19,4 @@ def test_returns_true_on_valid_ipv4_address(address):
     ('abcd::1ffff',),
 ])
 def test_returns_failed_validation_on_invalid_ipv6_address(address):
-    assert isinstance(ipv6(address), FailedValidation)
+    assert isinstance(ipv6(address), ValidationFailure)
diff --git a/tests/test_length.py b/tests/test_length.py
@@ -32,5 +32,5 @@ def test_raises_assertion_error_for_invalid_args(value, min, max):
 def test_returns_failed_validation_on_invalid_range(value, min, max):
     assert isinstance(
         validators.length(value, min=min, max=max),
-        validators.FailedValidation
+        validators.ValidationFailure
     )
diff --git a/tests/test_mac_address.py b/tests/test_mac_address.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 import pytest
-from validators import mac_address, FailedValidation
+from validators import mac_address, ValidationFailure
 
 
 @pytest.mark.parametrize(('address',), [
@@ -17,4 +17,4 @@ def test_returns_true_on_valid_mac_address(address):
     ('123:23:45:67:89:00',),
 ])
 def test_returns_failed_validation_on_invalid_mac_address(address):
-    assert isinstance(mac_address(address), FailedValidation)
+    assert isinstance(mac_address(address), ValidationFailure)
diff --git a/tests/test_number_range.py b/tests/test_number_range.py
@@ -29,4 +29,4 @@ def test_raises_assertion_error_for_invalid_args(value, min, max):
 ])
 def test_returns_failed_validation_on_invalid_range(value, min, max):
     result = validators.number_range(value, min=min, max=max)
-    assert isinstance(result, validators.FailedValidation)
+    assert isinstance(result, validators.ValidationFailure)
diff --git a/tests/test_url.py b/tests/test_url.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 import pytest
-from validators import url, FailedValidation
+from validators import url, ValidationFailure
 
 
 @pytest.mark.parametrize(('address', 'require_tld'), [
@@ -25,4 +25,4 @@ def test_returns_true_on_valid_url(address, require_tld):
     ('http://localhost:abc/a',),
 ])
 def test_returns_failed_validation_on_invalid_url(address):
-    assert isinstance(url(address), FailedValidation)
+    assert isinstance(url(address), ValidationFailure)
diff --git a/tests/test_uuid.py b/tests/test_uuid.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 import pytest
-from validators import uuid, FailedValidation
+from validators import uuid, ValidationFailure
 
 
 @pytest.mark.parametrize(('value',), [
@@ -17,4 +17,4 @@ def test_returns_true_on_valid_mac_address(value):
     ('2bc1c94f 0deb-43e9-92a1-4775189ec9f8',),
 ])
 def test_returns_failed_validation_on_invalid_mac_address(value):
-    assert isinstance(uuid(value), FailedValidation)
+    assert isinstance(uuid(value), ValidationFailure)
diff --git a/validators/__init__.py b/validators/__init__.py
@@ -1,4 +1,4 @@
-from .email import is_email
+from .email import email
 from .extremes import Min, Max
 from .ip_address import ipv4, ipv6
 from .mac_address import mac_address
@@ -10,7 +10,7 @@
 __all__ = (
     ipv4,
     ipv6,
-    is_email,
+    email,
     mac_address,
     url,
     uuid,
diff --git a/validators/email.py b/validators/email.py
@@ -23,7 +23,7 @@
 
 
 @validator
-def is_email(email, whitelist=None):
+def email(value, whitelist=None):
     """
     Validates an email address. This validator is based on `Django's
     email validator`_. Returns True on success and `:class:FailedValidation`
@@ -41,10 +41,10 @@ def is_email(email, whitelist=None):
     if whitelist is None:
         whitelist = domain_whitelist
 
-    if not email or '@' not in email:
+    if not value or '@' not in value:
         return False
 
-    user_part, domain_part = email.rsplit('@', 1)
+    user_part, domain_part = value.rsplit('@', 1)
 
     if not user_regex.match(user_part):
         return False

Original file line number	Diff line number	Diff line change
`@@ -32,5 +32,5 @@ def test_raises_assertion_error_for_invalid_args(value, min, max):`
`32`	`32`	`def test_returns_failed_validation_on_invalid_range(value, min, max):`
`33`	`33`	`assert isinstance(`
`34`	`34`	`validators.length(value, min=min, max=max),`
`35`		`- validators.FailedValidation`
	`35`	`+ validators.ValidationFailure`
`36`	`36`	`)`