source: pyyaml/trunk/lib3/yaml/representer.py @ 328

Revision 328, 13.1 KB checked in by xi, 4 years ago (diff)

Added basic support for Python 3 (Thanks idadesub(at)users(dot)sourceforge(dot)net).
Line 
1
2__all__ = ['BaseRepresenter', 'SafeRepresenter', 'Representer',
3    'RepresenterError']
4
5from .error import *
6from .nodes import *
7
8import datetime, sys, copyreg, types, base64
9
10class RepresenterError(YAMLError):
11    pass
12
13class BaseRepresenter:
14
15    yaml_representers = {}
16    yaml_multi_representers = {}
17
18    def __init__(self, default_style=None, default_flow_style=None):
19        self.default_style = default_style
20        self.default_flow_style = default_flow_style
21        self.represented_objects = {}
22        self.object_keeper = []
23        self.alias_key = None
24
25    def represent(self, data):
26        node = self.represent_data(data)
27        self.serialize(node)
28        self.represented_objects = {}
29        self.object_keeper = []
30        self.alias_key = None
31
32    def represent_data(self, data):
33        if self.ignore_aliases(data):
34            self.alias_key = None
35        else:
36            self.alias_key = id(data)
37        if self.alias_key is not None:
38            if self.alias_key in self.represented_objects:
39                node = self.represented_objects[self.alias_key]
40                #if node is None:
41                #    raise RepresenterError("recursive objects are not allowed: %r" % data)
42                return node
43            #self.represented_objects[alias_key] = None
44            self.object_keeper.append(data)
45        data_types = type(data).__mro__
46        if data_types[0] in self.yaml_representers:
47            node = self.yaml_representers[data_types[0]](self, data)
48        else:
49            for data_type in data_types:
50                if data_type in self.yaml_multi_representers:
51                    node = self.yaml_multi_representers[data_type](self, data)
52                    break
53            else:
54                if None in self.yaml_multi_representers:
55                    node = self.yaml_multi_representers[None](self, data)
56                elif None in self.yaml_representers:
57                    node = self.yaml_representers[None](self, data)
58                else:
59                    node = ScalarNode(None, str(data))
60        #if alias_key is not None:
61        #    self.represented_objects[alias_key] = node
62        return node
63
64    @classmethod
65    def add_representer(cls, data_type, representer):
66        if not 'yaml_representers' in cls.__dict__:
67            cls.yaml_representers = cls.yaml_representers.copy()
68        cls.yaml_representers[data_type] = representer
69
70    @classmethod
71    def add_multi_representer(cls, data_type, representer):
72        if not 'yaml_multi_representers' in cls.__dict__:
73            cls.yaml_multi_representers = cls.yaml_multi_representers.copy()
74        cls.yaml_multi_representers[data_type] = representer
75
76    def represent_scalar(self, tag, value, style=None):
77        if style is None:
78            style = self.default_style
79        node = ScalarNode(tag, value, style=style)
80        if self.alias_key is not None:
81            self.represented_objects[self.alias_key] = node
82        return node
83
84    def represent_sequence(self, tag, sequence, flow_style=None):
85        value = []
86        node = SequenceNode(tag, value, flow_style=flow_style)
87        if self.alias_key is not None:
88            self.represented_objects[self.alias_key] = node
89        best_style = True
90        for item in sequence:
91            node_item = self.represent_data(item)
92            if not (isinstance(node_item, ScalarNode) and not node_item.style):
93                best_style = False
94            value.append(node_item)
95        if flow_style is None:
96            if self.default_flow_style is not None:
97                node.flow_style = self.default_flow_style
98            else:
99                node.flow_style = best_style
100        return node
101
102    def represent_mapping(self, tag, mapping, flow_style=None):
103        value = []
104        node = MappingNode(tag, value, flow_style=flow_style)
105        if self.alias_key is not None:
106            self.represented_objects[self.alias_key] = node
107        best_style = True
108        if hasattr(mapping, 'items'):
109            mapping = list(mapping.items())
110            try:
111                mapping = sorted(mapping)
112            except TypeError:
113                pass
114        for item_key, item_value in mapping:
115            node_key = self.represent_data(item_key)
116            node_value = self.represent_data(item_value)
117            if not (isinstance(node_key, ScalarNode) and not node_key.style):
118                best_style = False
119            if not (isinstance(node_value, ScalarNode) and not node_value.style):
120                best_style = False
121            value.append((node_key, node_value))
122        if flow_style is None:
123            if self.default_flow_style is not None:
124                node.flow_style = self.default_flow_style
125            else:
126                node.flow_style = best_style
127        return node
128
129    def ignore_aliases(self, data):
130        return False
131
132class SafeRepresenter(BaseRepresenter):
133
134    def ignore_aliases(self, data):
135        if data in [None, ()]:
136            return True
137        if isinstance(data, (str, bytes, bool, int, float)):
138            return True
139
140    def represent_none(self, data):
141        return self.represent_scalar('tag:yaml.org,2002:null', 'null')
142
143    def represent_str(self, data):
144        return self.represent_scalar('tag:yaml.org,2002:str', data)
145
146    def represent_binary(self, data):
147        data = base64.encodestring(data).decode('ascii')
148        return self.represent_scalar('tag:yaml.org,2002:binary', data, style='|')
149
150    def represent_bool(self, data):
151        if data:
152            value = 'true'
153        else:
154            value = 'false'
155        return self.represent_scalar('tag:yaml.org,2002:bool', value)
156
157    def represent_int(self, data):
158        return self.represent_scalar('tag:yaml.org,2002:int', str(data))
159
160    inf_value = 1e300
161    while repr(inf_value) != repr(inf_value*inf_value):
162        inf_value *= inf_value
163
164    def represent_float(self, data):
165        if data != data or (data == 0.0 and data == 1.0):
166            value = '.nan'
167        elif data == self.inf_value:
168            value = '.inf'
169        elif data == -self.inf_value:
170            value = '-.inf'
171        else:
172            value = repr(data).lower()
173            # Note that in some cases `repr(data)` represents a float number
174            # without the decimal parts.  For instance:
175            #   >>> repr(1e17)
176            #   '1e17'
177            # Unfortunately, this is not a valid float representation according
178            # to the definition of the `!!float` tag.  We fix this by adding
179            # '.0' before the 'e' symbol.
180            if '.' not in value and 'e' in value:
181                value = value.replace('e', '.0e', 1)
182        return self.represent_scalar('tag:yaml.org,2002:float', value)
183
184    def represent_list(self, data):
185        #pairs = (len(data) > 0 and isinstance(data, list))
186        #if pairs:
187        #    for item in data:
188        #        if not isinstance(item, tuple) or len(item) != 2:
189        #            pairs = False
190        #            break
191        #if not pairs:
192            return self.represent_sequence('tag:yaml.org,2002:seq', data)
193        #value = []
194        #for item_key, item_value in data:
195        #    value.append(self.represent_mapping(u'tag:yaml.org,2002:map',
196        #        [(item_key, item_value)]))
197        #return SequenceNode(u'tag:yaml.org,2002:pairs', value)
198
199    def represent_dict(self, data):
200        return self.represent_mapping('tag:yaml.org,2002:map', data)
201
202    def represent_set(self, data):
203        value = {}
204        for key in data:
205            value[key] = None
206        return self.represent_mapping('tag:yaml.org,2002:set', value)
207
208    def represent_date(self, data):
209        value = data.isoformat()
210        return self.represent_scalar('tag:yaml.org,2002:timestamp', value)
211
212    def represent_datetime(self, data):
213        value = data.isoformat(' ')
214        return self.represent_scalar('tag:yaml.org,2002:timestamp', value)
215
216    def represent_yaml_object(self, tag, data, cls, flow_style=None):
217        if hasattr(data, '__getstate__'):
218            state = data.__getstate__()
219        else:
220            state = data.__dict__.copy()
221        return self.represent_mapping(tag, state, flow_style=flow_style)
222
223    def represent_undefined(self, data):
224        raise RepresenterError("cannot represent an object: %s" % data)
225
226SafeRepresenter.add_representer(type(None),
227        SafeRepresenter.represent_none)
228
229SafeRepresenter.add_representer(str,
230        SafeRepresenter.represent_str)
231
232SafeRepresenter.add_representer(bytes,
233        SafeRepresenter.represent_binary)
234
235SafeRepresenter.add_representer(bool,
236        SafeRepresenter.represent_bool)
237
238SafeRepresenter.add_representer(int,
239        SafeRepresenter.represent_int)
240
241SafeRepresenter.add_representer(float,
242        SafeRepresenter.represent_float)
243
244SafeRepresenter.add_representer(list,
245        SafeRepresenter.represent_list)
246
247SafeRepresenter.add_representer(tuple,
248        SafeRepresenter.represent_list)
249
250SafeRepresenter.add_representer(dict,
251        SafeRepresenter.represent_dict)
252
253SafeRepresenter.add_representer(set,
254        SafeRepresenter.represent_set)
255
256SafeRepresenter.add_representer(datetime.date,
257        SafeRepresenter.represent_date)
258
259SafeRepresenter.add_representer(datetime.datetime,
260        SafeRepresenter.represent_datetime)
261
262SafeRepresenter.add_representer(None,
263        SafeRepresenter.represent_undefined)
264
265class Representer(SafeRepresenter):
266
267    def represent_complex(self, data):
268        if data.imag == 0.0:
269            data = '%r' % data.real
270        elif data.real == 0.0:
271            data = '%rj' % data.imag
272        elif data.imag > 0:
273            data = '%r+%rj' % (data.real, data.imag)
274        else:
275            data = '%r%rj' % (data.real, data.imag)
276        return self.represent_scalar('tag:yaml.org,2002:python/complex', data)
277
278    def represent_tuple(self, data):
279        return self.represent_sequence('tag:yaml.org,2002:python/tuple', data)
280
281    def represent_name(self, data):
282        name = '%s.%s' % (data.__module__, data.__name__)
283        return self.represent_scalar('tag:yaml.org,2002:python/name:'+name, '')
284
285    def represent_module(self, data):
286        return self.represent_scalar(
287                'tag:yaml.org,2002:python/module:'+data.__name__, '')
288
289    def represent_object(self, data):
290        # We use __reduce__ API to save the data. data.__reduce__ returns
291        # a tuple of length 2-5:
292        #   (function, args, state, listitems, dictitems)
293
294        # For reconstructing, we calls function(*args), then set its state,
295        # listitems, and dictitems if they are not None.
296
297        # A special case is when function.__name__ == '__newobj__'. In this
298        # case we create the object with args[0].__new__(*args).
299
300        # Another special case is when __reduce__ returns a string - we don't
301        # support it.
302
303        # We produce a !!python/object, !!python/object/new or
304        # !!python/object/apply node.
305
306        cls = type(data)
307        if cls in copyreg.dispatch_table:
308            reduce = copyreg.dispatch_table[cls](data)
309        elif hasattr(data, '__reduce_ex__'):
310            reduce = data.__reduce_ex__(2)
311        elif hasattr(data, '__reduce__'):
312            reduce = data.__reduce__()
313        else:
314            raise RepresenterError("cannot represent object: %r" % data)
315        reduce = (list(reduce)+[None]*5)[:5]
316        function, args, state, listitems, dictitems = reduce
317        args = list(args)
318        if state is None:
319            state = {}
320        if listitems is not None:
321            listitems = list(listitems)
322        if dictitems is not None:
323            dictitems = dict(dictitems)
324        if function.__name__ == '__newobj__':
325            function = args[0]
326            args = args[1:]
327            tag = 'tag:yaml.org,2002:python/object/new:'
328            newobj = True
329        else:
330            tag = 'tag:yaml.org,2002:python/object/apply:'
331            newobj = False
332        function_name = '%s.%s' % (function.__module__, function.__name__)
333        if not args and not listitems and not dictitems \
334                and isinstance(state, dict) and newobj:
335            return self.represent_mapping(
336                    'tag:yaml.org,2002:python/object:'+function_name, state)
337        if not listitems and not dictitems  \
338                and isinstance(state, dict) and not state:
339            return self.represent_sequence(tag+function_name, args)
340        value = {}
341        if args:
342            value['args'] = args
343        if state or not isinstance(state, dict):
344            value['state'] = state
345        if listitems:
346            value['listitems'] = listitems
347        if dictitems:
348            value['dictitems'] = dictitems
349        return self.represent_mapping(tag+function_name, value)
350
351Representer.add_representer(complex,
352        Representer.represent_complex)
353
354Representer.add_representer(tuple,
355        Representer.represent_tuple)
356
357Representer.add_representer(type,
358        Representer.represent_name)
359
360Representer.add_representer(types.FunctionType,
361        Representer.represent_name)
362
363Representer.add_representer(types.BuiltinFunctionType,
364        Representer.represent_name)
365
366Representer.add_representer(types.ModuleType,
367        Representer.represent_module)
368
369Representer.add_multi_representer(object,
370        Representer.represent_object)
371
Note: See TracBrowser for help on using the repository browser.