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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
|
# coding: utf-8
from __future__ import print_function
import pytest # NOQA
from roundtrip import round_trip, dedent, round_trip_load, round_trip_dump # NOQA
def load(s):
return round_trip_load(dedent(s))
def compare(data, s):
assert round_trip_dump(data) == dedent(s)
# @pytest.mark.xfail
class TestCommentsManipulation:
# list
def test_seq_set_comment_on_existing_explicit_column(self):
data = load("""
- a # comment 1
- b
- c
""")
data.yaml_add_eol_comment('comment 2', key=1, column=6)
compare(data, """
- a # comment 1
- b # comment 2
- c
""")
def test_seq_overwrite_comment_on_existing_explicit_column(self):
data = load("""
- a # comment 1
- b
- c
""")
data.yaml_add_eol_comment('comment 2', key=0, column=6)
compare(data, """
- a # comment 2
- b
- c
""")
def test_seq_first_comment_explicit_column(self):
data = load("""
- a
- b
- c
""")
data.yaml_add_eol_comment('comment 1', key=1, column=6)
compare(data, """
- a
- b # comment 1
- c
""")
def test_seq_set_comment_on_existing_column_prev(self):
data = load("""
- a # comment 1
- b
- c
- d # comment 3
""")
data.yaml_add_eol_comment('comment 2', key=1)
compare(data, """
- a # comment 1
- b # comment 2
- c
- d # comment 3
""")
def test_seq_set_comment_on_existing_column_next(self):
data = load("""
- a # comment 1
- b
- c
- d # comment 3
""")
print(data._yaml_comment)
# print(type(data._yaml_comment._items[0][0].start_mark))
# ruamel.yaml.error.Mark
# print(type(data._yaml_comment._items[0][0].start_mark))
data.yaml_add_eol_comment('comment 2', key=2)
compare(data, """
- a # comment 1
- b
- c # comment 2
- d # comment 3
""")
def test_seq_set_comment_on_existing_column_further_away(self):
"""
no comment line before or after, take the latest before
the new position
"""
data = load("""
- a # comment 1
- b
- c
- d
- e
- f # comment 3
""")
print(data._yaml_comment)
# print(type(data._yaml_comment._items[0][0].start_mark))
# ruamel.yaml.error.Mark
# print(type(data._yaml_comment._items[0][0].start_mark))
data.yaml_add_eol_comment('comment 2', key=3)
compare(data, """
- a # comment 1
- b
- c
- d # comment 2
- e
- f # comment 3
""")
def test_seq_set_comment_on_existing_explicit_column_with_hash(self):
data = load("""
- a # comment 1
- b
- c
""")
data.yaml_add_eol_comment('# comment 2', key=1, column=6)
compare(data, """
- a # comment 1
- b # comment 2
- c
""")
# dict
def test_dict_set_comment_on_existing_explicit_column(self):
data = load("""
a: 1 # comment 1
b: 2
c: 3
d: 4
e: 5
""")
data.yaml_add_eol_comment('comment 2', key='c', column=7)
compare(data, """
a: 1 # comment 1
b: 2
c: 3 # comment 2
d: 4
e: 5
""")
def test_dict_overwrite_comment_on_existing_explicit_column(self):
data = load("""
a: 1 # comment 1
b: 2
c: 3
d: 4
e: 5
""")
data.yaml_add_eol_comment('comment 2', key='a', column=7)
compare(data, """
a: 1 # comment 2
b: 2
c: 3
d: 4
e: 5
""")
def test_map_set_comment_on_existing_column_prev(self):
data = load("""
a: 1 # comment 1
b: 2
c: 3
d: 4
e: 5 # comment 3
""")
data.yaml_add_eol_comment('comment 2', key='b')
compare(data, """
a: 1 # comment 1
b: 2 # comment 2
c: 3
d: 4
e: 5 # comment 3
""")
def test_map_set_comment_on_existing_column_next(self):
data = load("""
a: 1 # comment 1
b: 2
c: 3
d: 4
e: 5 # comment 3
""")
data.yaml_add_eol_comment('comment 2', key='d')
compare(data, """
a: 1 # comment 1
b: 2
c: 3
d: 4 # comment 2
e: 5 # comment 3
""")
def test_map_set_comment_on_existing_column_further_away(self):
"""
no comment line before or after, take the latest before
the new position
"""
data = load("""
a: 1 # comment 1
b: 2
c: 3
d: 4
e: 5 # comment 3
""")
data.yaml_add_eol_comment('comment 2', key='c')
print(round_trip_dump(data))
compare(data, """
a: 1 # comment 1
b: 2
c: 3 # comment 2
d: 4
e: 5 # comment 3
""")
# the ugly {comment} in the following is because
# py.test cannot handle comments in strings properly
# https://bitbucket.org/pytest-dev/pytest/issue/752/internalerror-indexerror-list-index-out-of
# @pytest.mark.xfail
def test_before_top_map_rt(self):
data = load("""
a: 1
b: 2
""")
data.yaml_set_start_comment('Hello\nWorld\n')
compare(data, """
{comment} Hello
{comment} World
a: 1
b: 2
""".format(comment='#'))
def test_before_top_map_replace(self):
data = load("""
# abc
# def
a: 1 # 1
b: 2
""")
data.yaml_set_start_comment('Hello\nWorld\n')
compare(data, """
{comment} Hello
{comment} World
a: 1 # 1
b: 2
""".format(comment='#'))
def test_before_top_map_from_scratch(self):
from ruamel.yaml.comments import CommentedMap
data = CommentedMap()
data['a'] = 1
data['b'] = 2
data.yaml_set_start_comment('Hello\nWorld\n')
# print(data.ca)
# print(data.ca._items)
compare(data, """
{comment} Hello
{comment} World
a: 1
b: 2
""".format(comment='#'))
def test_before_top_seq_rt(self):
data = load("""
- a
- b
""")
data.yaml_set_start_comment('Hello\nWorld\n')
print(round_trip_dump(data))
compare(data, """
# Hello
# World
- a
- b
""")
def test_before_top_seq_rt_replace(self):
data = load("""
{comment} this
{comment} that
- a
- b
""".format(comment='#'))
data.yaml_set_start_comment('Hello\nWorld\n')
print(round_trip_dump(data))
compare(data, """
{comment} Hello
{comment} World
- a
- b
""".format(comment='#'))
def test_before_top_seq_from_scratch(self):
from ruamel.yaml.comments import CommentedSeq
data = CommentedSeq()
data.append('a')
data.append('b')
data.yaml_set_start_comment('Hello\nWorld\n')
print(round_trip_dump(data))
compare(data, """
{comment} Hello
{comment} World
- a
- b
""".format(comment='#'))
# nested variants
def test_before_nested_map_rt(self):
data = load("""
a: 1
b:
c: 2
d: 3
""")
data['b'].yaml_set_start_comment('Hello\nWorld\n')
compare(data, """
a: 1
b:
{comment} Hello
{comment} World
c: 2
d: 3
""".format(comment='#'))
def test_before_nested_map_rt_indent(self):
data = load("""
a: 1
b:
c: 2
d: 3
""")
data['b'].yaml_set_start_comment('Hello\nWorld\n', indent=2)
compare(data, """
a: 1
b:
{comment} Hello
{comment} World
c: 2
d: 3
""".format(comment='#'))
print(data['b'].ca)
def test_before_nested_map_from_scratch(self):
from ruamel.yaml.comments import CommentedMap
data = CommentedMap()
datab = CommentedMap()
data['a'] = 1
data['b'] = datab
datab['c'] = 2
datab['d'] = 3
data['b'].yaml_set_start_comment('Hello\nWorld\n')
compare(data, """
a: 1
b:
{comment} Hello
{comment} World
c: 2
d: 3
""".format(comment='#'))
def test_before_nested_seq_from_scratch(self):
from ruamel.yaml.comments import CommentedMap, CommentedSeq
data = CommentedMap()
datab = CommentedSeq()
data['a'] = 1
data['b'] = datab
datab.append('c')
datab.append('d')
data['b'].yaml_set_start_comment('Hello\nWorld\n', indent=2)
compare(data, """
a: 1
b:
{comment} Hello
{comment} World
- c
- d
""".format(comment='#'))
|
