← 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: Vincent Ladeuil
  • Date: 2013-08-09 15:09:23 UTC
  • mto: This revision was merged to the branch mainline in revision 6587.
  • Revision ID: v.ladeuil+lp@free.fr-20130809150923-y71dusyorep0hbkt
Fix various typos in docstrings. Rename 'buffer' to 'buf' since it's now a python builtin function.

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
4
6
# (at your option) any later version.
5
 
 
 
7
#
6
8
# This program is distributed in the hope that it will be useful,
7
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
8
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
9
11
# GNU General Public License for more details.
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 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 __future__ import absolute_import
 
18
 
 
19
from bzrlib.xml_serializer import (
 
20
    Element,
 
21
    SubElement,
 
22
    XMLSerializer,
 
23
    escape_invalid_chars,
 
24
    )
 
25
from bzrlib.inventory import ROOT_ID, Inventory
18
26
import bzrlib.inventory as inventory
19
 
from bzrlib.revision import Revision        
 
27
from bzrlib.revision import Revision
20
28
from bzrlib.errors import BzrError
21
29
 
22
30
 
23
 
 
24
 
 
25
 
 
26
 
 
27
 
class _Serializer_v4(Serializer):
 
31
class _Serializer_v4(XMLSerializer):
28
32
    """Version 0.0.4 serializer
29
33
 
30
 
    You should use the serialzer_v4 singleton."""
31
 
    
 
34
    You should use the serializer_v4 singleton.
 
35
 
 
36
    v4 serialisation is no longer supported, only deserialisation.
 
37
    """
 
38
 
32
39
    __slots__ = []
33
 
    
34
 
    def _pack_inventory(self, inv):
35
 
        """Convert to XML Element"""
36
 
        e = Element('inventory')
37
 
        e.text = '\n'
38
 
        if inv.root.file_id not in (None, ROOT_ID):
39
 
            e.set('file_id', inv.root.file_id)
40
 
        for path, ie in inv.iter_entries():
41
 
            e.append(self._pack_entry(ie))
42
 
        return e
43
 
 
44
40
 
45
41
    def _pack_entry(self, ie):
46
42
        """Convert InventoryEntry to XML element"""
49
45
        e.set('file_id', ie.file_id)
50
46
        e.set('kind', ie.kind)
51
47
 
52
 
        if ie.text_size != None:
 
48
        if ie.text_size is not None:
53
49
            e.set('text_size', '%d' % ie.text_size)
54
50
 
55
51
        for f in ['text_id', 'text_sha1', 'symlink_target']:
56
52
            v = getattr(ie, f)
57
 
            if v != None:
 
53
            if v is not None:
58
54
                e.set(f, v)
59
55
 
60
56
        # to be conservative, we don't externalize the root pointers
61
57
        # for now, leaving them as null in the xml form.  in a future
62
58
        # version it will be implied by nested elements.
63
59
        if ie.parent_id != ROOT_ID:
64
 
            assert isinstance(ie.parent_id, basestring)
65
60
            e.set('parent_id', ie.parent_id)
66
61
 
67
62
        e.tail = '\n'
69
64
        return e
70
65
 
71
66
 
72
 
    def _unpack_inventory(self, elt):
 
67
    def _unpack_inventory(self, elt, revision_id=None, entry_cache=None,
 
68
                          return_from_cache=False):
73
69
        """Construct from XML Element
 
70
 
 
71
        :param revision_id: Ignored parameter used by xml5.
74
72
        """
75
 
        assert elt.tag == 'inventory'
76
73
        root_id = elt.get('file_id') or ROOT_ID
77
74
        inv = Inventory(root_id)
78
75
        for e in elt:
79
 
            ie = self._unpack_entry(e)
 
76
            ie = self._unpack_entry(e, entry_cache=entry_cache,
 
77
                                    return_from_cache=return_from_cache)
80
78
            if ie.parent_id == ROOT_ID:
81
79
                ie.parent_id = root_id
82
80
            inv.add(ie)
83
81
        return inv
84
82
 
85
83
 
86
 
    def _unpack_entry(self, elt):
87
 
        assert elt.tag == 'entry'
88
 
 
 
84
    def _unpack_entry(self, elt, entry_cache=None, return_from_cache=False):
89
85
        ## original format inventories don't have a parent_id for
90
86
        ## nodes in the root directory, but it's cleaner to use one
91
87
        ## internally.
92
88
        parent_id = elt.get('parent_id')
93
 
        if parent_id == None:
 
89
        if parent_id is None:
94
90
            parent_id = ROOT_ID
95
91
 
96
92
        kind = elt.get('kind')
133
129
        root.text = '\n'
134
130
 
135
131
        msg = SubElement(root, 'message')
136
 
        msg.text = rev.message
 
132
        msg.text = escape_invalid_chars(rev.message)[0]
137
133
        msg.tail = '\n'
138
134
 
139
135
        if rev.parents:
142
138
            for i, parent_id in enumerate(rev.parents):
143
139
                p = SubElement(pelts, 'revision_ref')
144
140
                p.tail = '\n'
145
 
                assert parent_id
146
141
                p.set('revision_id', parent_id)
147
142
                if i < len(rev.parent_sha1s):
148
143
                    p.set('revision_sha1', rev.parent_sha1s[i])
149
144
        return root
150
145
 
151
 
    
 
146
 
152
147
    def _unpack_revision(self, elt):
153
148
        """XML Element -> Revision object"""
154
 
        
 
149
 
155
150
        # <changeset> is deprecated...
156
151
        if elt.tag not in ('revision', 'changeset'):
157
152
            raise BzrError("unexpected tag in revision file: %r" % elt)
170
165
 
171
166
        if pelts:
172
167
            for p in pelts:
173
 
                assert p.tag == 'revision_ref', \
174
 
                       "bad parent node tag %r" % p.tag
175
168
                rev.parent_ids.append(p.get('revision_id'))
176
169
                rev.parent_sha1s.append(p.get('revision_sha1'))
177
170
            if precursor:
178
171
                # must be consistent
179
172
                prec_parent = rev.parent_ids[0]
180
 
                assert prec_parent == precursor
181
173
        elif precursor:
182
174
            # revisions written prior to 0.0.5 have a single precursor
183
175
            # give as an attribute