← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml_serializer.py

  • Committer: Martin Pool
  • Date: 2006-11-03 01:51:26 UTC
  • mto: This revision was merged to the branch mainline in revision 2119.
  • Revision ID: mbp@sourcefrog.net-20061103015126-427cb97a48404f42
Error deprecations will come in for 0.13

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.trace import mutter, warning
26
26
 
27
27
try:
28
 
    from cElementTree import Element, ElementTree, SubElement
 
28
    try:
 
29
        # it's in this package in python2.5
 
30
        from xml.etree.cElementTree import (ElementTree, SubElement, Element,
 
31
            XMLTreeBuilder, fromstring, tostring)
 
32
        import xml.etree as elementtree
 
33
    except ImportError:
 
34
        from cElementTree import (ElementTree, SubElement, Element,
 
35
                                  XMLTreeBuilder, fromstring, tostring)
 
36
        import elementtree
 
37
    ParseError = SyntaxError
29
38
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')
 
39
    mutter('WARNING: using slower ElementTree; consider installing cElementTree'
 
40
           " and make sure it's on your PYTHONPATH")
 
41
    # this copy is shipped with bzr
 
42
    from util.elementtree.ElementTree import (ElementTree, SubElement,
 
43
                                              Element, XMLTreeBuilder,
 
44
                                              fromstring, tostring)
 
45
    import util.elementtree as elementtree
 
46
    from xml.parsers.expat import ExpatError as ParseError
 
47
 
 
48
from bzrlib import errors
 
49
 
 
50
 
 
51
class Serializer(object):
 
52
    """Abstract object serialize/deserialize"""
 
53
    def write_inventory(self, inv, f):
 
54
        """Write inventory to a file"""
 
55
        elt = self._pack_inventory(inv)
 
56
        self._write_element(elt, f)
 
57
 
 
58
    def write_inventory_to_string(self, inv):
 
59
        return tostring(self._pack_inventory(inv)) + '\n'
 
60
 
 
61
    def read_inventory_from_string(self, xml_string):
 
62
        try:
 
63
            return self._unpack_inventory(fromstring(xml_string))
 
64
        except ParseError, e:
 
65
            raise errors.UnexpectedInventoryFormat(e)
 
66
 
 
67
    def read_inventory(self, f):
 
68
        try:
 
69
            return self._unpack_inventory(self._read_element(f))
 
70
        except ParseError, e:
 
71
            raise errors.UnexpectedInventoryFormat(e)
 
72
 
 
73
    def write_revision(self, rev, f):
 
74
        self._write_element(self._pack_revision(rev), f)
 
75
 
 
76
    def write_revision_to_string(self, rev):
 
77
        return tostring(self._pack_revision(rev)) + '\n'
 
78
 
 
79
    def read_revision(self, f):
 
80
        return self._unpack_revision(self._read_element(f))
 
81
 
 
82
    def read_revision_from_string(self, xml_string):
 
83
        return self._unpack_revision(fromstring(xml_string))
 
84
 
 
85
    def _write_element(self, elt, f):
 
86
        ElementTree(elt).write(f, 'utf-8')
41
87
        f.write('\n')
42
88
 
43
 
    def read_xml(cls, f):
44
 
        return cls.from_element(ElementTree().parse(f))
45
 
 
46
 
    read_xml = classmethod(read_xml)
47
 
 
48
 
 
49
 
 
 
89
    def _read_element(self, f):
 
90
        return ElementTree().parse(f)
 
91
 
 
92
 
 
93
# performance tuning for elementree's serialiser. This should be
 
94
# sent upstream - RBC 20060523.
 
95
# the functions here are patched into elementtree at runtime.
 
96
import re
 
97
escape_re = re.compile("[&'\"<>]")
 
98
escape_map = {
 
99
    "&":'&amp;',
 
100
    "'":"&apos;", # FIXME: overkill
 
101
    "\"":"&quot;",
 
102
    "<":"&lt;",
 
103
    ">":"&gt;",
 
104
    }
 
105
def _escape_replace(match, map=escape_map):
 
106
    return map[match.group()]
 
107
 
 
108
def _escape_attrib(text, encoding=None, replace=None):
 
109
    # escape attribute value
 
110
    try:
 
111
        if encoding:
 
112
            try:
 
113
                text = elementtree.ElementTree._encode(text, encoding)
 
114
            except UnicodeError:
 
115
                return elementtree.ElementTree._encode_entity(text)
 
116
        if replace is None:
 
117
            return escape_re.sub(_escape_replace, text)
 
118
        else:
 
119
            text = replace(text, "&", "&amp;")
 
120
            text = replace(text, "'", "&apos;") # FIXME: overkill
 
121
            text = replace(text, "\"", "&quot;")
 
122
            text = replace(text, "<", "&lt;")
 
123
            text = replace(text, ">", "&gt;")
 
124
            return text
 
125
    except (TypeError, AttributeError):
 
126
        elementtree.ElementTree._raise_serialization_error(text)
 
127
 
 
128
elementtree.ElementTree._escape_attrib = _escape_attrib
 
129
 
 
130
escape_cdata_re = re.compile("[&<>]")
 
131
escape_cdata_map = {
 
132
    "&":'&amp;',
 
133
    "<":"&lt;",
 
134
    ">":"&gt;",
 
135
    }
 
136
def _escape_cdata_replace(match, map=escape_cdata_map):
 
137
    return map[match.group()]
 
138
 
 
139
def _escape_cdata(text, encoding=None, replace=None):
 
140
    # escape character data
 
141
    try:
 
142
        if encoding:
 
143
            try:
 
144
                text = elementtree.ElementTree._encode(text, encoding)
 
145
            except UnicodeError:
 
146
                return elementtree.ElementTree._encode_entity(text)
 
147
        if replace is None:
 
148
            return escape_cdata_re.sub(_escape_cdata_replace, text)
 
149
        else:
 
150
            text = replace(text, "&", "&amp;")
 
151
            text = replace(text, "<", "&lt;")
 
152
            text = replace(text, ">", "&gt;")
 
153
            return text
 
154
    except (TypeError, AttributeError):
 
155
        elementtree.ElementTree._raise_serialization_error(text)
 
156
 
 
157
elementtree.ElementTree._escape_cdata = _escape_cdata