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
|
---
title: Enumerated scalars (Enum)
---
StrictYAML allows you to ensure that a scalar
value can only be one of a set number of items.
It will throw an exception if any strings not
in the list are found.
```python
from strictyaml import Map, Enum, MapPattern, YAMLValidationError, load
from collections import OrderedDict
from ensure import Ensure
schema = Map({"a": Enum(["A", "B", "C"])})
```
Valid because it contains 'A':
```yaml
a: A
```
```python
Ensure(load(yaml_snippet, schema)).equals({"a": "A"})
```
Get .data from enum:
```yaml
a: A
```
```python
assert isinstance(load(yaml_snippet, schema)['a'].data, str)
```
Valid because it contains 'B':
```yaml
a: B
```
```python
Ensure(load(yaml_snippet, schema)).equals({"a": "B"})
```
Valid because it contains 'C':
```yaml
a: C
```
```python
Ensure(load(yaml_snippet, schema)).equals({"a": "C"})
```
Invalid because D is not in enum:
```yaml
a: D
```
```python
load(yaml_snippet, schema)
```
```python
strictyaml.exceptions.YAMLValidationError:
when expecting one of: A, B, C
found arbitrary text
in "<unicode string>", line 1, column 1:
a: D
^ (line: 1)
```
Invalid because blank string is not in enum:
```yaml
a:
```
```python
load(yaml_snippet, schema)
```
```python
strictyaml.exceptions.YAMLValidationError:
when expecting one of: A, B, C
found a blank string
in "<unicode string>", line 1, column 1:
a: ''
^ (line: 1)
```
Successful serialization:
```yaml
a: A
```
```python
yaml = load(yaml_snippet, schema)
yaml['a'] = "B"
print(yaml.as_yaml())
```
```yaml
a: B
```
Invalid serialization:
```yaml
a: A
```
```python
yaml = load(yaml_snippet, schema)
yaml['a'] = "D"
print(yaml.as_yaml())
```
```python
strictyaml.exceptions.YAMLSerializationError:
Got 'D' when expecting one of: A, B, C
```
!!! note "Executable specification"
Documentation automatically generated from
<a href="https://github.com/crdoconnor/strictyaml/blob/master/hitch/story/enum.story">enum.story
storytests.
|
