← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/serializer.py

Add some better docs to write_inventory to clarify performance, etc.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/serializer.py
27
27
    squashes_xml_invalid_characters = False
28
28
 
29
29
    def write_inventory(self, inv, f):
30
 
        """Write inventory to a file"""
 
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
        """
31
35
        raise NotImplementedError(self.write_inventory)
32
36
 
33
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
        """
34
50
        raise NotImplementedError(self.write_inventory_to_string)
35
51
 
36
52
    def read_inventory_from_string(self, string, revision_id=None,
52
68
        raise NotImplementedError(self.read_inventory_from_string)
53
69
 
54
70
    def read_inventory(self, f, revision_id=None):
 
71
        """See read_inventory_from_string."""
55
72
        raise NotImplementedError(self.read_inventory)
56
73
 
57
74
    def write_revision(self, rev, f):