← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/serializer.py

  • Committer: Vincent Ladeuil
  • Date: 2013-08-09 15:09:23 UTC
  • mto: This revision was merged to the branch mainline in revision 6587.
  • Revision ID: v.ladeuil+lp@free.fr-20130809150923-y71dusyorep0hbkt
Fix various typos in docstrings. Rename 'buffer' to 'buf' since it's now a python builtin function.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/serializer.py
 
1
# Copyright (C) 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
"""Inventory/revision serialization."""
 
18
 
 
19
from __future__ import absolute_import
 
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
 
 
32
        Note: this is a *whole inventory* operation, and should only be used
 
33
        sparingly, as it does not scale well with large trees.
 
34
        """
 
35
        raise NotImplementedError(self.write_inventory)
 
36
 
 
37
    def write_inventory_to_string(self, inv):
 
38
        """Produce a simple string representation of an inventory.
 
39
 
 
40
        Note: this is a *whole inventory* operation, and should only be used
 
41
        sparingly, as it does not scale well with large trees.
 
42
 
 
43
        The requirement for the contents of the string is that it can be passed
 
44
        to read_inventory_from_string and the result is an identical inventory
 
45
        in memory.
 
46
 
 
47
        (All serializers as of 2009-07-29 produce XML, but this is not mandated
 
48
        by the interface.)
 
49
        """
 
50
        raise NotImplementedError(self.write_inventory_to_string)
 
51
 
 
52
    def read_inventory_from_string(self, string, revision_id=None,
 
53
                                   entry_cache=None, return_from_cache=False):
 
54
        """Read string into an inventory object.
 
55
 
 
56
        :param string: The serialized inventory to read.
 
57
        :param revision_id: If not-None, the expected revision id of the
 
58
            inventory. Some serialisers use this to set the results' root
 
59
            revision. This should be supplied for deserialising all
 
60
            from-repository inventories so that xml5 inventories that were
 
61
            serialised without a revision identifier can be given the right
 
62
            revision id (but not for working tree inventories where users can
 
63
            edit the data without triggering checksum errors or anything).
 
64
        :param entry_cache: An optional cache of InventoryEntry objects. If
 
65
            supplied we will look up entries via (file_id, revision_id) which
 
66
            should map to a valid InventoryEntry (File/Directory/etc) object.
 
67
        :param return_from_cache: Return entries directly from the cache,
 
68
            rather than copying them first. This is only safe if the caller
 
69
            promises not to mutate the returned inventory entries, but it can
 
70
            make some operations significantly faster.
 
71
        """
 
72
        raise NotImplementedError(self.read_inventory_from_string)
 
73
 
 
74
    def read_inventory(self, f, revision_id=None):
 
75
        """See read_inventory_from_string."""
 
76
        raise NotImplementedError(self.read_inventory)
 
77
 
 
78
    def write_revision(self, rev, f):
 
79
        raise NotImplementedError(self.write_revision)
 
80
 
 
81
    def write_revision_to_string(self, rev):
 
82
        raise NotImplementedError(self.write_revision_to_string)
 
83
 
 
84
    def read_revision(self, f):
 
85
        raise NotImplementedError(self.read_revision)
 
86
 
 
87
    def read_revision_from_string(self, xml_string):
 
88
        raise NotImplementedError(self.read_revision_from_string)
 
89
 
 
90
 
 
91
class SerializerRegistry(registry.Registry):
 
92
    """Registry for serializer objects"""
 
93
 
 
94
 
 
95
format_registry = SerializerRegistry()
 
96
format_registry.register_lazy('5', 'bzrlib.xml5', 'serializer_v5')
 
97
format_registry.register_lazy('6', 'bzrlib.xml6', 'serializer_v6')
 
98
format_registry.register_lazy('7', 'bzrlib.xml7', 'serializer_v7')
 
99
format_registry.register_lazy('8', 'bzrlib.xml8', 'serializer_v8')
 
100
format_registry.register_lazy('9', 'bzrlib.chk_serializer',
 
101
    'chk_serializer_255_bigpage')
 
102
format_registry.register_lazy('10', 'bzrlib.chk_serializer',
 
103
    'chk_bencode_serializer')