← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/serializer.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/serializer.py
 
1
# Copyright (C) 2005, 2006, 2009 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
 
 
18
"""Inventory/revision serialization."""
 
19
 
 
20
 
 
21
from bzrlib import registry
 
22
 
 
23
 
 
24
class Serializer(object):
 
25
    """Inventory and revision serialization/deserialization."""
 
26
 
 
27
    squashes_xml_invalid_characters = False
 
28
 
 
29
    def write_inventory(self, inv, f):
 
30
        """Write inventory to a file"""
 
31
        raise NotImplementedError(self.write_inventory)
 
32
 
 
33
    def write_inventory_to_string(self, inv):
 
34
        raise NotImplementedError(self.write_inventory_to_string)
 
35
 
 
36
    def read_inventory_from_string(self, string, revision_id=None,
 
37
                                   entry_cache=None):
 
38
        """Read string into an inventory object.
 
39
 
 
40
        :param string: The serialized inventory to read.
 
41
        :param revision_id: If not-None, the expected revision id of the
 
42
            inventory. Some serialisers use this to set the results' root
 
43
            revision. This should be supplied for deserialising all
 
44
            from-repository inventories so that xml5 inventories that were
 
45
            serialised without a revision identifier can be given the right
 
46
            revision id (but not for working tree inventories where users can
 
47
            edit the data without triggering checksum errors or anything).
 
48
        :param entry_cache: An optional cache of InventoryEntry objects. If
 
49
            supplied we will look up entries via (file_id, revision_id) which
 
50
            should map to a valid InventoryEntry (File/Directory/etc) object.
 
51
        """
 
52
        raise NotImplementedError(self.read_inventory_from_string)
 
53
 
 
54
    def read_inventory(self, f, revision_id=None):
 
55
        raise NotImplementedError(self.read_inventory)
 
56
 
 
57
    def write_revision(self, rev, f):
 
58
        raise NotImplementedError(self.write_revision)
 
59
 
 
60
    def write_revision_to_string(self, rev):
 
61
        raise NotImplementedError(self.write_revision_to_string)
 
62
 
 
63
    def read_revision(self, f):
 
64
        raise NotImplementedError(self.read_revision)
 
65
 
 
66
    def read_revision_from_string(self, xml_string):
 
67
        raise NotImplementedError(self.read_revision_from_string)
 
68
 
 
69
 
 
70
class SerializerRegistry(registry.Registry):
 
71
    """Registry for serializer objects"""
 
72
 
 
73
 
 
74
format_registry = SerializerRegistry()
 
75
format_registry.register_lazy('4', 'bzrlib.xml4', 'serializer_v4')
 
76
format_registry.register_lazy('5', 'bzrlib.xml5', 'serializer_v5')
 
77
format_registry.register_lazy('6', 'bzrlib.xml6', 'serializer_v6')
 
78
format_registry.register_lazy('7', 'bzrlib.xml7', 'serializer_v7')
 
79
format_registry.register_lazy('8', 'bzrlib.xml8', 'serializer_v8')
 
80
format_registry.register_lazy('9', 'bzrlib.chk_serializer',
 
81
    'chk_serializer_255_bigpage')
 
82
format_registry.register_lazy('10', 'bzrlib.chk_serializer',
 
83
    'chk_bencode_serializer')