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
|
---
title: Mappings combining defined and undefined keys (MapCombined)
---
!!! warning "Experimental"
This feature is in alpha. The API may change on a minor version increment.
When you wish to support arbitrary optional keys in
some mappings (i.e. to specify some required keys in
the schema, but allow any additional ones on top of
that), you use a MapCombined.
See https://github.com/crdoconnor/strictyaml/issues/148#issuecomment-861007657
```python
from strictyaml import Any, Int, MapCombined, Optional, Str, load
from ensure import Ensure
schema = MapCombined(
{
"required": Str(),
Optional("foo"): Int(),
},
Str(),
Any(),
)
```
Optional is present:
```yaml
required: Hello World
foo: 42
bar: 42
```
```python
Ensure(load(yaml_snippet, schema).data).equals(
{
"required": "Hello World",
"foo": 42,
"bar": "42",
}
)
```
Optional is absent:
```yaml
required: Hello World
bar: 42
```
```python
Ensure(load(yaml_snippet, schema).data).equals(
{
"required": "Hello World",
"bar": "42",
}
)
```
Multiple undefined:
```yaml
required: Hello World
bar: 42
baz: forty two
```
```python
Ensure(load(yaml_snippet, schema).data).equals(
{
"required": "Hello World",
"bar": "42",
"baz": "forty two",
}
)
```
Required is absent:
```yaml
bar: 42
```
```python
load(yaml_snippet, schema)
```
```python
strictyaml.exceptions.YAMLValidationError:
while parsing a mapping
required key(s) 'required' not found
in "<unicode string>", line 1, column 1:
bar: '42'
^ (line: 1)
```
Undefined of invalid type:
```yaml
required: Hello World
bar: forty two
```
```python
load(yaml_snippet, schema)
```
```python
strictyaml.exceptions.YAMLValidationError:
when expecting an integer
found arbitrary text
in "<unicode string>", line 2, column 1:
bar: forty two
^ (line: 2)
```
Invalid key type:
```yaml
1: Hello World
not_an_integer: 42
```
```python
load(yaml_snippet, schema)
```
```python
strictyaml.exceptions.YAMLValidationError:
when expecting an integer
found arbitrary text
in "<unicode string>", line 2, column 1:
not_an_integer: '42'
^ (line: 2)
```
!!! note "Executable specification"
Documentation automatically generated from
<a href="https://github.com/crdoconnor/strictyaml/blob/master/hitch/story/map-combined.story">map-combined.story
storytests.
|
