← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml5.py

  • Committer: Martin Pool
  • Date: 2009-06-19 06:21:13 UTC
  • mto: This revision was merged to the branch mainline in revision 4558.
  • Revision ID: mbp@sourcefrog.net-20090619062113-019bp0a3bl2y4nkx
Un-soft-deprecate _supports_progress - still useful

Show diffs side-by-side

added added

removed removed

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