1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
---
title: Datetimes (Datetime)
---
Datetime validator parses using the python-dateutil library and
returns a python datetime object.
Example yaml_snippet:
```yaml
date: 2016-10-22
datetime1: 2016-10-22T14:23:12+00:00
datetime2: 2016-10-22T14:23:12Z
datetime3: 20161022T142312Z
```
```python
from strictyaml import Map, Datetime, YAMLValidationError, load, as_document
from collections import OrderedDict
from dateutil.tz.tz import tzutc
from datetime import datetime
from ensure import Ensure
schema = Map({
"date": Datetime(),
"datetime1": Datetime(),
"datetime2": Datetime(),
"datetime3": Datetime(),
})
equivalent_data = OrderedDict([
("date", datetime(2016, 10, 22, 0, 0)),
("datetime1", datetime(2016, 10, 22, 14, 23, 12, tzinfo=tzutc())),
("datetime2", datetime(2016, 10, 22, 14, 23, 12, tzinfo=tzutc())),
("datetime3", datetime(2016, 10, 22, 14, 23, 12, tzinfo=tzutc())),
])
```
Each of the four datetimes are valid and parsed:
```python
Ensure(load(yaml_snippet, schema)).equals(equivalent_data)
```
.text still returns the original text:
```python
Ensure(load(yaml_snippet, schema)["date"].text).equals("2016-10-22")
```
Non datetimes raise an exception:
```yaml
date: 1
datetime1: รข
datetime2: b
datetime3: c
```
```python
load(yaml_snippet, schema)
```
```python
strictyaml.exceptions.YAMLValidationError:
when expecting a datetime
found arbitrary text
in "<unicode string>", line 2, column 1:
datetime1: "\xE2"
^ (line: 2)
```
Datetime objects serialize directly to ISO-8601 format YAML strings:
```python
print(as_document(equivalent_data, schema).as_yaml())
```
```yaml
date: 2016-10-22T00:00:00
datetime1: 2016-10-22T14:23:12+00:00
datetime2: 2016-10-22T14:23:12+00:00
datetime3: 2016-10-22T14:23:12+00:00
```
Valid datetime strings serialize to YAML:
```python
print(as_document({"a": "2016-10-22"}, Map({"a": Datetime()})).as_yaml())
```
```yaml
a: 2016-10-22
```
Serializing invalid datetime string raises exception:
```python
as_document({"a": "x"}, Map({"a": Datetime()}))
```
```python
strictyaml.exceptions.YAMLSerializationError:
expected a datetime, got 'x'
```
Serializing non-string and non-datetime object raises exception:
```python
as_document({"a": 55}, Map({"a": Datetime()}))
```
```python
strictyaml.exceptions.YAMLSerializationError:
expected a datetime, got '55' of type 'int'
```
!!! note "Executable specification"
Documentation automatically generated from
<a href="https://github.com/crdoconnor/strictyaml/blob/master/hitch/story/datetime.story">datetime.story
storytests.
|
