~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/serializer.py

  • Committer: Martin Pool
  • Date: 2007-04-04 06:17:31 UTC
  • mto: This revision was merged to the branch mainline in revision 2397.
  • Revision ID: mbp@sourcefrog.net-20070404061731-tt2xrzllqhbodn83
Contents of TODO file moved into bug tracker

Show diffs side-by-side

added added

removed removed

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