← 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: Patch Queue Manager
  • Date: 2011-09-22 14:12:18 UTC
  • mfrom: (6155.3.1 jam)
  • Revision ID: pqm@pqm.ubuntu.com-20110922141218-86s4uu6nqvourw4f
(jameinel) Cleanup comments bzrlib/smart/__init__.py (John A Meinel)

Show diffs side-by-side

added added

removed removed

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