← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml_serializer.py

  • Committer: Blake Winton
  • Date: 2007-10-16 16:02:01 UTC
  • mto: This revision was merged to the branch mainline in revision 2921.
  • Revision ID: bwinton@latte.ca-20071016160201-os2bci2ujf7in7an
Change 'print >> f,'s to 'f.write('s.

Show diffs side-by-side

added added

removed removed

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