Ticket #5: representer.2.py

File representer.2.py, 19.4 KB (added by Peter Murphy (pkmurphy at postmaster dot co dot uk), 8 years ago)

Allowing class instances referncing itself to be dumped.

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