19
20
# "XML is like violence: if it doesn't solve your problem, you aren't
20
21
# using enough of it." -- various
22
# importing this module is fairly slow because it has to load several
25
from bzrlib.trace import mutter, warning
23
# importing this module is fairly slow because it has to load several ElementTree bits
28
from cElementTree import (ElementTree, SubElement, Element,
29
XMLTreeBuilder, fromstring, tostring)
25
from util.cElementTree import ElementTree, SubElement, Element
30
26
except ImportError:
31
mutter('WARNING: using slower ElementTree; consider installing cElementTree'
32
" and make sure it's on your PYTHONPATH")
33
from util.elementtree.ElementTree import (ElementTree, SubElement,
34
Element, XMLTreeBuilder,
37
from bzrlib.errors import BzrError
40
class Serializer(object):
41
"""Abstract object serialize/deserialize"""
42
def write_inventory(self, inv, f):
43
"""Write inventory to a file"""
44
elt = self._pack_inventory(inv)
45
self._write_element(elt, f)
47
def write_inventory_to_string(self, inv):
48
return tostring(self._pack_inventory(inv)) + '\n'
50
def read_inventory_from_string(self, xml_string):
51
return self._unpack_inventory(fromstring(xml_string))
53
def read_inventory(self, f):
54
return self._unpack_inventory(self._read_element(f))
56
def write_revision(self, rev, f):
57
self._write_element(self._pack_revision(rev), f)
59
def write_revision_to_string(self, rev):
60
return tostring(self._pack_revision(rev)) + '\n'
62
def read_revision(self, f):
63
return self._unpack_revision(self._read_element(f))
65
def read_revision_from_string(self, xml_string):
66
return self._unpack_revision(fromstring(xml_string))
68
def _write_element(self, elt, f):
69
ElementTree(elt).write(f, 'utf-8')
72
def _read_element(self, f):
73
return ElementTree().parse(f)
76
# performance tuning for elementree's serialiser. THis should be
77
# sent upstream - RBC 20060523.
78
# the functions here are patched into elementree at runtime.
79
import elementtree.ElementTree
81
escape_re = re.compile("[&'\"<>]")
84
"'":"'", # FIXME: overkill
89
def _escape_replace(match, map=escape_map):
90
return map[match.group()]
92
def _escape_attrib(text, encoding=None, replace=None):
93
# escape attribute value
97
text = elementtree.ElementTree._encode(text, encoding)
99
return elementtree.ElementTree._encode_entity(text)
101
return escape_re.sub(_escape_replace, text)
103
text = replace(text, "&", "&")
104
text = replace(text, "'", "'") # FIXME: overkill
105
text = replace(text, "\"", """)
106
text = replace(text, "<", "<")
107
text = replace(text, ">", ">")
109
except (TypeError, AttributeError):
110
elementtree.ElementTree._raise_serialization_error(text)
112
elementtree.ElementTree._escape_attrib = _escape_attrib
114
escape_cdata_re = re.compile("[&<>]")
120
def _escape_cdata_replace(match, map=escape_cdata_map):
121
return map[match.group()]
123
def _escape_cdata(text, encoding=None, replace=None):
124
# escape character data
128
text = elementtree.ElementTree._encode(text, encoding)
130
return elementtree.ElementTree._encode_entity(text)
132
return escape_cdata_re.sub(_escape_cdata_replace, text)
134
text = replace(text, "&", "&")
135
text = replace(text, "<", "<")
136
text = replace(text, ">", ">")
138
except (TypeError, AttributeError):
139
elementtree.ElementTree._raise_serialization_error(text)
141
elementtree.ElementTree._escape_cdata = _escape_cdata
27
from util.elementtree.ElementTree import ElementTree, SubElement, Element
31
"""Write object o to file f as XML.
33
o must provide a to_element method.
35
ElementTree(o.to_element()).write(f, 'utf-8')
39
def unpack_xml(cls, f):
40
return cls.from_element(ElementTree().parse(f))