summaryrefslogtreecommitdiff
path: root/_test/test_add_xxx.py
blob: 5b064f73e3f3a0e41ee208e187380d8ef51587d4 (plain)
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
# coding: utf-8

import re
import pytest   # NOQA
import ruamel.yaml

from roundtrip import round_trip, dedent, round_trip_load, round_trip_dump  # NOQA


# from PyYAML docs
class Dice(tuple):
    def __new__(cls, a, b):
        return tuple.__new__(cls, [a, b])

    def __repr__(self):
        return "Dice(%s,%s)" % self


def dice_constructor(loader, node):
    value = loader.construct_scalar(node)
    a, b = map(int, value.split('d'))
    return Dice(a, b)


def dice_representer(dumper, data):
    return dumper.represent_scalar(u'!dice', u'{}d{}'.format(*data))


def test_dice_constructor():
    ruamel.yaml.add_constructor(u'!dice', dice_constructor)
    data = ruamel.yaml.load('initial hit points: !dice 8d4', Loader=ruamel.yaml.Loader)
    assert str(data) == "{'initial hit points': Dice(8,4)}"


def test_dice_constructor_with_loader():
    ruamel.yaml.add_constructor(u'!dice', dice_constructor, Loader=ruamel.yaml.Loader)
    data = ruamel.yaml.load('initial hit points: !dice 8d4', Loader=ruamel.yaml.Loader)
    assert str(data) == "{'initial hit points': Dice(8,4)}"


def test_dice_representer():
    ruamel.yaml.add_representer(Dice, dice_representer)
    # ruamel.yaml 0.15.8+ no longer forces quotes tagged scalars
    assert ruamel.yaml.dump(dict(gold=Dice(10, 6)), default_flow_style=False) == \
        "gold: !dice 10d6\n"


def test_dice_implicit_resolver():
    pattern = re.compile(r'^\d+d\d+$')
    ruamel.yaml.add_implicit_resolver(u'!dice', pattern)
    assert ruamel.yaml.dump(dict(treasure=Dice(10, 20)), default_flow_style=False) == \
        'treasure: 10d20\n'
    assert ruamel.yaml.load('damage: 5d10', Loader=ruamel.yaml.Loader) == \
        dict(damage=Dice(5, 10))


class Obj1(dict):
    def __init__(self, suffix):
        self._suffix = suffix
        self._node = None

    def add_node(self, n):
        self._node = n

    def __repr__(self):
        return 'Obj1(%s->%s)' % (self._suffix, self.items())

    def dump(self):
        return repr(self._node)


class YAMLObj1(object):
    yaml_tag = u'!obj:'

    @classmethod
    def from_yaml(cls, loader, suffix, node):
        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, data):
        return dumper.represent_scalar(cls.yaml_tag + data._suffix, data.dump())


def test_yaml_obj():
    ruamel.yaml.add_representer(Obj1, YAMLObj1.to_yaml)
    ruamel.yaml.add_multi_constructor(YAMLObj1.yaml_tag, YAMLObj1.from_yaml)
    x = ruamel.yaml.load('!obj:x.2\na: 1', Loader=ruamel.yaml.Loader)
    print(x)
    assert ruamel.yaml.dump(x) == '''!obj:x.2 "{'a': 1}"\n'''


def test_yaml_obj_with_loader_and_dumper():
    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 = ruamel.yaml.load('!obj:x.2\na: 1', Loader=ruamel.yaml.Loader)
    # x = ruamel.yaml.load('!obj:x.2\na: 1')
    print(x)
    assert ruamel.yaml.dump(x) == '''!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

class Ref(ruamel.yaml.YAMLObject):
    yaml_constructor = ruamel.yaml.RoundTripConstructor
    yaml_representer = ruamel.yaml.RoundTripRepresenter
    yaml_tag = u'!Ref'

    def __init__(self, logical_id):
        self.logical_id = logical_id

    @classmethod
    def from_yaml(cls, loader, node):
        return cls(loader.construct_scalar(node))

    @classmethod
    def to_yaml(cls, dumper, data):
        if isinstance(data.logical_id, ruamel.yaml.scalarstring.ScalarString):
            style = data.logical_id.style   # ruamel.yaml>0.15.8
        else:
            style = None
        return dumper.represent_scalar(cls.yaml_tag, data.logical_id, style=style)


def test_issue_127():
    document = dedent('''\
    AList:
      - !Ref One
      - !Ref 'Two'
      - !Ref
        Two and a half
    BList: [!Ref Three, !Ref "Four"]
    CList:
      - Five Six
      - 'Seven Eight'
    ''')
    data = ruamel.yaml.round_trip_load(document, preserve_quotes=True)
    assert ruamel.yaml.round_trip_dump(data, indent=4, block_seq_indent=2) == \
        document.replace('\n    Two and', ' Two and')