← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml.py

todo

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml.py
17
17
 
18
18
"""XML externalization support."""
19
19
 
20
 
 
21
 
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
22
 
__author__ = "Martin Pool <mbp@canonical.com>"
 
20
# "XML is like violence: if it doesn't solve your problem, you aren't
 
21
# using enough of it." -- various
 
22
 
 
23
# importing this module is fairly slow because it has to load several
 
24
# ElementTree bits
 
25
 
 
26
from bzrlib.trace import mutter, warning
23
27
 
24
28
try:
25
 
    from cElementTree import Element, ElementTree, SubElement
 
29
    from cElementTree import (ElementTree, SubElement, Element,
 
30
                              XMLTreeBuilder, fromstring, tostring)
26
31
except ImportError:
27
 
    from elementtree.ElementTree import Element, ElementTree, SubElement
28
 
 
29
 
import os, time
30
 
from trace import mutter
31
 
 
32
 
class XMLMixin:
33
 
    def to_element(self):
34
 
        raise Exception("XMLMixin.to_element must be overridden in concrete classes")
35
 
    
36
 
    def write_xml(self, f):
37
 
        ElementTree(self.to_element()).write(f, 'utf-8')
 
32
    ## from warnings import warn
 
33
    ## warn('using slower ElementTree; consider installing cElementTree')
 
34
    from util.elementtree.ElementTree import (ElementTree, SubElement,
 
35
                                              Element, XMLTreeBuilder,
 
36
                                              fromstring, tostring)
 
37
 
 
38
from bzrlib.errors import BzrError
 
39
 
 
40
 
 
41
class Serializer(object):
 
42
    """Abstract object serialize/deserialize"""
 
43
    def write_inventory(self, inv, f):
 
44
        """Write inventory to a file"""
 
45
        elt = self._pack_inventory(inv)
 
46
        self._write_element(elt, f)
 
47
 
 
48
    def write_inventory_to_string(self, inv):
 
49
        return tostring(self._pack_inventory(inv))
 
50
 
 
51
    def read_inventory_from_string(self, xml_string):
 
52
        return self._unpack_inventory(fromstring(xml_string))
 
53
 
 
54
    def read_inventory(self, f):
 
55
        return self._unpack_inventory(self._read_element(f))
 
56
 
 
57
    def write_revision(self, rev, f):
 
58
        self._write_element(self._pack_revision(rev), f)
 
59
 
 
60
    def write_revision_to_string(self, rev):
 
61
        return tostring(self._pack_revision(rev), f)
 
62
 
 
63
    def read_revision(self, f):
 
64
        return self._unpack_revision(self._read_element(f))
 
65
 
 
66
    def read_revision_from_string(self, xml_string):
 
67
        return self._unpack_revision(fromstring(xml_string))
 
68
 
 
69
    def _write_element(self, elt, f):
 
70
        ElementTree(elt).write(f, 'utf-8')
38
71
        f.write('\n')
39
72
 
40
 
    def read_xml(cls, f):
41
 
        return cls.from_element(ElementTree().parse(f))
42
 
 
43
 
    read_xml = classmethod(read_xml)
44
 
 
45
 
 
46
 
 
 
73
    def _read_element(self, f):
 
74
        return ElementTree().parse(f)