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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
---
title: Mappings with defined keys (Map)
---
Mappings of one value to another are represented by : in YAML
and parsed as python dicts.
Using StrictYAML's 'Map' you can validate that a mapping
contains the right keys and the right *type* of values.
Note: for mappings where you don't know the exact names of
the keys in advance but you do know the type, use MapPattern.
Example yaml_snippet:
```yaml
â: 1
b: 2
c: 3
```
```python
from collections import OrderedDict
from strictyaml import Map, Int, load, as_document
from collections import OrderedDict
from ensure import Ensure
schema = Map({"a": Int(), "b": Int(), "c": Int()})
schema_2 = Map({u"â": Int(), "b": Int(), "c": Int()})
```
one key mapping:
```yaml
x: 1
```
```python
Ensure(load(yaml_snippet, Map({"x": Int()})).data).equals(OrderedDict([('x', 1)]))
```
key value:
```python
Ensure(load(yaml_snippet, schema_2)[u'â']).equals(1)
```
get item key not found:
```python
load(yaml_snippet, schema_2)['keynotfound']
```
```python
:
'keynotfound'
```
cannot use .text:
```python
load(yaml_snippet, schema_2).text
```
```python
builtins.TypeError:YAML({'â': 1, 'b': 2, 'c': 3}) is a mapping, has no text value.:
```
parse snippet where key is not found in schema:
```yaml
a: 1
b: 2
â: 3
```
```python
load(yaml_snippet, schema)
```
```python
strictyaml.exceptions.YAMLValidationError:
while parsing a mapping
unexpected key not in schema 'â'
in "<unicode string>", line 3, column 1:
"\xE2": '3'
^ (line: 3)
```
sequence not expected when parsing:
```yaml
- 1
- 2
- 3
```
```python
load(yaml_snippet, schema)
```
```python
strictyaml.exceptions.YAMLValidationError:
when expecting a mapping
in "<unicode string>", line 1, column 1:
- '1'
^ (line: 1)
found a sequence
in "<unicode string>", line 3, column 1:
- '3'
^ (line: 3)
```
List not expected when serializing:
```python
as_document([1, 2, 3], schema)
```
```python
strictyaml.exceptions.YAMLSerializationError:
Expected a dict, found '[1, 2, 3]'
```
Empty dict not valid when serializing:
```python
as_document({}, schema)
```
```python
strictyaml.exceptions.YAMLSerializationError:
Expected a non-empty dict, found an empty dict.
Use EmptyDict validator to serialize empty dicts.
```
Unexpected key:
```yaml
a: 1
b: 2
c: 3
d: 4
```
```python
load(yaml_snippet, schema)
```
```python
strictyaml.exceptions.YAMLValidationError:
while parsing a mapping
unexpected key not in schema 'd'
in "<unicode string>", line 4, column 1:
d: '4'
^ (line: 4)
```
required key not found:
```yaml
a: 1
```
```python
load(yaml_snippet, schema)
```
```python
strictyaml.exceptions.YAMLValidationError:
while parsing a mapping
required key(s) 'b', 'c' not found
in "<unicode string>", line 1, column 1:
a: '1'
^ (line: 1)
```
iterator:
```yaml
a: 1
b: 2
c: 3
```
```python
assert [item for item in load(yaml_snippet, schema)] == ["a", "b", "c"]
```
serialize:
```python
assert as_document(OrderedDict([(u"â", 1), ("b", 2), ("c", 3)]), schema_2).as_yaml() == yaml_snippet
```
!!! note "Executable specification"
Documentation automatically generated from
<a href="https://github.com/crdoconnor/strictyaml/blob/master/hitch/story/map.story">map.story
storytests.
|
