Add support for parsing timestamps with python-dateutil library. This…

… adds a new runtime dependency but it will make the parsing alot easier then to do it manually with builtin datetime.

ReleaseNotes.rst

@@ -6,6 +6,8 @@ Release Notes
 =====
 
  - Rework cli string that docopt uses. Removed redundant flags that docopt provides [--version & --help]
+ - Add support for timestamp validation
+ - Add new runtime dependency 'python-dateutil' that is used to validate timestamps
 
 1.0.1
 =====

docs/Validation Rules.md

@@ -18,7 +18,7 @@ The followings are available:
  - text (str or number)
  - date [NYI]
  - time [NYI]
- - timestamp [NYI]
+ - timestamp
  - sequence or seq
  - mapping or map
  - none
@@ -100,6 +100,11 @@ Name of schema.
 Description is not used for validation.
 
 
+## timestamp
+
+Parse a string to determine if it is a valid timestamp. Parsing is done with `python-dateutil` lib and see all valid formats at `https://dateutil.readthedocs.org/en/latest/examples.html#parse-examples`.
+
+
 ## allowempty
 
 NOTE: Experimental feature!

pykwalify/core.py

@@ -18,6 +18,7 @@
 
 # 3rd party imports
 import yaml
+from dateutil.parser import parse
 
 log = logging.getLogger(__name__)
 
@@ -397,6 +398,21 @@ def _validate_scalar(self, value, rule, path, errors=[], done=None):
                 "scalar",
             )
 
+        # Validate timestamp
+        if rule._type == "timestamp":
+            v = value.strip()
+
+            # parse("") will give a valid date but it should not be
+            # considered a valid timestamp
+            if v == "":
+                errors.append("timestamp.empty : {} : {}".format(value, path))
+            else:
+                try:
+                    parse(value)
+                    # If it can be parsed then it is valid
+                except Exception:
+                    errors.append("timestamp.invalid : {} : {}".format(value, path))
+
     def _validate_range(self, max_, min_, max_ex, min_ex, errors, value, path, prefix):
         """
         Validate that value is within range values.

pykwalify/types.py

@@ -3,7 +3,7 @@
 """ pyKwalify - types.py """
 
 # python std lib
-import datetime
+from datetime import datetime
 
 DEFAULT_TYPE = "str"
 
@@ -15,8 +15,8 @@
     "bool": bool,
     "map": dict,
     "seq": list,
-    "timestamp": datetime.datetime,
-    "date": datetime.datetime,
+    "timestamp": datetime,
+    "date": datetime,
     "symbol": str,
     "scalar": None,
     "text": None,
@@ -102,6 +102,14 @@ def is_mapping_alias(alias):
     return alias in mapping_aliases
 
 
+def is_timestamp(obj):
+    """
+    Yaml either have automatically converted it to a datetime object
+    or it is a string that will be validated later.
+    """
+    return isinstance(obj, datetime) or isinstance(obj, str)
+
+
 tt = {
     "str": is_string,
     "int": is_int,
@@ -111,5 +119,6 @@ def is_mapping_alias(alias):
     "text": is_text,
     "any": is_any,
     "enum": is_enum,
-    "none": is_none
+    "none": is_none,
+    "timestamp": is_timestamp,
 }

requirements.txt

@@ -1,2 +1,3 @@
 docopt==0.6.2
 PyYAML==3.11
+python-dateutil==2.4.2

setup.py

@@ -28,6 +28,7 @@
     install_requires=[
         'docopt==0.6.2',
         'PyYAML==3.11',
+        'python-dateutil==2.4.2',
     ],
     classifiers=(
         # 'Development Status :: 1 - Planning',

tests/files/fail/15f.yaml

@@ -0,0 +1,13 @@
+data:
+  d1: ""
+  d2: "1427650980"
+schema:
+  type: map
+  mapping:
+    d1:
+      type: timestamp
+    d2:
+      type: timestamp
+errors:
+  - 'timestamp.empty :  : /d1'
+  - 'timestamp.invalid : 1427650980 : /d2'

tests/files/success/26s.yaml

@@ -0,0 +1,16 @@
+data:
+  d1: "2015-03-29T18:45:00+00:00"
+  d2: "2015-03-29T18:45:00"
+  d3: "2015-03-29T11:45:00 -0700"
+  d4: "2015-03-29"
+schema:
+  type: map
+  mapping:
+    d1:
+      type: timestamp
+    d2:
+      type: timestamp
+    d3:
+      type: timestamp
+    d4:
+      type: timestamp

tests/test_core.py

@@ -247,7 +247,7 @@ def test_multi_file_support(self):
 
             compare(sorted(c.validation_errors), sorted(failing_test[3]), prefix="Wrong validation errors when parsing files : {} : {}".format(failing_test[0], failing_test[1]))
 
-    def testCore(self):
+    def test_core_files(self):
         # These tests should pass with no exception raised
         pass_tests = [
             # Test sequence with only string values
@@ -301,6 +301,8 @@ def testCore(self):
             "24s.yaml",
             # Test that there is no need to specify 'type: seq' or 'type: map'
             "25s.yaml",
+            # Test that the different types of timestamps can be validated
+            "26s.yaml",
         ]
 
         _fail_tests = [
@@ -332,6 +334,8 @@ def testCore(self):
             ("13f.yaml", SchemaError),
             # Test that range validates on 'seq' raise correct error
             ("14f.yaml", SchemaError),
+            # Test timestamps that should throw errors
+            ("15f.yaml", SchemaError),
         ]
 
         for passing_test_file in pass_tests: