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

Revision 147, 16.9 KB checked in by xi, 9 years ago (diff)

Add support for pickling/unpickling python objects.

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