/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/xml_serializer.py

  • Committer: Colin D Bennett
  • Date: 2009-02-12 16:57:39 UTC
  • mto: This revision was merged to the branch mainline in revision 4008.
  • Revision ID: colin@gibibit.com-20090212165739-02xv63odccfmxomw
Generate PDF version of the User Guide.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml_serializer.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""XML externalization support."""
18
18
 
22
22
# importing this module is fairly slow because it has to load several
23
23
# ElementTree bits
24
24
 
25
 
from bzrlib.serializer import Serializer
26
 
from bzrlib.trace import mutter
 
25
from bzrlib import registry
 
26
from bzrlib.trace import mutter, warning
27
27
 
28
28
try:
29
29
    try:
49
49
from bzrlib import errors
50
50
 
51
51
 
52
 
class XMLSerializer(Serializer):
53
 
    """Abstract XML object serialize/deserialize"""
54
 
 
55
 
    squashes_xml_invalid_characters = True
 
52
class Serializer(object):
 
53
    """Abstract object serialize/deserialize"""
 
54
 
 
55
    def write_inventory(self, inv, f):
 
56
        """Write inventory to a file"""
 
57
        raise NotImplementedError(self.write_inventory)
 
58
 
 
59
    def write_inventory_to_string(self, inv):
 
60
        raise NotImplementedError(self.write_inventory_to_string)
56
61
 
57
62
    def read_inventory_from_string(self, xml_string, revision_id=None,
58
 
                                   entry_cache=None, return_from_cache=False):
 
63
                                   entry_cache=None):
59
64
        """Read xml_string into an inventory object.
60
65
 
61
66
        :param xml_string: The xml to read.
69
74
        :param entry_cache: An optional cache of InventoryEntry objects. If
70
75
            supplied we will look up entries via (file_id, revision_id) which
71
76
            should map to a valid InventoryEntry (File/Directory/etc) object.
72
 
        :param return_from_cache: Return entries directly from the cache,
73
 
            rather than copying them first. This is only safe if the caller
74
 
            promises not to mutate the returned inventory entries, but it can
75
 
            make some operations significantly faster.
76
77
        """
77
78
        try:
78
79
            return self._unpack_inventory(fromstring(xml_string), revision_id,
79
 
                                          entry_cache=entry_cache,
80
 
                                          return_from_cache=return_from_cache)
 
80
                                          entry_cache=entry_cache)
81
81
        except ParseError, e:
82
82
            raise errors.UnexpectedInventoryFormat(e)
83
83
 
84
84
    def read_inventory(self, f, revision_id=None):
85
85
        try:
86
 
            try:
87
 
                return self._unpack_inventory(self._read_element(f),
88
 
                    revision_id=None)
89
 
            finally:
90
 
                f.close()
 
86
            return self._unpack_inventory(self._read_element(f),
 
87
                revision_id=None)
91
88
        except ParseError, e:
92
89
            raise errors.UnexpectedInventoryFormat(e)
93
90
 
125
122
    }
126
123
def _escape_replace(match, map=escape_map):
127
124
    return map[match.group()]
128
 
 
 
125
 
129
126
def _escape_attrib(text, encoding=None, replace=None):
130
127
    # escape attribute value
131
128
    try:
156
153
    }
157
154
def _escape_cdata_replace(match, map=escape_cdata_map):
158
155
    return map[match.group()]
159
 
 
 
156
 
160
157
def _escape_cdata(text, encoding=None, replace=None):
161
158
    # escape character data
162
159
    try:
178
175
elementtree.ElementTree._escape_cdata = _escape_cdata
179
176
 
180
177
 
181
 
def escape_invalid_chars(message):
182
 
    """Escape the XML-invalid characters in a commit message.
183
 
 
184
 
    :param message: Commit message to escape
185
 
    :return: tuple with escaped message and number of characters escaped
186
 
    """
187
 
    if message is None:
188
 
        return None, 0
189
 
    # Python strings can include characters that can't be
190
 
    # represented in well-formed XML; escape characters that
191
 
    # aren't listed in the XML specification
192
 
    # (http://www.w3.org/TR/REC-xml/#NT-Char).
193
 
    return re.subn(u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
194
 
            lambda match: match.group(0).encode('unicode_escape'),
195
 
            message)
 
178
class SerializerRegistry(registry.Registry):
 
179
    """Registry for serializer objects"""
 
180
 
 
181
 
 
182
format_registry = SerializerRegistry()
 
183
format_registry.register_lazy('4', 'bzrlib.xml4', 'serializer_v4')
 
184
format_registry.register_lazy('5', 'bzrlib.xml5', 'serializer_v5')
 
185
format_registry.register_lazy('6', 'bzrlib.xml6', 'serializer_v6')
 
186
format_registry.register_lazy('7', 'bzrlib.xml7', 'serializer_v7')
 
187
format_registry.register_lazy('8', 'bzrlib.xml8', 'serializer_v8')