1
# -*- coding: UTF-8 -*-
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""XML externalization support."""
19
# "XML is like violence: if it doesn't solve your problem, you aren't
20
# 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
28
from cElementTree import (ElementTree, SubElement, Element,
29
XMLTreeBuilder, fromstring, tostring)
32
mutter('WARNING: using slower ElementTree; consider installing cElementTree'
33
" and make sure it's on your PYTHONPATH")
34
from util.elementtree.ElementTree import (ElementTree, SubElement,
35
Element, XMLTreeBuilder,
37
import util.elementtree as elementtree
39
from bzrlib.errors import BzrError
42
class Serializer(object):
43
"""Abstract object serialize/deserialize"""
44
def write_inventory(self, inv, f):
45
"""Write inventory to a file"""
46
elt = self._pack_inventory(inv)
47
self._write_element(elt, f)
49
def write_inventory_to_string(self, inv):
50
return tostring(self._pack_inventory(inv)) + '\n'
52
def read_inventory_from_string(self, xml_string):
53
return self._unpack_inventory(fromstring(xml_string))
55
def read_inventory(self, f):
56
return self._unpack_inventory(self._read_element(f))
58
def write_revision(self, rev, f):
59
self._write_element(self._pack_revision(rev), f)
61
def write_revision_to_string(self, rev):
62
return tostring(self._pack_revision(rev)) + '\n'
64
def read_revision(self, f):
65
return self._unpack_revision(self._read_element(f))
67
def read_revision_from_string(self, xml_string):
68
return self._unpack_revision(fromstring(xml_string))
70
def _write_element(self, elt, f):
71
ElementTree(elt).write(f, 'utf-8')
74
def _read_element(self, f):
75
return ElementTree().parse(f)
78
# performance tuning for elementree's serialiser. This should be
79
# sent upstream - RBC 20060523.
80
# the functions here are patched into elementtree at runtime.
82
escape_re = re.compile("[&'\"<>]")
85
"'":"'", # FIXME: overkill
90
def _escape_replace(match, map=escape_map):
91
return map[match.group()]
93
def _escape_attrib(text, encoding=None, replace=None):
94
# escape attribute value
98
text = elementtree.ElementTree._encode(text, encoding)
100
return elementtree.ElementTree._encode_entity(text)
102
return escape_re.sub(_escape_replace, text)
104
text = replace(text, "&", "&")
105
text = replace(text, "'", "'") # FIXME: overkill
106
text = replace(text, "\"", """)
107
text = replace(text, "<", "<")
108
text = replace(text, ">", ">")
110
except (TypeError, AttributeError):
111
elementtree.ElementTree._raise_serialization_error(text)
113
elementtree.ElementTree._escape_attrib = _escape_attrib
115
escape_cdata_re = re.compile("[&<>]")
121
def _escape_cdata_replace(match, map=escape_cdata_map):
122
return map[match.group()]
124
def _escape_cdata(text, encoding=None, replace=None):
125
# escape character data
129
text = elementtree.ElementTree._encode(text, encoding)
131
return elementtree.ElementTree._encode_entity(text)
133
return escape_cdata_re.sub(_escape_cdata_replace, text)
135
text = replace(text, "&", "&")
136
text = replace(text, "<", "<")
137
text = replace(text, ">", ">")
139
except (TypeError, AttributeError):
140
elementtree.ElementTree._raise_serialization_error(text)
142
elementtree.ElementTree._escape_cdata = _escape_cdata
added
removed
bzrlib/xml_serializer.py
