← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml_serializer.py

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml_serializer.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
23
23
# ElementTree bits
24
24
 
25
25
from bzrlib.serializer import Serializer
26
 
from bzrlib.trace import mutter, warning
 
26
from bzrlib.trace import mutter
27
27
 
28
28
try:
29
29
    try:
52
52
class XMLSerializer(Serializer):
53
53
    """Abstract XML object serialize/deserialize"""
54
54
 
 
55
    squashes_xml_invalid_characters = True
 
56
 
55
57
    def read_inventory_from_string(self, xml_string, revision_id=None,
56
 
                                   entry_cache=None):
 
58
                                   entry_cache=None, return_from_cache=False):
57
59
        """Read xml_string into an inventory object.
58
60
 
59
61
        :param xml_string: The xml to read.
67
69
        :param entry_cache: An optional cache of InventoryEntry objects. If
68
70
            supplied we will look up entries via (file_id, revision_id) which
69
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.
70
76
        """
71
77
        try:
72
78
            return self._unpack_inventory(fromstring(xml_string), revision_id,
73
 
                                          entry_cache=entry_cache)
 
79
                                          entry_cache=entry_cache,
 
80
                                          return_from_cache=return_from_cache)
74
81
        except ParseError, e:
75
82
            raise errors.UnexpectedInventoryFormat(e)
76
83
 
77
84
    def read_inventory(self, f, revision_id=None):
78
85
        try:
79
 
            return self._unpack_inventory(self._read_element(f),
80
 
                revision_id=None)
 
86
            try:
 
87
                return self._unpack_inventory(self._read_element(f),
 
88
                    revision_id=None)
 
89
            finally:
 
90
                f.close()
81
91
        except ParseError, e:
82
92
            raise errors.UnexpectedInventoryFormat(e)
83
93
 
172
182
    """Escape the XML-invalid characters in a commit message.
173
183
 
174
184
    :param message: Commit message to escape
175
 
    :param count: Number of characters that were escaped
 
185
    :return: tuple with escaped message and number of characters escaped
176
186
    """
 
187
    if message is None:
 
188
        return None, 0
177
189
    # Python strings can include characters that can't be
178
190
    # represented in well-formed XML; escape characters that
179
191
    # aren't listed in the XML specification