← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml5.py

Merge bzr.dev (and fix NEWS)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml5.py
1
 
# Copyright (C) 2008, 2009, 2010 Canonical Ltd
2
 
#
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
#
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
#
13
 
# You should have received a copy of the GNU General Public License
14
 
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
from __future__ import absolute_import
18
 
 
19
 
from bzrlib import (
20
 
    cache_utf8,
21
 
    errors,
22
 
    inventory,
23
 
    xml6,
24
 
    )
25
 
from bzrlib.xml_serializer import (
26
 
    encode_and_escape,
27
 
    get_utf8_or_ascii,
28
 
    unpack_inventory_entry,
29
 
    )
30
 
 
31
 
 
32
 
class Serializer_v5(xml6.Serializer_v6):
33
 
    """Version 5 serializer
34
 
 
35
 
    Packs objects into XML and vice versa.
36
 
    """
37
 
    format_num = '5'
38
 
    root_id = inventory.ROOT_ID
39
 
 
40
 
    def _unpack_inventory(self, elt, revision_id, entry_cache=None,
41
 
                          return_from_cache=False):
42
 
        """Construct from XML Element
43
 
        """
44
 
        root_id = elt.get('file_id') or inventory.ROOT_ID
45
 
        root_id = get_utf8_or_ascii(root_id)
46
 
 
47
 
        format = elt.get('format')
48
 
        if format is not None:
49
 
            if format != '5':
50
 
                raise errors.BzrError("invalid format version %r on inventory"
51
 
                                      % format)
52
 
        data_revision_id = elt.get('revision_id')
53
 
        if data_revision_id is not None:
54
 
            revision_id = cache_utf8.encode(data_revision_id)
55
 
        inv = inventory.Inventory(root_id, revision_id=revision_id)
56
 
        # Optimizations tested
57
 
        #   baseline w/entry cache  2.85s
58
 
        #   using inv._byid         2.55s
59
 
        #   avoiding attributes     2.46s
60
 
        #   adding assertions       2.50s
61
 
        #   last_parent cache       2.52s (worse, removed)
62
 
        byid = inv._byid
63
 
        for e in elt:
64
 
            ie = unpack_inventory_entry(e, entry_cache=entry_cache,
65
 
                              return_from_cache=return_from_cache)
66
 
            parent_id = ie.parent_id
67
 
            if parent_id is None:
68
 
                ie.parent_id = parent_id = root_id
69
 
            try:
70
 
                parent = byid[parent_id]
71
 
            except KeyError:
72
 
                raise errors.BzrError("parent_id {%s} not in inventory"
73
 
                                      % (parent_id,))
74
 
            if ie.file_id in byid:
75
 
                raise errors.DuplicateFileId(ie.file_id,
76
 
                                             byid[ie.file_id])
77
 
            if ie.name in parent.children:
78
 
                raise errors.BzrError("%s is already versioned"
79
 
                    % (osutils.pathjoin(inv.id2path(parent_id),
80
 
                       ie.name).encode('utf-8'),))
81
 
            parent.children[ie.name] = ie
82
 
            byid[ie.file_id] = ie
83
 
        if revision_id is not None:
84
 
            inv.root.revision = revision_id
85
 
        self._check_cache_size(len(inv), entry_cache)
86
 
        return inv
87
 
 
88
 
    def _check_revisions(self, inv):
89
 
        """Extension point for subclasses to check during serialisation.
90
 
 
91
 
        In this version, no checking is done.
92
 
 
93
 
        :param inv: An inventory about to be serialised, to be checked.
94
 
        :raises: AssertionError if an error has occurred.
95
 
        """
96
 
 
97
 
    def _append_inventory_root(self, append, inv):
98
 
        """Append the inventory root to output."""
99
 
        if inv.root.file_id not in (None, inventory.ROOT_ID):
100
 
            fileid1 = ' file_id="'
101
 
            fileid2 = encode_and_escape(inv.root.file_id)
102
 
        else:
103
 
            fileid1 = ""
104
 
            fileid2 = ""
105
 
        if inv.revision_id is not None:
106
 
            revid1 = ' revision_id="'
107
 
            revid2 = encode_and_escape(inv.revision_id)
108
 
        else:
109
 
            revid1 = ""
110
 
            revid2 = ""
111
 
        append('<inventory%s%s format="5"%s%s>\n' % (
112
 
            fileid1, fileid2, revid1, revid2))
113
 
 
114
 
 
115
 
serializer_v5 = Serializer_v5()