add time-delta field

Author: aisch

pilo/fields.py

@@ -58,6 +58,11 @@ def field1(self, value):
 except ImportError:
     pass
 
+try:
+    import pytimeparse
+except ImportError as ex:
+    pass
+
 from . import (
     NONE, NOT_SET, ERROR, IGNORE, ctx, ContextMixin, Close, Source, SourceError, DefaultSource, Types,
 )
@@ -731,16 +736,12 @@ def _validate(self, value):
         return True
 
 
-class Number(Field):
+class RangeMixin(object):
 
-    def __init__(self, *args, **kwargs):
-        range_value = kwargs.pop('range', None)
-        if range_value is not None:
-            self.min_value, self.max_value = range_value
-        else:
-            self.min_value = kwargs.pop('min_value', None)
-            self.max_value = kwargs.pop('max_value', None)
-        super(Number, self).__init__(*args, **kwargs)
+
+    min_value = None
+
+    max_value = None
 
     def min(self, value):
         self.min_value = value
@@ -753,9 +754,7 @@ def max(self, value):
     def range(self, l, r):
         return self.min(l).max(r)
 
-    def _validate(self, value):
-        if not super(Number, self)._validate(value):
-            return False
+    def validate(self, value):
         if value is not None:
             if self.min_value is not None and value < self.min_value:
                 self.ctx.errors.invalid('"{0}" must be >= {1}'.format(
@@ -769,6 +768,22 @@ def _validate(self, value):
                 return False
         return True
 
+class Number(Field, RangeMixin):
+
+    def __init__(self, *args, **kwargs):
+        range_value = kwargs.pop('range', None)
+        if range_value is not None:
+            self.min_value, self.max_value = range_value
+        else:
+            self.min_value = kwargs.pop('min_value', None)
+            self.max_value = kwargs.pop('max_value', None)
+        super(Number, self).__init__(*args, **kwargs)
+
+    def _validate(self, value):
+        if not super(Number, self)._validate(value):
+            return False
+        return RangeMixin.validate(self, value)
+
 
 class Integer(Number):
 
@@ -836,7 +851,7 @@ def _parse(self, path):
 Bool = Boolean
 
 
-class RangeMixin(object):
+class TimeRangeMixin(object):
 
     def after(self, value):
         self.after_value = value
@@ -850,7 +865,7 @@ def between(self, l, r):
         return self.after(l).before(r)
 
 
-class Date(Field, RangeMixin):
+class Date(Field, TimeRangeMixin):
 
     def __init__(self, *args, **kwargs):
         self.after_value = kwargs.pop('after', None)
@@ -910,7 +925,7 @@ def _validate(self, value):
         return True
 
 
-class Time(Field, RangeMixin):
+class Time(Field, TimeRangeMixin):
 
     def __init__(self, *args, **kwargs):
         self.after_value = kwargs.pop('after', None)
@@ -949,7 +964,7 @@ def _validate(self, value):
         return True
 
 
-class Datetime(Field, RangeMixin):
+class Datetime(Field, TimeRangeMixin):
 
     def __init__(self, *args, **kwargs):
         self.after_value = kwargs.pop('after', None)
@@ -993,6 +1008,43 @@ def _validate(self, value):
         return True
 
 
+class TimeDelta(Field, RangeMixin):
+
+    def __init__(self, *args, **kwargs):
+        range_value = kwargs.pop('range', None)
+        if range_value is not None:
+            self.min_value, self.max_value = range_value
+        else:
+            self.min_value = kwargs.pop('min_value', None)
+            self.max_value = kwargs.pop('max_value', None)
+        self._format = kwargs.pop('format', 'human')
+        super(TimeDelta, self).__init__(*args, **kwargs)
+
+    def format(self, value):
+        self._format = value
+        return self
+
+    def _parse(self, path):
+        if isinstance(path.value, datetime.datetime):
+            return path.value
+        value = path.primitive(basestring)
+        if self._format == 'human':
+            parsed = pytimeparse.parse(value)
+            if parsed is None:
+                self.ctx.errors.invalid('Not a time-delta expression')
+                return ERROR
+            parsed = datetime.timedelta(seconds=parsed)
+        else:
+            self.ctx.errors.invalid('No format for value "{0}"'.format(value))
+            return ERROR
+        return parsed
+
+    def _validate(self, value):
+        if not super(TimeDelta, self)._validate(value):
+            return False
+        return RangeMixin.validate(self, value)
+
+
 class Tuple(Field):
 
     def __init__(self, *args, **kwargs):

setup.py

@@ -18,6 +18,7 @@ def run_tests(self):
     'tests': [
         'pytest >=2.5.2,<3',
         'pytest-cov >=1.7,<2',
+        'pytimeparse >=1.1.5,<2',
         'mock >=1.0,<2.0',
         'unittest2 >=0.5.1,<0.6',
         'iso8601 >=0.1,<0.2',

tests/test_fields.py

@@ -1,5 +1,6 @@
 import abc
 import datetime
+import inspect
 import re
 
 import pilo
@@ -295,6 +296,24 @@ class MyForm(pilo.Form):
 
         MyForm(src)
 
+    def test_time_delta(self):
+
+        class Task(pilo.Form):
+
+            due_in = pilo.fields.TimeDelta()
+
+        for desc, expected in [
+                (dict(due_in='10s'), datetime.timedelta(seconds=10)),
+                (dict(due_in='1h10s'), datetime.timedelta(hours=1, seconds=10)),
+                (dict(due_in='nevah'), pilo.Invalid),
+            ]:
+            if inspect.isclass(expected) and issubclass(expected, Exception):
+                with self.assertRaises(expected):
+                    Task(desc)
+            else:
+                obj = Task(desc)
+                self.assertEqual(obj.due_in, expected)
+
 
 class TestFormPolymorphism(TestCase):
 
@@ -339,7 +358,7 @@ class Dog(Animal):
                 self.assertEqual(left, right)
 
     def test_computed(self):
-        
+
         class Animal(pilo.Form):
 
             clothed = pilo.fields.Boolean()