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"""
55
def write_inventory(self, inv, f):
56
"""Write inventory to a file"""
57
raise NotImplementedError(self.write_inventory)
59
def write_inventory_to_string(self, inv):
60
raise NotImplementedError(self.write_inventory_to_string)
62
def read_inventory_from_string(self, xml_string, revision_id=None):
63
"""Read xml_string into an inventory object.
65
:param xml_string: The xml to read.
66
:param revision_id: If not-None, the expected revision id of the
67
inventory. Some serialisers use this to set the results' root
68
revision. This should be supplied for deserialising all
69
from-repository inventories so that xml5 inventories that were
70
serialised without a revision identifier can be given the right
71
revision id (but not for working tree inventories where users can
72
edit the data without triggering checksum errors or anything).
75
return self._unpack_inventory(fromstring(xml_string), revision_id)
77
raise errors.UnexpectedInventoryFormat(e)
79
def read_inventory(self, f, revision_id=None):
81
return self._unpack_inventory(self._read_element(f),
84
raise errors.UnexpectedInventoryFormat(e)
86
def write_revision(self, rev, f):
87
self._write_element(self._pack_revision(rev), f)
89
def write_revision_to_string(self, rev):
90
return tostring(self._pack_revision(rev)) + '\n'
92
def read_revision(self, f):
93
return self._unpack_revision(self._read_element(f))
95
def read_revision_from_string(self, xml_string):
96
return self._unpack_revision(fromstring(xml_string))
98
def _write_element(self, elt, f):
99
ElementTree(elt).write(f, 'utf-8')
102
def _read_element(self, f):
103
return ElementTree().parse(f)
106
# performance tuning for elementree's serialiser. This should be
107
# sent upstream - RBC 20060523.
108
# the functions here are patched into elementtree at runtime.
110
escape_re = re.compile("[&'\"<>]")
113
"'":"'", # FIXME: overkill
118
def _escape_replace(match, map=escape_map):
119
return map[match.group()]
121
def _escape_attrib(text, encoding=None, replace=None):
122
# escape attribute value
126
text = elementtree.ElementTree._encode(text, encoding)
128
return elementtree.ElementTree._encode_entity(text)
130
return escape_re.sub(_escape_replace, text)
132
text = replace(text, "&", "&")
133
text = replace(text, "'", "'") # FIXME: overkill
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_attrib = _escape_attrib
143
escape_cdata_re = re.compile("[&<>]")
149
def _escape_cdata_replace(match, map=escape_cdata_map):
150
return map[match.group()]
152
def _escape_cdata(text, encoding=None, replace=None):
153
# escape character data
157
text = elementtree.ElementTree._encode(text, encoding)
159
return elementtree.ElementTree._encode_entity(text)
161
return escape_cdata_re.sub(_escape_cdata_replace, text)
163
text = replace(text, "&", "&")
164
text = replace(text, "<", "<")
165
text = replace(text, ">", ">")
167
except (TypeError, AttributeError):
168
elementtree.ElementTree._raise_serialization_error(text)
170
elementtree.ElementTree._escape_cdata = _escape_cdata
173
class SerializerRegistry(registry.Registry):
174
"""Registry for serializer objects"""
177
format_registry = SerializerRegistry()
178
format_registry.register_lazy('4', 'bzrlib.xml4', 'serializer_v4')
179
format_registry.register_lazy('5', 'bzrlib.xml5', 'serializer_v5')
180
format_registry.register_lazy('6', 'bzrlib.xml6', 'serializer_v6')
181
format_registry.register_lazy('7', 'bzrlib.xml7', 'serializer_v7')
added
removed
bzrlib/xml_serializer.py
