1
# Copyright (C) 2009, 2010 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2009 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
24
24
class Serializer(object):
25
25
"""Inventory and revision serialization/deserialization."""
27
squashes_xml_invalid_characters = False
29
27
def write_inventory(self, inv, f):
30
"""Write inventory to a file.
32
Note: this is a *whole inventory* operation, and should only be used
33
sparingly, as it does not scale well with large trees.
28
"""Write inventory to a file"""
35
29
raise NotImplementedError(self.write_inventory)
37
31
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
32
raise NotImplementedError(self.write_inventory_to_string)
52
34
def read_inventory_from_string(self, string, revision_id=None,
53
entry_cache=None, return_from_cache=False):
54
36
"""Read string into an inventory object.
56
38
:param string: The serialized inventory to read.
64
46
:param entry_cache: An optional cache of InventoryEntry objects. If
65
47
supplied we will look up entries via (file_id, revision_id) which
66
48
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.
72
50
raise NotImplementedError(self.read_inventory_from_string)
74
52
def read_inventory(self, f, revision_id=None):
75
"""See read_inventory_from_string."""
76
53
raise NotImplementedError(self.read_inventory)
78
55
def write_revision(self, rev, f):
98
75
format_registry.register_lazy('6', 'bzrlib.xml6', 'serializer_v6')
99
76
format_registry.register_lazy('7', 'bzrlib.xml7', 'serializer_v7')
100
77
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')