← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml_serializer.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-06-10 08:15:19 UTC
  • mfrom: (3489.1.2 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20080610081519-95unlj6ayptlh2uv
(mbp) Bump version to 1.6b3

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml_serializer.py
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
 
25
from bzrlib import registry
26
26
from bzrlib.trace import mutter, warning
27
27
 
28
28
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
 
    def read_inventory_from_string(self, xml_string, revision_id=None,
56
 
                                   entry_cache=None):
 
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):
57
63
        """Read xml_string into an inventory object.
58
64
 
59
65
        :param xml_string: The xml to read.
64
70
            serialised without a revision identifier can be given the right
65
71
            revision id (but not for working tree inventories where users can
66
72
            edit the data without triggering checksum errors or anything).
67
 
        :param entry_cache: An optional cache of InventoryEntry objects. If
68
 
            supplied we will look up entries via (file_id, revision_id) which
69
 
            should map to a valid InventoryEntry (File/Directory/etc) object.
70
73
        """
71
74
        try:
72
 
            return self._unpack_inventory(fromstring(xml_string), revision_id,
73
 
                                          entry_cache=entry_cache)
 
75
            return self._unpack_inventory(fromstring(xml_string), revision_id)
74
76
        except ParseError, e:
75
77
            raise errors.UnexpectedInventoryFormat(e)
76
78
 
115
117
    }
116
118
def _escape_replace(match, map=escape_map):
117
119
    return map[match.group()]
118
 
 
 
120
 
119
121
def _escape_attrib(text, encoding=None, replace=None):
120
122
    # escape attribute value
121
123
    try:
146
148
    }
147
149
def _escape_cdata_replace(match, map=escape_cdata_map):
148
150
    return map[match.group()]
149
 
 
 
151
 
150
152
def _escape_cdata(text, encoding=None, replace=None):
151
153
    # escape character data
152
154
    try:
168
170
elementtree.ElementTree._escape_cdata = _escape_cdata
169
171
 
170
172
 
171
 
def escape_invalid_chars(message):
172
 
    """Escape the XML-invalid characters in a commit message.
173
 
 
174
 
    :param message: Commit message to escape
175
 
    :param count: Number of characters that were escaped
176
 
    """
177
 
    # Python strings can include characters that can't be
178
 
    # represented in well-formed XML; escape characters that
179
 
    # aren't listed in the XML specification
180
 
    # (http://www.w3.org/TR/REC-xml/#NT-Char).
181
 
    return re.subn(u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
182
 
            lambda match: match.group(0).encode('unicode_escape'),
183
 
            message)
 
173
class SerializerRegistry(registry.Registry):
 
174
    """Registry for serializer objects"""
 
175
 
 
176
 
 
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')
 
182
format_registry.register_lazy('8', 'bzrlib.xml8', 'serializer_v8')