← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml_serializer.py

Merge Jan's benchmarks.

Show diffs side-by-side

added added

removed removed

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