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
|
---
title: Parsing comma separated items (CommaSeparated)
---
Comma-separated values can be validated and parsed
using the CommaSeparated validator.
Note that the space following the commas is stripped by
default when parsed.
```python
from strictyaml import CommaSeparated, Int, Str, Map, load, as_document
from ensure import Ensure
int_schema = Map({"a": CommaSeparated(Int())})
str_schema = Map({"a": CommaSeparated(Str())})
```
Parse as int:
```yaml
a: 1, 2, 3
```
```python
Ensure(load(yaml_snippet, int_schema)).equals({"a": [1, 2, 3]})
```
Parse as string:
```yaml
a: 1, 2, 3
```
```python
Ensure(load(yaml_snippet, str_schema)).equals({"a": ["1", "2", "3"]})
```
Parse empty comma separated string:
```yaml
a:
```
```python
Ensure(load(yaml_snippet, str_schema)).equals({"a": []})
```
Invalid int comma separated sequence:
```yaml
a: 1, x, 3
```
```python
load(yaml_snippet, int_schema)
```
```python
strictyaml.exceptions.YAMLValidationError:
when expecting an integer
in "<unicode string>", line 2, column 1:
^ (line: 2)
found arbitrary text
in "<unicode string>", line 1, column 1:
a: 1, x, 3
^ (line: 1)
```
Serialize list to comma separated sequence:
```python
print(as_document({"a": [1, 2, 3]}, int_schema).as_yaml())
```
```yaml
a: 1, 2, 3
```
Serialize valid string to comma separated sequence:
```python
print(as_document({"a": "1,2,3"}, int_schema).as_yaml())
```
```yaml
a: 1,2,3
```
Serialize empty list to comma separated sequence:
```python
print(as_document({"a": []}, int_schema).as_yaml())
```
```yaml
a:
```
Serialize invalid string to comma separated sequence:
```python
print(as_document({"a": "1,x,3"}, int_schema).as_yaml())
```
```python
strictyaml.exceptions.YAMLSerializationError:
'x' not an integer.
```
Attempt to serialize neither list nor string raises exception:
```python
as_document({"a": 1}, int_schema)
```
```python
strictyaml.exceptions.YAMLSerializationError:
expected string or list, got '1' of type 'int'
```
!!! note "Executable specification"
Documentation automatically generated from
<a href="https://github.com/crdoconnor/strictyaml/blob/master/hitch/story/commaseparated.story">commaseparated.story
storytests.
|
