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
|
# coding: utf-8
import re
import pytest # type: ignore # NOQA
from roundtrip import dedent, round_trip_dump # type: ignore # NOQA
from typing import Any
# from PyYAML docs
class Dice(tuple): # type: ignore
def __new__(cls, a: int, b: int) -> "Dice":
return tuple.__new__(cls, [a, b])
def __repr__(self) -> str:
return 'Dice(%s,%s)' % self
def dice_constructor(loader: Any, node: Any) -> Dice:
value = loader.construct_scalar(node)
a, b = map(int, value.split('d'))
return Dice(a, b)
def dice_representer(dumper: Any, data: Any) -> Any:
return dumper.represent_scalar('!dice', '{}d{}'.format(*data))
def test_dice_constructor() -> None:
import ruamel.yaml # NOQA
yaml = ruamel.yaml.YAML(typ='unsafe', pure=True)
ruamel.yaml.add_constructor('!dice', dice_constructor)
data = yaml.load('initial hit points: !dice 8d4')
assert str(data) == "{'initial hit points': Dice(8,4)}"
def test_dice_constructor_with_loader() -> None:
import ruamel.yaml # NOQA
yaml = ruamel.yaml.YAML(typ='unsafe', pure=True)
ruamel.yaml.add_constructor('!dice', dice_constructor, Loader=ruamel.yaml.Loader)
data = yaml.load('initial hit points: !dice 8d4')
assert str(data) == "{'initial hit points': Dice(8,4)}"
def test_dice_representer() -> None:
import ruamel.yaml # NOQA
yaml = ruamel.yaml.YAML(typ='unsafe', pure=True)
yaml.default_flow_style = False
ruamel.yaml.add_representer(Dice, dice_representer)
# ruamel.yaml 0.15.8+ no longer forces quotes tagged scalars
buf = ruamel.yaml.compat.StringIO()
yaml.dump(dict(gold=Dice(10, 6)), buf)
assert buf.getvalue() == 'gold: !dice 10d6\n'
def test_dice_implicit_resolver() -> None:
import ruamel.yaml # NOQA
yaml = ruamel.yaml.YAML(typ='unsafe', pure=True)
yaml.default_flow_style = False
pattern = re.compile(r'^\d+d\d+$')
ruamel.yaml.add_implicit_resolver('!dice', pattern)
buf = ruamel.yaml.compat.StringIO()
yaml.dump(dict(treasure=Dice(10, 20)), buf)
assert buf.getvalue() == 'treasure: 10d20\n'
assert yaml.load('damage: 5d10') == dict(damage=Dice(5, 10))
class Obj1(dict): # type: ignore
def __init__(self, suffix: Any) -> None:
self._suffix = suffix
self._node = None
def add_node(self, n: Any) -> None:
self._node = n
def __repr__(self) -> str:
return 'Obj1(%s->%s)' % (self._suffix, self.items())
def dump(self) -> str:
return repr(self._node)
class YAMLObj1:
yaml_tag = '!obj:'
@classmethod
def from_yaml(cls, loader: Any, suffix: Any, node: Any) -> Any:
import ruamel.yaml # NOQA
obj1 = Obj1(suffix)
if isinstance(node, ruamel.yaml.MappingNode):
obj1.add_node(loader.construct_mapping(node))
else:
raise NotImplementedError
return obj1
@classmethod
def to_yaml(cls, dumper: Any, data: Any) -> Any:
return dumper.represent_scalar(cls.yaml_tag + data._suffix, data.dump())
def test_yaml_obj() -> None:
import ruamel.yaml # NOQA
yaml = ruamel.yaml.YAML(typ='unsafe', pure=True)
ruamel.yaml.add_representer(Obj1, YAMLObj1.to_yaml)
ruamel.yaml.add_multi_constructor(YAMLObj1.yaml_tag, YAMLObj1.from_yaml)
x = yaml.load('!obj:x.2\na: 1')
print(x)
buf = ruamel.yaml.compat.StringIO()
yaml.dump(x, buf)
assert buf.getvalue() == """!obj:x.2 "{'a': 1}"\n"""
def test_yaml_obj_with_loader_and_dumper() -> None:
import ruamel.yaml # NOQA
yaml = ruamel.yaml.YAML(typ='unsafe', pure=True)
ruamel.yaml.add_representer(Obj1, YAMLObj1.to_yaml, Dumper=ruamel.yaml.Dumper)
ruamel.yaml.add_multi_constructor(
YAMLObj1.yaml_tag, YAMLObj1.from_yaml, Loader=ruamel.yaml.Loader
)
x = yaml.load('!obj:x.2\na: 1')
# x = ruamel.yaml.load('!obj:x.2\na: 1')
print(x)
buf = ruamel.yaml.compat.StringIO()
yaml.dump(x, buf)
assert buf.getvalue() == """!obj:x.2 "{'a': 1}"\n"""
# ToDo use nullege to search add_multi_representer and add_path_resolver
# and add some test code
# Issue 127 reported by Tommy Wang
def test_issue_127() -> None:
import ruamel.yaml # NOQA
class Ref(ruamel.yaml.YAMLObject):
yaml_constructor = ruamel.yaml.RoundTripConstructor # type: ignore
yaml_representer = ruamel.yaml.RoundTripRepresenter # type: ignore
yaml_tag = '!Ref'
def __init__(self, logical_id: Any) -> None:
self.logical_id = logical_id
@classmethod
def from_yaml(cls, loader: Any, node: Any) -> Any:
return cls(loader.construct_scalar(node))
@classmethod
def to_yaml(cls, dumper: Any, data: Any) -> Any:
if isinstance(data.logical_id, ruamel.yaml.scalarstring.ScalarString):
style = data.logical_id.style # type: ignore # ruamel.yaml>0.15.8
else:
style = None
return dumper.represent_scalar(cls.yaml_tag, data.logical_id, style=style)
document = dedent("""\
AList:
- !Ref One
- !Ref 'Two'
- !Ref
Two and a half
BList: [!Ref Three, !Ref "Four"]
CList:
- Five Six
- 'Seven Eight'
""")
yaml = ruamel.yaml.YAML()
yaml.preserve_quotes = True
yaml.default_flow_style = None
yaml.indent(sequence=4, offset=2)
data = yaml.load(document)
buf = ruamel.yaml.compat.StringIO()
yaml.dump(data, buf)
assert buf.getvalue() == document.replace('\n Two and', ' Two and')
|
