← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml5.py

Turn completion assertions into separate methods.

Many common assertions used to be expressed as arguments to the complete
method.  This makes the checks more explicit, and the code easier to read.

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 bzrlib import (
18
 
    cache_utf8,
19
 
    errors,
20
 
    inventory,
21
 
    xml6,
22
 
    xml8,
23
 
    )
24
 
 
25
 
class Serializer_v5(xml6.Serializer_v6):
26
 
    """Version 5 serializer
27
 
 
28
 
    Packs objects into XML and vice versa.
29
 
    """
30
 
    format_num = '5'
31
 
    root_id = inventory.ROOT_ID
32
 
 
33
 
    def _unpack_inventory(self, elt, revision_id, entry_cache=None,
34
 
                          return_from_cache=False):
35
 
        """Construct from XML Element
36
 
        """
37
 
        root_id = elt.get('file_id') or inventory.ROOT_ID
38
 
        root_id = xml8._get_utf8_or_ascii(root_id)
39
 
 
40
 
        format = elt.get('format')
41
 
        if format is not None:
42
 
            if format != '5':
43
 
                raise errors.BzrError("invalid format version %r on inventory"
44
 
                                      % format)
45
 
        data_revision_id = elt.get('revision_id')
46
 
        if data_revision_id is not None:
47
 
            revision_id = cache_utf8.encode(data_revision_id)
48
 
        inv = inventory.Inventory(root_id, revision_id=revision_id)
49
 
        # Optimizations tested
50
 
        #   baseline w/entry cache  2.85s
51
 
        #   using inv._byid         2.55s
52
 
        #   avoiding attributes     2.46s
53
 
        #   adding assertions       2.50s
54
 
        #   last_parent cache       2.52s (worse, removed)
55
 
        unpack_entry = self._unpack_entry
56
 
        byid = inv._byid
57
 
        for e in elt:
58
 
            ie = unpack_entry(e, entry_cache=entry_cache,
59
 
                              return_from_cache=return_from_cache)
60
 
            parent_id = ie.parent_id
61
 
            if parent_id is None:
62
 
                ie.parent_id = parent_id = root_id
63
 
            try:
64
 
                parent = byid[parent_id]
65
 
            except KeyError:
66
 
                raise errors.BzrError("parent_id {%s} not in inventory"
67
 
                                      % (parent_id,))
68
 
            if ie.file_id in byid:
69
 
                raise errors.DuplicateFileId(ie.file_id,
70
 
                                             byid[ie.file_id])
71
 
            if ie.name in parent.children:
72
 
                raise errors.BzrError("%s is already versioned"
73
 
                    % (osutils.pathjoin(inv.id2path(parent_id),
74
 
                       ie.name).encode('utf-8'),))
75
 
            parent.children[ie.name] = ie
76
 
            byid[ie.file_id] = ie
77
 
        if revision_id is not None:
78
 
            inv.root.revision = revision_id
79
 
        self._check_cache_size(len(inv), entry_cache)
80
 
        return inv
81
 
 
82
 
    def _check_revisions(self, inv):
83
 
        """Extension point for subclasses to check during serialisation.
84
 
 
85
 
        In this version, no checking is done.
86
 
 
87
 
        :param inv: An inventory about to be serialised, to be checked.
88
 
        :raises: AssertionError if an error has occurred.
89
 
        """
90
 
 
91
 
    def _append_inventory_root(self, append, inv):
92
 
        """Append the inventory root to output."""
93
 
        if inv.root.file_id not in (None, inventory.ROOT_ID):
94
 
            fileid1 = ' file_id="'
95
 
            fileid2 = xml8._encode_and_escape(inv.root.file_id)
96
 
        else:
97
 
            fileid1 = ""
98
 
            fileid2 = ""
99
 
        if inv.revision_id is not None:
100
 
            revid1 = ' revision_id="'
101
 
            revid2 = xml8._encode_and_escape(inv.revision_id)
102
 
        else:
103
 
            revid1 = ""
104
 
            revid2 = ""
105
 
        append('<inventory%s%s format="5"%s%s>\n' % (
106
 
            fileid1, fileid2, revid1, revid2))
107
 
 
108
 
 
109
 
serializer_v5 = Serializer_v5()