1
# Copyright (C) 2005, 2006 Canonical Ltd
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 import registry
26
from bzrlib.trace import mutter, warning
30
# it's in this package in python2.5
31
from xml.etree.cElementTree import (ElementTree, SubElement, Element,
32
XMLTreeBuilder, fromstring, tostring)
33
import xml.etree as elementtree
35
from cElementTree import (ElementTree, SubElement, Element,
36
XMLTreeBuilder, fromstring, tostring)
38
ParseError = SyntaxError
40
mutter('WARNING: using slower ElementTree; consider installing cElementTree'
41
" and make sure it's on your PYTHONPATH")
42
# this copy is shipped with bzr
43
from util.elementtree.ElementTree import (ElementTree, SubElement,
44
Element, XMLTreeBuilder,
46
import util.elementtree as elementtree
47
from xml.parsers.expat import ExpatError as ParseError
49
from bzrlib import errors
52
class Serializer(object):
53
"""Abstract object serialize/deserialize"""
54
def write_inventory(self, inv, f):
55
"""Write inventory to a file"""
56
elt = self._pack_inventory(inv)
57
self._write_element(elt, f)
59
def write_inventory_to_string(self, inv):
60
return tostring(self._pack_inventory(inv)) + '\n'
62
def read_inventory_from_string(self, xml_string):
64
return self._unpack_inventory(fromstring(xml_string))
66
raise errors.UnexpectedInventoryFormat(e)
68
def read_inventory(self, f):
70
return self._unpack_inventory(self._read_element(f))
72
raise errors.UnexpectedInventoryFormat(e)
74
def write_revision(self, rev, f):
75
self._write_element(self._pack_revision(rev), f)
77
def write_revision_to_string(self, rev):
78
return tostring(self._pack_revision(rev)) + '\n'
80
def read_revision(self, f):
81
return self._unpack_revision(self._read_element(f))
83
def read_revision_from_string(self, xml_string):
84
return self._unpack_revision(fromstring(xml_string))
86
def _write_element(self, elt, f):
87
ElementTree(elt).write(f, 'utf-8')
90
def _read_element(self, f):
91
return ElementTree().parse(f)
94
# performance tuning for elementree's serialiser. This should be
95
# sent upstream - RBC 20060523.
96
# the functions here are patched into elementtree at runtime.
98
escape_re = re.compile("[&'\"<>]")
101
"'":"'", # FIXME: overkill
106
def _escape_replace(match, map=escape_map):
107
return map[match.group()]
109
def _escape_attrib(text, encoding=None, replace=None):
110
# escape attribute value
114
text = elementtree.ElementTree._encode(text, encoding)
116
return elementtree.ElementTree._encode_entity(text)
118
return escape_re.sub(_escape_replace, text)
120
text = replace(text, "&", "&")
121
text = replace(text, "'", "'") # FIXME: overkill
122
text = replace(text, "\"", """)
123
text = replace(text, "<", "<")
124
text = replace(text, ">", ">")
126
except (TypeError, AttributeError):
127
elementtree.ElementTree._raise_serialization_error(text)
129
elementtree.ElementTree._escape_attrib = _escape_attrib
131
escape_cdata_re = re.compile("[&<>]")
137
def _escape_cdata_replace(match, map=escape_cdata_map):
138
return map[match.group()]
140
def _escape_cdata(text, encoding=None, replace=None):
141
# escape character data
145
text = elementtree.ElementTree._encode(text, encoding)
147
return elementtree.ElementTree._encode_entity(text)
149
return escape_cdata_re.sub(_escape_cdata_replace, text)
151
text = replace(text, "&", "&")
152
text = replace(text, "<", "<")
153
text = replace(text, ">", ">")
155
except (TypeError, AttributeError):
156
elementtree.ElementTree._raise_serialization_error(text)
158
elementtree.ElementTree._escape_cdata = _escape_cdata
161
class SerializerRegistry(registry.Registry):
162
"""Registry for serializer objects"""
165
format_registry = SerializerRegistry()
166
format_registry.register_lazy('4', 'bzrlib.xml4', 'serializer_v4')
167
format_registry.register_lazy('5', 'bzrlib.xml5', 'serializer_v5')
168
format_registry.register_lazy('6', 'bzrlib.xml6', 'serializer_v6')
169
format_registry.register_lazy('7', 'bzrlib.xml7', 'serializer_v7')
added
removed
bzrlib/xml_serializer.py
