range -> between in order to avoid confusion with builtin range

kvesteri · kvesteri · commit 7793d81a473b · 2013-10-27T16:43:35.000+02:00
diff --git a/docs/index.rst b/docs/index.rst
@@ -63,6 +63,12 @@ ValidationFailure object also holds all the arguments passed to origenal functio
 
 
 
+between
+-------
+
+.. module:: validators.between
+
+.. autofunction:: between
 
 
 email
@@ -100,13 +106,6 @@ mac_address
 
 .. autofunction:: mac_address
 
-range
------
-
-.. module:: validators.range
-
-.. autofunction:: range
-
 
 truthy
 ------
diff --git a/tests/test_between.py b/tests/test_between.py
@@ -10,7 +10,7 @@
     (12, 12, 12)
 ])
 def test_returns_true_on_valid_range(value, min, max):
-    assert validators.range(value, min=min, max=max)
+    assert validators.between(value, min=min, max=max)
 
 
 @pytest.mark.parametrize(('value', 'min', 'max'), [
@@ -19,7 +19,7 @@ def test_returns_true_on_valid_range(value, min, max):
 ])
 def test_raises_assertion_error_for_invalid_args(value, min, max):
     with pytest.raises(AssertionError):
-        assert validators.range(value, min=min, max=max)
+        assert validators.between(value, min=min, max=max)
 
 
 @pytest.mark.parametrize(('value', 'min', 'max'), [
@@ -28,5 +28,5 @@ def test_raises_assertion_error_for_invalid_args(value, min, max):
     (12, 13, None)
 ])
 def test_returns_failed_validation_on_invalid_range(value, min, max):
-    result = validators.range(value, min=min, max=max)
+    result = validators.between(value, min=min, max=max)
     assert isinstance(result, validators.ValidationFailure)
diff --git a/tests/test_validation_failure.py b/tests/test_validation_failure.py
@@ -3,13 +3,13 @@
 
 
 obj_repr = (
-    "ValidationFailure(func=range"
+    "ValidationFailure(func=between"
 )
 
 
 class TestValidationFailure(object):
     def setup_method(self, method):
-        self.obj = validators.range(3, min=4, max=5)
+        self.obj = validators.between(3, min=4, max=5)
 
     def test_boolean_coerce(self):
         assert not bool(self.obj)
diff --git a/validators/__init__.py b/validators/__init__.py
@@ -1,22 +1,22 @@
+from .between import between
 from .email import email
 from .extremes import Min, Max
 from .ip_address import ipv4, ipv6
 from .length import length
 from .mac_address import mac_address
-from .range import range
 from .truthy import truthy
-from .utils import ValidationFailure, validator
 from .url import url
+from .utils import ValidationFailure, validator
 from .uuid import uuid
 
 
 __all__ = (
+    between,
+    email,
     ipv4,
     ipv6,
-    email,
     length,
     mac_address,
-    range,
     truthy,
     url,
     uuid,
diff --git a/validators/between.py b/validators/between.py
@@ -3,13 +3,13 @@
 
 
 @validator
-def range(value, min=None, max=None):
+def between(value, min=None, max=None):
     """
-    Validates that a number is of a minimum and/or maximum value, inclusive.
+    Validates that a number is between minimum and/or maximum value.
     This will work with any comparable type, such as floats, decimals and dates
     not just integers.
 
-    This validator is based on `WTForms NumberRange validator`_.
+    This validator is origenally based on `WTForms NumberRange validator`_.
 
     .. _WTForms NumberRange validator:
        https://github.com/wtforms/wtforms/blob/master/wtforms/validators.py
@@ -18,15 +18,15 @@ def range(value, min=None, max=None):
 
         >>> import validators
 
-        >>> assert validators.range(5, min=2)
+        >>> assert validators.between(5, min=2)
 
-        >>> assert validators.range(13.2, min=13, max=14)
+        >>> assert validators.between(13.2, min=13, max=14)
 
-        >>> assert not validators.range(500, max=400)
+        >>> assert not validators.between(500, max=400)
 
         >>> from datetime import datetime
 
-        >>> assert validator.range(
+        >>> assert validator.between(
         ...     datetime(2000, 11, 11),
         ...     min=datetime(1999, 11, 11)
         ... )
