/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: Ian Clatworthy
  • Date: 2007-11-14 03:50:56 UTC
  • mto: (3054.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3055.
  • Revision ID: ian.clatworthy@internode.on.net-20071114035056-72l6odzpby4bcmub
First cut at new look User Guide including chapters 1 and 2

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:
34
34
    except ImportError:
35
35
        from cElementTree import (ElementTree, SubElement, Element,
36
36
                                  XMLTreeBuilder, fromstring, tostring)
37
 
        import elementtree.ElementTree
 
37
        import elementtree
38
38
    ParseError = SyntaxError
39
39
except ImportError:
40
40
    mutter('WARNING: using slower ElementTree; consider installing cElementTree'
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
56
 
 
57
 
    def read_inventory_from_string(self, xml_string, revision_id=None,
58
 
                                   entry_cache=None, return_from_cache=False):
 
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)
 
61
 
 
62
    def read_inventory_from_string(self, xml_string, revision_id=None):
59
63
        """Read xml_string into an inventory object.
60
64
 
61
65
        :param xml_string: The xml to read.
62
66
        :param revision_id: If not-None, the expected revision id of the
63
67
            inventory. Some serialisers use this to set the results' root
64
 
            revision. This should be supplied for deserialising all
65
 
            from-repository inventories so that xml5 inventories that were
66
 
            serialised without a revision identifier can be given the right
67
 
            revision id (but not for working tree inventories where users can
68
 
            edit the data without triggering checksum errors or anything).
69
 
        :param entry_cache: An optional cache of InventoryEntry objects. If
70
 
            supplied we will look up entries via (file_id, revision_id) which
71
 
            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.
 
68
            revision.
76
69
        """
77
70
        try:
78
 
            return self._unpack_inventory(fromstring(xml_string), revision_id,
79
 
                                          entry_cache=entry_cache,
80
 
                                          return_from_cache=return_from_cache)
 
71
            return self._unpack_inventory(fromstring(xml_string), revision_id)
81
72
        except ParseError, e:
82
73
            raise errors.UnexpectedInventoryFormat(e)
83
74
 
84
75
    def read_inventory(self, f, revision_id=None):
85
76
        try:
86
 
            try:
87
 
                return self._unpack_inventory(self._read_element(f),
88
 
                    revision_id=None)
89
 
            finally:
90
 
                f.close()
 
77
            return self._unpack_inventory(self._read_element(f),
 
78
                revision_id=None)
91
79
        except ParseError, e:
92
80
            raise errors.UnexpectedInventoryFormat(e)
93
81
 
125
113
    }
126
114
def _escape_replace(match, map=escape_map):
127
115
    return map[match.group()]
128
 
 
 
116
 
129
117
def _escape_attrib(text, encoding=None, replace=None):
130
118
    # escape attribute value
131
119
    try:
156
144
    }
157
145
def _escape_cdata_replace(match, map=escape_cdata_map):
158
146
    return map[match.group()]
159
 
 
 
147
 
160
148
def _escape_cdata(text, encoding=None, replace=None):
161
149
    # escape character data
162
150
    try:
178
166
elementtree.ElementTree._escape_cdata = _escape_cdata
179
167
 
180
168
 
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)
 
169
class SerializerRegistry(registry.Registry):
 
170
    """Registry for serializer objects"""
 
171
 
 
172
 
 
173
format_registry = SerializerRegistry()
 
174
format_registry.register_lazy('4', 'bzrlib.xml4', 'serializer_v4')
 
175
format_registry.register_lazy('5', 'bzrlib.xml5', 'serializer_v5')
 
176
format_registry.register_lazy('6', 'bzrlib.xml6', 'serializer_v6')
 
177
format_registry.register_lazy('7', 'bzrlib.xml7', 'serializer_v7')