/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/xml.py

  • Committer: Martin Pool
  • Date: 2005-09-05 08:00:35 UTC
  • Revision ID: mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9
- start splitting code for xml (de)serialization away from objects
  preparatory to supporting multiple formats by a single library

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml.py
 
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
try:
 
27
    from util.cElementTree import ElementTree, SubElement, Element
 
28
except ImportError:
 
29
    from util.elementtree.ElementTree import ElementTree, SubElement, Element
 
30
 
 
31
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
 
32
        
 
33
 
 
34
 
 
35
class Serializer(object):
 
36
    """Abstract object serialize/deserialize"""
 
37
    def write_inventory(self, inv, f):
 
38
        """Write inventory to a file"""
 
39
        elt = self._pack_inventory(inv)
 
40
        self._write_element(elt, f)
 
41
 
 
42
    def read_inventory(self, f):
 
43
        return self._unpack_inventory(self._read_element(f))
 
44
 
 
45
    def _write_element(self, elt, f):
 
46
        ElementTree(elt).write(f, 'utf-8')
 
47
        f.write('\n')
 
48
 
 
49
    def _read_element(self, f):
 
50
        return ElementTree().parse(f)
 
51
 
 
52
 
 
53
 
 
54
class _Serializer_v4(Serializer):
 
55
    """Version 0.0.4 serializer"""
 
56
    
 
57
    __slots__ = []
 
58
    
 
59
    def _pack_inventory(self, inv):
 
60
        """Convert to XML Element"""
 
61
        e = Element('inventory')
 
62
        e.text = '\n'
 
63
        if inv.root.file_id not in (None, ROOT_ID):
 
64
            e.set('file_id', inv.root.file_id)
 
65
        for path, ie in inv.iter_entries():
 
66
            e.append(self._pack_entry(ie))
 
67
        return e
 
68
 
 
69
 
 
70
    def _pack_entry(self, ie):
 
71
        """Convert InventoryEntry to XML element"""
 
72
        e = Element('entry')
 
73
        e.set('name', ie.name)
 
74
        e.set('file_id', ie.file_id)
 
75
        e.set('kind', ie.kind)
 
76
 
 
77
        if ie.text_size != None:
 
78
            e.set('text_size', '%d' % ie.text_size)
 
79
 
 
80
        for f in ['text_id', 'text_sha1']:
 
81
            v = getattr(ie, f)
 
82
            if v != None:
 
83
                e.set(f, v)
 
84
 
 
85
        # to be conservative, we don't externalize the root pointers
 
86
        # for now, leaving them as null in the xml form.  in a future
 
87
        # version it will be implied by nested elements.
 
88
        if ie.parent_id != ROOT_ID:
 
89
            assert isinstance(ie.parent_id, basestring)
 
90
            e.set('parent_id', ie.parent_id)
 
91
 
 
92
        e.tail = '\n'
 
93
 
 
94
        return e
 
95
 
 
96
 
 
97
    def _unpack_inventory(self, elt):
 
98
        """Construct from XML Element
 
99
        """
 
100
        assert elt.tag == 'inventory'
 
101
        root_id = elt.get('file_id') or ROOT_ID
 
102
        inv = Inventory(root_id)
 
103
        for e in elt:
 
104
            ie = self._unpack_entry(e)
 
105
            if ie.parent_id == ROOT_ID:
 
106
                ie.parent_id = root_id
 
107
            inv.add(ie)
 
108
        return inv
 
109
 
 
110
 
 
111
    def _unpack_entry(self, elt):
 
112
        assert elt.tag == 'entry'
 
113
 
 
114
        ## original format inventories don't have a parent_id for
 
115
        ## nodes in the root directory, but it's cleaner to use one
 
116
        ## internally.
 
117
        parent_id = elt.get('parent_id')
 
118
        if parent_id == None:
 
119
            parent_id = ROOT_ID
 
120
 
 
121
        ie = InventoryEntry(elt.get('file_id'),
 
122
                              elt.get('name'),
 
123
                              elt.get('kind'),
 
124
                              parent_id)
 
125
        ie.text_id = elt.get('text_id')
 
126
        ie.text_sha1 = elt.get('text_sha1')
 
127
 
 
128
        ## mutter("read inventoryentry: %r" % (elt.attrib))
 
129
 
 
130
        v = elt.get('text_size')
 
131
        ie.text_size = v and int(v)
 
132
 
 
133
        return ie
 
134
 
 
135
 
 
136
"""singleton instance"""
 
137
serializer_v4 = _Serializer_v4()
 
138
 
 
139
 
 
140
 
 
141
 
 
142
 
 
143
def pack_xml(o, f):
 
144
    """Write object o to file f as XML.
 
145
 
 
146
    o must provide a to_element method.
 
147
    """
 
148
    ElementTree(o.to_element()).write(f, 'utf-8')
 
149
    f.write('\n')
 
150
 
 
151
 
 
152
def unpack_xml(cls, f):
 
153
    return cls.from_element(ElementTree().parse(f))