14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
17
"""Inventory/revision serialization."""
19
from __future__ import absolute_import
21
from bzrlib import registry
21
from .. import registry
24
24
class Serializer(object):
35
35
raise NotImplementedError(self.write_inventory)
37
def write_inventory_to_string(self, inv):
38
"""Produce a simple string representation of an inventory.
40
Note: this is a *whole inventory* operation, and should only be used
41
sparingly, as it does not scale well with large trees.
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
47
(All serializers as of 2009-07-29 produce XML, but this is not mandated
50
raise NotImplementedError(self.write_inventory_to_string)
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.
56
:param string: The serialized inventory to read.
37
def write_inventory_to_chunks(self, inv):
38
"""Produce a simple bytestring chunk representation of an inventory.
40
Note: this is a *whole inventory* operation, and should only be used
41
sparingly, as it does not scale well with large trees.
43
The requirement for the contents of the string is that it can be passed
44
to read_inventory_from_lines and the result is an identical inventory
47
raise NotImplementedError(self.write_inventory_to_chunks)
49
def write_inventory_to_lines(self, inv):
50
"""Produce a simple lines representation of an inventory.
52
Note: this is a *whole inventory* operation, and should only be used
53
sparingly, as it does not scale well with large trees.
55
The requirement for the contents of the string is that it can be passed
56
to read_inventory_from_lines and the result is an identical inventory
59
raise NotImplementedError(self.write_inventory_to_lines)
61
def read_inventory_from_lines(self, lines, revision_id=None,
62
entry_cache=None, return_from_cache=False):
63
"""Read bytestring chunks into an inventory object.
65
:param lines: The serialized inventory to read.
57
66
:param revision_id: If not-None, the expected revision id of the
58
67
inventory. Some serialisers use this to set the results' root
59
68
revision. This should be supplied for deserialising all
69
78
promises not to mutate the returned inventory entries, but it can
70
79
make some operations significantly faster.
72
raise NotImplementedError(self.read_inventory_from_string)
81
raise NotImplementedError(self.read_inventory_from_lines)
74
83
def read_inventory(self, f, revision_id=None):
75
"""See read_inventory_from_string."""
84
"""See read_inventory_from_lines."""
76
85
raise NotImplementedError(self.read_inventory)
78
def write_revision(self, rev, f):
79
raise NotImplementedError(self.write_revision)
81
87
def write_revision_to_string(self, rev):
82
88
raise NotImplementedError(self.write_revision_to_string)
90
def write_revision_to_lines(self, rev):
91
raise NotImplementedError(self.write_revision_to_lines)
84
93
def read_revision(self, f):
85
94
raise NotImplementedError(self.read_revision)
95
104
format_registry = SerializerRegistry()
96
format_registry.register_lazy('4', 'bzrlib.xml4', 'serializer_v4')
97
format_registry.register_lazy('5', 'bzrlib.xml5', 'serializer_v5')
98
format_registry.register_lazy('6', 'bzrlib.xml6', 'serializer_v6')
99
format_registry.register_lazy('7', 'bzrlib.xml7', 'serializer_v7')
100
format_registry.register_lazy('8', 'bzrlib.xml8', 'serializer_v8')
101
format_registry.register_lazy('9', 'bzrlib.chk_serializer',
102
'chk_serializer_255_bigpage')
103
format_registry.register_lazy('10', 'bzrlib.chk_serializer',
104
'chk_bencode_serializer')
105
format_registry.register_lazy('5', 'breezy.bzr.xml5', 'serializer_v5')
106
format_registry.register_lazy('6', 'breezy.bzr.xml6', 'serializer_v6')
107
format_registry.register_lazy('7', 'breezy.bzr.xml7', 'serializer_v7')
108
format_registry.register_lazy('8', 'breezy.bzr.xml8', 'serializer_v8')
109
format_registry.register_lazy('9', 'breezy.bzr.chk_serializer',
110
'chk_serializer_255_bigpage')
111
format_registry.register_lazy('10', 'breezy.bzr.chk_serializer',
112
'chk_bencode_serializer')