1
# -*- coding: UTF-8 -*-
 
 
3
# This program is free software; you can redistribute it and/or modify
 
 
4
# it under the terms of the GNU General Public License as published by
 
 
5
# the Free Software Foundation; either version 2 of the License, or
 
 
6
# (at your option) any later version.
 
 
8
# This program is distributed in the hope that it will be useful,
 
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
11
# GNU General Public License for more details.
 
 
13
# You should have received a copy of the GNU General Public License
 
 
14
# along with this program; if not, write to the Free Software
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
17
"""XML externalization support."""
 
 
19
# "XML is like violence: if it doesn't solve your problem, you aren't
 
 
20
# using enough of it." -- various
 
 
22
# importing this module is fairly slow because it has to load several
 
 
25
from bzrlib.trace import mutter, warning
 
 
28
    from cElementTree import (ElementTree, SubElement, Element,
 
 
29
                              XMLTreeBuilder, fromstring, tostring)
 
 
31
    mutter('WARNING: using slower ElementTree; consider installing cElementTree'
 
 
32
           " and make sure it's on your PYTHONPATH")
 
 
33
    from util.elementtree.ElementTree import (ElementTree, SubElement,
 
 
34
                                              Element, XMLTreeBuilder,
 
 
37
from bzrlib.errors import BzrError
 
 
40
class Serializer(object):
 
 
41
    """Abstract object serialize/deserialize"""
 
 
42
    def write_inventory(self, inv, f):
 
 
43
        """Write inventory to a file"""
 
 
44
        elt = self._pack_inventory(inv)
 
 
45
        self._write_element(elt, f)
 
 
47
    def write_inventory_to_string(self, inv):
 
 
48
        return tostring(self._pack_inventory(inv)) + '\n'
 
 
50
    def read_inventory_from_string(self, xml_string):
 
 
51
        return self._unpack_inventory(fromstring(xml_string))
 
 
53
    def read_inventory(self, f):
 
 
54
        return self._unpack_inventory(self._read_element(f))
 
 
56
    def write_revision(self, rev, f):
 
 
57
        self._write_element(self._pack_revision(rev), f)
 
 
59
    def write_revision_to_string(self, rev):
 
 
60
        return tostring(self._pack_revision(rev)) + '\n'
 
 
62
    def read_revision(self, f):
 
 
63
        return self._unpack_revision(self._read_element(f))
 
 
65
    def read_revision_from_string(self, xml_string):
 
 
66
        return self._unpack_revision(fromstring(xml_string))
 
 
68
    def _write_element(self, elt, f):
 
 
69
        ElementTree(elt).write(f, 'utf-8')
 
 
72
    def _read_element(self, f):
 
 
73
        return ElementTree().parse(f)