~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml.py

  • Committer: Martin Pool
  • Date: 2005-06-30 10:00:57 UTC
  • mto: This revision was merged to the branch mainline in revision 852.
  • Revision ID: mbp@sourcefrog.net-20050630100057-32a93074b0f1faa8
doc

Show diffs side-by-side

added added

removed removed

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