/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/serializer.py

  • Committer: Marius Kruger
  • Date: 2010-07-10 21:28:56 UTC
  • mto: (5384.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5385.
  • Revision ID: marius.kruger@enerweb.co.za-20100710212856-uq4ji3go0u5se7hx
* Update documentation
* add NEWS

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/serializer.py
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
16
16
 
 
17
 
17
18
"""Inventory/revision serialization."""
18
19
 
19
 
from __future__ import absolute_import
20
20
 
21
 
from .. import registry
 
21
from bzrlib import registry
22
22
 
23
23
 
24
24
class Serializer(object):
34
34
        """
35
35
        raise NotImplementedError(self.write_inventory)
36
36
 
37
 
    def write_inventory_to_chunks(self, inv):
38
 
        """Produce a simple bytestring chunk 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_lines and the result is an identical inventory
45
 
        in memory.
46
 
        """
47
 
        raise NotImplementedError(self.write_inventory_to_chunks)
48
 
 
49
 
    def write_inventory_to_lines(self, inv):
50
 
        """Produce a simple lines representation of an inventory.
51
 
 
52
 
        Note: this is a *whole inventory* operation, and should only be used
53
 
        sparingly, as it does not scale well with large trees.
54
 
 
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
57
 
        in memory.
58
 
        """
59
 
        raise NotImplementedError(self.write_inventory_to_lines)
60
 
 
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.
64
 
 
65
 
        :param lines: The serialized inventory to read.
 
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.
66
57
        :param revision_id: If not-None, the expected revision id of the
67
58
            inventory. Some serialisers use this to set the results' root
68
59
            revision. This should be supplied for deserialising all
78
69
            promises not to mutate the returned inventory entries, but it can
79
70
            make some operations significantly faster.
80
71
        """
81
 
        raise NotImplementedError(self.read_inventory_from_lines)
 
72
        raise NotImplementedError(self.read_inventory_from_string)
82
73
 
83
74
    def read_inventory(self, f, revision_id=None):
84
 
        """See read_inventory_from_lines."""
 
75
        """See read_inventory_from_string."""
85
76
        raise NotImplementedError(self.read_inventory)
86
77
 
 
78
    def write_revision(self, rev, f):
 
79
        raise NotImplementedError(self.write_revision)
 
80
 
87
81
    def write_revision_to_string(self, rev):
88
82
        raise NotImplementedError(self.write_revision_to_string)
89
83
 
90
 
    def write_revision_to_lines(self, rev):
91
 
        raise NotImplementedError(self.write_revision_to_lines)
92
 
 
93
84
    def read_revision(self, f):
94
85
        raise NotImplementedError(self.read_revision)
95
86
 
102
93
 
103
94
 
104
95
format_registry = SerializerRegistry()
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')
 
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')