← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/plugins/weave_fmt/xml4.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-05-04 12:10:51 UTC
  • mfrom: (5819.1.4 777007-developer-doc)
  • Revision ID: pqm@pqm.ubuntu.com-20110504121051-aovlsmqiivjmc4fc
(jelmer) Small fixes to developer documentation. (Jonathan Riddell)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugins/weave_fmt/xml4.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from bzrlib.xml_serializer import ElementTree, SubElement, Element, Serializer
18
 
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
 
17
from bzrlib.xml_serializer import (
 
18
    Element,
 
19
    SubElement,
 
20
    XMLSerializer,
 
21
    escape_invalid_chars,
 
22
    )
 
23
from bzrlib.inventory import ROOT_ID, Inventory
19
24
import bzrlib.inventory as inventory
20
 
from bzrlib.revision import Revision        
 
25
from bzrlib.revision import Revision
21
26
from bzrlib.errors import BzrError
22
27
 
23
28
 
24
 
class _Serializer_v4(Serializer):
 
29
class _Serializer_v4(XMLSerializer):
25
30
    """Version 0.0.4 serializer
26
31
 
27
 
    You should use the serializer_v4 singleton."""
28
 
    
 
32
    You should use the serializer_v4 singleton.
 
33
 
 
34
    v4 serialisation is no longer supported, only deserialisation.
 
35
    """
 
36
 
29
37
    __slots__ = []
30
 
    
31
 
    def _pack_inventory(self, inv):
32
 
        """Convert to XML Element"""
33
 
        # v4 serialization is not used any more.
34
 
        raise NotImplementedError(self._pack_inventory)
35
 
        e = Element('inventory')
36
 
        e.text = '\n'
37
 
        if inv.root.file_id not in (None, ROOT_ID):
38
 
            e.set('file_id', inv.root.file_id)
39
 
        for path, ie in inv.iter_entries():
40
 
            e.append(self._pack_entry(ie))
41
 
        return e
42
 
 
43
38
 
44
39
    def _pack_entry(self, ie):
45
40
        """Convert InventoryEntry to XML element"""
60
55
        # for now, leaving them as null in the xml form.  in a future
61
56
        # version it will be implied by nested elements.
62
57
        if ie.parent_id != ROOT_ID:
63
 
            assert isinstance(ie.parent_id, basestring)
64
58
            e.set('parent_id', ie.parent_id)
65
59
 
66
60
        e.tail = '\n'
68
62
        return e
69
63
 
70
64
 
71
 
    def _unpack_inventory(self, elt):
 
65
    def _unpack_inventory(self, elt, revision_id=None, entry_cache=None,
 
66
                          return_from_cache=False):
72
67
        """Construct from XML Element
 
68
 
 
69
        :param revision_id: Ignored parameter used by xml5.
73
70
        """
74
 
        assert elt.tag == 'inventory'
75
71
        root_id = elt.get('file_id') or ROOT_ID
76
72
        inv = Inventory(root_id)
77
73
        for e in elt:
78
 
            ie = self._unpack_entry(e)
 
74
            ie = self._unpack_entry(e, entry_cache=entry_cache,
 
75
                                    return_from_cache=return_from_cache)
79
76
            if ie.parent_id == ROOT_ID:
80
77
                ie.parent_id = root_id
81
78
            inv.add(ie)
82
79
        return inv
83
80
 
84
81
 
85
 
    def _unpack_entry(self, elt):
86
 
        assert elt.tag == 'entry'
87
 
 
 
82
    def _unpack_entry(self, elt, entry_cache=None, return_from_cache=False):
88
83
        ## original format inventories don't have a parent_id for
89
84
        ## nodes in the root directory, but it's cleaner to use one
90
85
        ## internally.
132
127
        root.text = '\n'
133
128
 
134
129
        msg = SubElement(root, 'message')
135
 
        msg.text = rev.message
 
130
        msg.text = escape_invalid_chars(rev.message)[0]
136
131
        msg.tail = '\n'
137
132
 
138
133
        if rev.parents:
141
136
            for i, parent_id in enumerate(rev.parents):
142
137
                p = SubElement(pelts, 'revision_ref')
143
138
                p.tail = '\n'
144
 
                assert parent_id
145
139
                p.set('revision_id', parent_id)
146
140
                if i < len(rev.parent_sha1s):
147
141
                    p.set('revision_sha1', rev.parent_sha1s[i])
148
142
        return root
149
143
 
150
 
    
 
144
 
151
145
    def _unpack_revision(self, elt):
152
146
        """XML Element -> Revision object"""
153
 
        
 
147
 
154
148
        # <changeset> is deprecated...
155
149
        if elt.tag not in ('revision', 'changeset'):
156
150
            raise BzrError("unexpected tag in revision file: %r" % elt)
169
163
 
170
164
        if pelts:
171
165
            for p in pelts:
172
 
                assert p.tag == 'revision_ref', \
173
 
                       "bad parent node tag %r" % p.tag
174
166
                rev.parent_ids.append(p.get('revision_id'))
175
167
                rev.parent_sha1s.append(p.get('revision_sha1'))
176
168
            if precursor:
177
169
                # must be consistent
178
170
                prec_parent = rev.parent_ids[0]
179
 
                assert prec_parent == precursor
180
171
        elif precursor:
181
172
            # revisions written prior to 0.0.5 have a single precursor
182
173
            # give as an attribute