source: pyyaml/trunk/lib/yaml/representer.py @ 235

Revision 235, 16.8 KB checked in by xi, 7 years ago (diff)

Use the types module instead of constructing type objects by hand. Fix #41. Thanks to v.haisman@… for the patch.

Line 
1
2__all__ = ['BaseRepresenter', 'SafeRepresenter', 'Representer',
3    'RepresenterError']
4
5from error import *
6from nodes import *
7
8import datetime
9
10try:
11    set
12except NameError:
13    from sets import Set as set
14
15import sys, copy_reg, types
16
17class RepresenterError(YAMLError):
18    pass
19
20class BaseRepresenter(object):
21
22    yaml_representers = {}
23    yaml_multi_representers = {}
24
25    def __init__(self, default_style=None, default_flow_style=None):
26        self.default_style = default_style
27        self.default_flow_style = default_flow_style
28        self.represented_objects = {}
29        self.object_keeper = []
30        self.alias_key = None
31
32    def represent(self, data):
33        node = self.represent_data(data)
34        self.serialize(node)
35        self.represented_objects = {}
36        self.object_keeper = []
37        self.alias_key = None
38
39    def get_classobj_bases(self, cls):
40        bases = [cls]
41        for base in cls.__bases__:
42            bases.extend(self.get_classobj_bases(base))
43        return bases
44
45    def represent_data(self, data):
46        if self.ignore_aliases(data):
47            self.alias_key = None
48        else:
49            self.alias_key = id(data)
50        if self.alias_key is not None:
51            if self.alias_key in self.represented_objects:
52                node = self.represented_objects[self.alias_key]
53                #if node is None:
54                #    raise RepresenterError("recursive objects are not allowed: %r" % data)
55                return node
56            #self.represented_objects[alias_key] = None
57            self.object_keeper.append(data)
58        data_types = type(data).__mro__
59        if type(data) is types.InstanceType:
60            data_types = self.get_classobj_bases(data.__class__)+list(data_types)
61        if data_types[0] in self.yaml_representers:
62            node = self.yaml_representers[data_types[0]](self, data)
63        else:
64            for data_type in data_types:
65                if data_type in self.yaml_multi_representers:
66                    node = self.yaml_multi_representers[data_type](self, data)
67                    break
68            else:
69                if None in self.yaml_multi_representers:
70                    node = self.yaml_multi_representers[None](self, data)
71                elif None in self.yaml_representers:
72                    node = self.yaml_representers[None](self, data)
73                else:
74                    node = ScalarNode(None, unicode(data))
75        #if alias_key is not None:
76        #    self.represented_objects[alias_key] = node
77        return node
78
79    def add_representer(cls, data_type, representer):
80        if not 'yaml_representers' in cls.__dict__:
81            cls.yaml_representers = cls.yaml_representers.copy()
82        cls.yaml_representers[data_type] = representer
83    add_representer = classmethod(add_representer)
84
85    def add_multi_representer(cls, data_type, representer):
86        if not 'yaml_multi_representers' in cls.__dict__:
87            cls.yaml_multi_representers = cls.yaml_multi_representers.copy()
88        cls.yaml_multi_representers[data_type] = representer
89    add_multi_representer = classmethod(add_multi_representer)
90
91    def represent_scalar(self, tag, value, style=None):
92        if style is None:
93            style = self.default_style
94        node = ScalarNode(tag, value, style=style)
95        if self.alias_key is not None:
96            self.represented_objects[self.alias_key] = node
97        return node
98
99    def represent_sequence(self, tag, sequence, flow_style=None):
100        value = []
101        node = SequenceNode(tag, value, flow_style=flow_style)
102        if self.alias_key is not None:
103            self.represented_objects[self.alias_key] = node
104        best_style = True
105        for item in sequence:
106            node_item = self.represent_data(item)
107            if not (isinstance(node_item, ScalarNode) and not node_item.style):
108                best_style = False
109            value.append(node_item)
110        if flow_style is None:
111            if self.default_flow_style is not None:
112                node.flow_style = self.default_flow_style
113            else:
114                node.flow_style = best_style
115        return node
116
117    def represent_mapping(self, tag, mapping, flow_style=None):
118        value = []
119        node = MappingNode(tag, value, flow_style=flow_style)
120        if self.alias_key is not None:
121            self.represented_objects[self.alias_key] = node
122        best_style = True
123        if hasattr(mapping, 'items'):
124            mapping = mapping.items()
125            mapping.sort()
126        for item_key, item_value in mapping:
127            node_key = self.represent_data(item_key)
128            node_value = self.represent_data(item_value)
129            if not (isinstance(node_key, ScalarNode) and not node_key.style):
130                best_style = False
131            if not (isinstance(node_value, ScalarNode) and not node_value.style):
132                best_style = False
133            value.append((node_key, node_value))
134        if flow_style is None:
135            if self.default_flow_style is not None:
136                node.flow_style = self.default_flow_style
137            else:
138                node.flow_style = best_style
139        return node
140
141    def ignore_aliases(self, data):
142        return False
143
144class SafeRepresenter(BaseRepresenter):
145
146    def ignore_aliases(self, data):
147        if data in [None, ()]:
148            return True
149        if isinstance(data, (str, unicode, bool, int, float)):
150            return True
151
152    def represent_none(self, data):
153        return self.represent_scalar(u'tag:yaml.org,2002:null',
154                u'null')
155
156    def represent_str(self, data):
157        tag = None
158        style = None
159        try:
160            data = unicode(data, 'ascii')
161            tag = u'tag:yaml.org,2002:str'
162        except UnicodeDecodeError:
163            try:
164                data = unicode(data, 'utf-8')
165                tag = u'tag:yaml.org,2002:str'
166            except UnicodeDecodeError:
167                data = data.encode('base64')
168                tag = u'tag:yaml.org,2002:binary'
169                style = '|'
170        return self.represent_scalar(tag, data, style=style)
171
172    def represent_unicode(self, data):
173        return self.represent_scalar(u'tag:yaml.org,2002:str', data)
174
175    def represent_bool(self, data):
176        if data:
177            value = u'true'
178        else:
179            value = u'false'
180        return self.represent_scalar(u'tag:yaml.org,2002:bool', value)
181
182    def represent_int(self, data):
183        return self.represent_scalar(u'tag:yaml.org,2002:int', unicode(data))
184
185    def represent_long(self, data):
186        return self.represent_scalar(u'tag:yaml.org,2002:int', unicode(data))
187
188    inf_value = 1e300
189    while repr(inf_value) != repr(inf_value*inf_value):
190        inf_value *= inf_value
191
192    def represent_float(self, data):
193        if data != data or (data == 0.0 and data == 1.0):
194            value = u'.nan'
195        elif data == self.inf_value:
196            value = u'.inf'
197        elif data == -self.inf_value:
198            value = u'-.inf'
199        else:
200            value = unicode(repr(data))
201        return self.represent_scalar(u'tag:yaml.org,2002:float', value)
202
203    def represent_list(self, data):
204        #pairs = (len(data) > 0 and isinstance(data, list))
205        #if pairs:
206        #    for item in data:
207        #        if not isinstance(item, tuple) or len(item) != 2:
208        #            pairs = False
209        #            break
210        #if not pairs:
211            return self.represent_sequence(u'tag:yaml.org,2002:seq', data)
212        #value = []
213        #for item_key, item_value in data:
214        #    value.append(self.represent_mapping(u'tag:yaml.org,2002:map',
215        #        [(item_key, item_value)]))
216        #return SequenceNode(u'tag:yaml.org,2002:pairs', value)
217
218    def represent_dict(self, data):
219        return self.represent_mapping(u'tag:yaml.org,2002:map', data)
220
221    def represent_set(self, data):
222        value = {}
223        for key in data:
224            value[key] = None
225        return self.represent_mapping(u'tag:yaml.org,2002:set', value)
226
227    def represent_date(self, data):
228        value = unicode(data.isoformat())
229        return self.represent_scalar(u'tag:yaml.org,2002:timestamp', value)
230
231    def represent_datetime(self, data):
232        value = unicode(data.isoformat(' '))
233        return self.represent_scalar(u'tag:yaml.org,2002:timestamp', value)
234
235    def represent_yaml_object(self, tag, data, cls, flow_style=None):
236        if hasattr(data, '__getstate__'):
237            state = data.__getstate__()
238        else:
239            state = data.__dict__.copy()
240        return self.represent_mapping(tag, state, flow_style=flow_style)
241
242    def represent_undefined(self, data):
243        raise RepresenterError("cannot represent an object: %s" % data)
244
245SafeRepresenter.add_representer(type(None),
246        SafeRepresenter.represent_none)
247
248SafeRepresenter.add_representer(str,
249        SafeRepresenter.represent_str)
250
251SafeRepresenter.add_representer(unicode,
252        SafeRepresenter.represent_unicode)
253
254SafeRepresenter.add_representer(bool,
255        SafeRepresenter.represent_bool)
256
257SafeRepresenter.add_representer(int,
258        SafeRepresenter.represent_int)
259
260SafeRepresenter.add_representer(long,
261        SafeRepresenter.represent_long)
262
263SafeRepresenter.add_representer(float,
264        SafeRepresenter.represent_float)
265
266SafeRepresenter.add_representer(list,
267        SafeRepresenter.represent_list)
268
269SafeRepresenter.add_representer(tuple,
270        SafeRepresenter.represent_list)
271
272SafeRepresenter.add_representer(dict,
273        SafeRepresenter.represent_dict)
274
275SafeRepresenter.add_representer(set,
276        SafeRepresenter.represent_set)
277
278SafeRepresenter.add_representer(datetime.date,
279        SafeRepresenter.represent_date)
280SafeRepresenter.add_representer(datetime.datetime,
281        SafeRepresenter.represent_datetime)
282
283SafeRepresenter.add_representer(None,
284        SafeRepresenter.represent_undefined)
285
286class Representer(SafeRepresenter):
287
288    def represent_str(self, data):
289        tag = None
290        style = None
291        try:
292            data = unicode(data, 'ascii')
293            tag = u'tag:yaml.org,2002:str'
294        except UnicodeDecodeError:
295            try:
296                data = unicode(data, 'utf-8')
297                tag = u'tag:yaml.org,2002:python/str'
298            except UnicodeDecodeError:
299                data = data.encode('base64')
300                tag = u'tag:yaml.org,2002:binary'
301                style = '|'
302        return self.represent_scalar(tag, data, style=style)
303
304    def represent_unicode(self, data):
305        tag = None
306        try:
307            data.encode('ascii')
308            tag = u'tag:yaml.org,2002:python/unicode'
309        except UnicodeEncodeError:
310            tag = u'tag:yaml.org,2002:str'
311        return self.represent_scalar(tag, data)
312
313    def represent_long(self, data):
314        tag = u'tag:yaml.org,2002:int'
315        if int(data) is not data:
316            tag = u'tag:yaml.org,2002:python/long'
317        return self.represent_scalar(tag, unicode(data))
318
319    def represent_complex(self, data):
320        if data.imag == 0.0:
321            data = u'%r' % data.real
322        elif data.real == 0.0:
323            data = u'%rj' % data.imag
324        elif data.imag > 0:
325            data = u'%r+%rj' % (data.real, data.imag)
326        else:
327            data = u'%r%rj' % (data.real, data.imag)
328        return self.represent_scalar(u'tag:yaml.org,2002:python/complex', data)
329
330    def represent_tuple(self, data):
331        return self.represent_sequence(u'tag:yaml.org,2002:python/tuple', data)
332
333    def represent_name(self, data):
334        name = u'%s.%s' % (data.__module__, data.__name__)
335        return self.represent_scalar(u'tag:yaml.org,2002:python/name:'+name, u'')
336
337    def represent_module(self, data):
338        return self.represent_scalar(
339                u'tag:yaml.org,2002:python/module:'+data.__name__, u'')
340
341    def represent_instance(self, data):
342        # For instances of classic classes, we use __getinitargs__ and
343        # __getstate__ to serialize the data.
344
345        # If data.__getinitargs__ exists, the object must be reconstructed by
346        # calling cls(**args), where args is a tuple returned by
347        # __getinitargs__. Otherwise, the cls.__init__ method should never be
348        # called and the class instance is created by instantiating a trivial
349        # class and assigning to the instance's __class__ variable.
350
351        # If data.__getstate__ exists, it returns the state of the object.
352        # Otherwise, the state of the object is data.__dict__.
353
354        # We produce either a !!python/object or !!python/object/new node.
355        # If data.__getinitargs__ does not exist and state is a dictionary, we
356        # produce a !!python/object node . Otherwise we produce a
357        # !!python/object/new node.
358
359        cls = data.__class__
360        class_name = u'%s.%s' % (cls.__module__, cls.__name__)
361        args = None
362        state = None
363        if hasattr(data, '__getinitargs__'):
364            args = list(data.__getinitargs__())
365        if hasattr(data, '__getstate__'):
366            state = data.__getstate__()
367        else:
368            state = data.__dict__
369        if args is None and isinstance(state, dict):
370            return self.represent_mapping(
371                    u'tag:yaml.org,2002:python/object:'+class_name, state)
372        if isinstance(state, dict) and not state:
373            return self.represent_sequence(
374                    u'tag:yaml.org,2002:python/object/new:'+class_name, args)
375        value = {}
376        if args:
377            value['args'] = args
378        value['state'] = state
379        return self.represent_mapping(
380                u'tag:yaml.org,2002:python/object/new:'+class_name, value)
381
382    def represent_object(self, data):
383        # We use __reduce__ API to save the data. data.__reduce__ returns
384        # a tuple of length 2-5:
385        #   (function, args, state, listitems, dictitems)
386
387        # For reconstructing, we calls function(*args), then set its state,
388        # listitems, and dictitems if they are not None.
389
390        # A special case is when function.__name__ == '__newobj__'. In this
391        # case we create the object with args[0].__new__(*args).
392
393        # Another special case is when __reduce__ returns a string - we don't
394        # support it.
395
396        # We produce a !!python/object, !!python/object/new or
397        # !!python/object/apply node.
398
399        cls = type(data)
400        if cls in copy_reg.dispatch_table:
401            reduce = copy_reg.dispatch_table[cls](data)
402        elif hasattr(data, '__reduce_ex__'):
403            reduce = data.__reduce_ex__(2)
404        elif hasattr(data, '__reduce__'):
405            reduce = data.__reduce__()
406        else:
407            raise RepresenterError("cannot represent object: %r" % data)
408        reduce = (list(reduce)+[None]*5)[:5]
409        function, args, state, listitems, dictitems = reduce
410        args = list(args)
411        if state is None:
412            state = {}
413        if listitems is not None:
414            listitems = list(listitems)
415        if dictitems is not None:
416            dictitems = dict(dictitems)
417        if function.__name__ == '__newobj__':
418            function = args[0]
419            args = args[1:]
420            tag = u'tag:yaml.org,2002:python/object/new:'
421            newobj = True
422        else:
423            tag = u'tag:yaml.org,2002:python/object/apply:'
424            newobj = False
425        function_name = u'%s.%s' % (function.__module__, function.__name__)
426        if not args and not listitems and not dictitems \
427                and isinstance(state, dict) and newobj:
428            return self.represent_mapping(
429                    u'tag:yaml.org,2002:python/object:'+function_name, state)
430        if not listitems and not dictitems  \
431                and isinstance(state, dict) and not state:
432            return self.represent_sequence(tag+function_name, args)
433        value = {}
434        if args:
435            value['args'] = args
436        if state or not isinstance(state, dict):
437            value['state'] = state
438        if listitems:
439            value['listitems'] = listitems
440        if dictitems:
441            value['dictitems'] = dictitems
442        return self.represent_mapping(tag+function_name, value)
443
444Representer.add_representer(str,
445        Representer.represent_str)
446
447Representer.add_representer(unicode,
448        Representer.represent_unicode)
449
450Representer.add_representer(long,
451        Representer.represent_long)
452
453Representer.add_representer(complex,
454        Representer.represent_complex)
455
456Representer.add_representer(tuple,
457        Representer.represent_tuple)
458
459Representer.add_representer(type,
460        Representer.represent_name)
461
462Representer.add_representer(types.ClassType,
463        Representer.represent_name)
464
465Representer.add_representer(types.FunctionType,
466        Representer.represent_name)
467
468Representer.add_representer(types.BuiltinFunctionType,
469        Representer.represent_name)
470
471Representer.add_representer(types.ModuleType,
472        Representer.represent_module)
473
474Representer.add_multi_representer(types.InstanceType,
475        Representer.represent_instance)
476
477Representer.add_multi_representer(object,
478        Representer.represent_object)
479
Note: See TracBrowser for help on using the repository browser.