|
4237.3.1
by Jelmer Vernooij
Add new module with generic serializer information; keep XML-specific bits in |
1 |
# Copyright (C) 2005, 2006 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 bzrlib import registry |
|
20 |
||
21 |
class Serializer(object): |
|
22 |
"""Abstract object serialize/deserialize"""
|
|
23 |
||
24 |
def write_inventory(self, inv, f): |
|
25 |
"""Write inventory to a file"""
|
|
26 |
raise NotImplementedError(self.write_inventory) |
|
27 |
||
28 |
def write_inventory_to_string(self, inv): |
|
29 |
raise NotImplementedError(self.write_inventory_to_string) |
|
30 |
||
31 |
def read_inventory_from_string(self, string, revision_id=None, |
|
32 |
entry_cache=None): |
|
33 |
"""Read string into an inventory object.
|
|
34 |
||
35 |
:param string: The serialized inventory to read.
|
|
36 |
:param revision_id: If not-None, the expected revision id of the
|
|
37 |
inventory. Some serialisers use this to set the results' root
|
|
38 |
revision. This should be supplied for deserialising all
|
|
39 |
from-repository inventories so that xml5 inventories that were
|
|
40 |
serialised without a revision identifier can be given the right
|
|
41 |
revision id (but not for working tree inventories where users can
|
|
42 |
edit the data without triggering checksum errors or anything).
|
|
43 |
:param entry_cache: An optional cache of InventoryEntry objects. If
|
|
44 |
supplied we will look up entries via (file_id, revision_id) which
|
|
45 |
should map to a valid InventoryEntry (File/Directory/etc) object.
|
|
46 |
"""
|
|
47 |
raise NotImplementedError(self.read_inventory_from_string) |
|
48 |
||
49 |
def read_inventory(self, f, revision_id=None): |
|
50 |
raise NotImplementedError(self.read_inventory) |
|
51 |
||
52 |
def write_revision(self, rev, f): |
|
53 |
raise NotImplementedError(self.write_revision) |
|
54 |
||
55 |
def write_revision_to_string(self, rev): |
|
56 |
raise NotImplementedError(self.write_revision_to_string) |
|
57 |
||
58 |
def read_revision(self, f): |
|
59 |
raise NotImplementedError(self.read_revision) |
|
60 |
||
61 |
def read_revision_from_string(self, xml_string): |
|
62 |
raise NotImplementedError(self.read_revision_from_string) |
|
63 |
||
64 |
||
65 |
class SerializerRegistry(registry.Registry): |
|
66 |
"""Registry for serializer objects"""
|
|
67 |
||
68 |
||
69 |
format_registry = SerializerRegistry() |
|
70 |
format_registry.register_lazy('4', 'bzrlib.xml4', 'serializer_v4') |
|
71 |
format_registry.register_lazy('5', 'bzrlib.xml5', 'serializer_v5') |
|
72 |
format_registry.register_lazy('6', 'bzrlib.xml6', 'serializer_v6') |
|
73 |
format_registry.register_lazy('7', 'bzrlib.xml7', 'serializer_v7') |
|
74 |
format_registry.register_lazy('8', 'bzrlib.xml8', 'serializer_v8') |