← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml.py

  • Committer: Martin Pool
  • Date: 2005-08-04 22:30:50 UTC
  • Revision ID: mbp@sourcefrog.net-20050804223050-01256e5e26a90b1d
- merge patch to take ranges to diff -r option

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
#! /usr/bin/env python
 
2
# -*- coding: UTF-8 -*-
 
3
 
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
5
6
# the Free Software Foundation; either version 2 of the License, or
6
7
# (at your option) any later version.
7
 
#
 
8
 
8
9
# This program is distributed in the hope that it will be useful,
9
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
12
# GNU General Public License for more details.
12
 
#
 
13
 
13
14
# You should have received a copy of the GNU General Public License
14
15
# along with this program; if not, write to the Free Software
15
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
20
# "XML is like violence: if it doesn't solve your problem, you aren't
20
21
# using enough of it." -- various
21
22
 
22
 
# importing this module is fairly slow because it has to load several
23
 
# ElementTree bits
24
 
 
25
 
from bzrlib import registry
26
 
from bzrlib.trace import mutter, warning
27
 
 
 
23
# importing this module is fairly slow because it has to load several ElementTree bits
28
24
try:
29
 
    try:
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
34
 
    except ImportError:
35
 
        from cElementTree import (ElementTree, SubElement, Element,
36
 
                                  XMLTreeBuilder, fromstring, tostring)
37
 
        import elementtree.ElementTree
38
 
    ParseError = SyntaxError
 
25
    from cElementTree import ElementTree, SubElement, Element
39
26
except ImportError:
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,
45
 
                                              fromstring, tostring)
46
 
    import util.elementtree as elementtree
47
 
    from xml.parsers.expat import ExpatError as ParseError
48
 
 
49
 
from bzrlib import errors
50
 
 
51
 
 
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):
63
 
        """Read xml_string into an inventory object.
64
 
 
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).
73
 
        """
74
 
        try:
75
 
            return self._unpack_inventory(fromstring(xml_string), revision_id)
76
 
        except ParseError, e:
77
 
            raise errors.UnexpectedInventoryFormat(e)
78
 
 
79
 
    def read_inventory(self, f, revision_id=None):
80
 
        try:
81
 
            return self._unpack_inventory(self._read_element(f),
82
 
                revision_id=None)
83
 
        except ParseError, e:
84
 
            raise errors.UnexpectedInventoryFormat(e)
85
 
 
86
 
    def write_revision(self, rev, f):
87
 
        self._write_element(self._pack_revision(rev), f)
88
 
 
89
 
    def write_revision_to_string(self, rev):
90
 
        return tostring(self._pack_revision(rev)) + '\n'
91
 
 
92
 
    def read_revision(self, f):
93
 
        return self._unpack_revision(self._read_element(f))
94
 
 
95
 
    def read_revision_from_string(self, xml_string):
96
 
        return self._unpack_revision(fromstring(xml_string))
97
 
 
98
 
    def _write_element(self, elt, f):
99
 
        ElementTree(elt).write(f, 'utf-8')
100
 
        f.write('\n')
101
 
 
102
 
    def _read_element(self, f):
103
 
        return ElementTree().parse(f)
104
 
 
105
 
 
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.
109
 
import re
110
 
escape_re = re.compile("[&'\"<>]")
111
 
escape_map = {
112
 
    "&":'&amp;',
113
 
    "'":"&apos;", # FIXME: overkill
114
 
    "\"":"&quot;",
115
 
    "<":"&lt;",
116
 
    ">":"&gt;",
117
 
    }
118
 
def _escape_replace(match, map=escape_map):
119
 
    return map[match.group()]
120
 
 
121
 
def _escape_attrib(text, encoding=None, replace=None):
122
 
    # escape attribute value
123
 
    try:
124
 
        if encoding:
125
 
            try:
126
 
                text = elementtree.ElementTree._encode(text, encoding)
127
 
            except UnicodeError:
128
 
                return elementtree.ElementTree._encode_entity(text)
129
 
        if replace is None:
130
 
            return escape_re.sub(_escape_replace, text)
131
 
        else:
132
 
            text = replace(text, "&", "&amp;")
133
 
            text = replace(text, "'", "&apos;") # FIXME: overkill
134
 
            text = replace(text, "\"", "&quot;")
135
 
            text = replace(text, "<", "&lt;")
136
 
            text = replace(text, ">", "&gt;")
137
 
            return text
138
 
    except (TypeError, AttributeError):
139
 
        elementtree.ElementTree._raise_serialization_error(text)
140
 
 
141
 
elementtree.ElementTree._escape_attrib = _escape_attrib
142
 
 
143
 
escape_cdata_re = re.compile("[&<>]")
144
 
escape_cdata_map = {
145
 
    "&":'&amp;',
146
 
    "<":"&lt;",
147
 
    ">":"&gt;",
148
 
    }
149
 
def _escape_cdata_replace(match, map=escape_cdata_map):
150
 
    return map[match.group()]
151
 
 
152
 
def _escape_cdata(text, encoding=None, replace=None):
153
 
    # escape character data
154
 
    try:
155
 
        if encoding:
156
 
            try:
157
 
                text = elementtree.ElementTree._encode(text, encoding)
158
 
            except UnicodeError:
159
 
                return elementtree.ElementTree._encode_entity(text)
160
 
        if replace is None:
161
 
            return escape_cdata_re.sub(_escape_cdata_replace, text)
162
 
        else:
163
 
            text = replace(text, "&", "&amp;")
164
 
            text = replace(text, "<", "&lt;")
165
 
            text = replace(text, ">", "&gt;")
166
 
            return text
167
 
    except (TypeError, AttributeError):
168
 
        elementtree.ElementTree._raise_serialization_error(text)
169
 
 
170
 
elementtree.ElementTree._escape_cdata = _escape_cdata
171
 
 
172
 
 
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')
 
27
    from elementtree.ElementTree import ElementTree, SubElement, Element
 
28
 
 
29
 
 
30
def pack_xml(o, f):
 
31
    """Write object o to file f as XML.
 
32
 
 
33
    o must provide a to_element method.
 
34
    """
 
35
    ElementTree(o.to_element()).write(f, 'utf-8')
 
36
    f.write('\n')
 
37
 
 
38
 
 
39
def unpack_xml(cls, f):
 
40
    return cls.from_element(ElementTree().parse(f))