/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/xml_serializer.py

First attempt to merge .dev and resolve the conflicts (but tests are 
failing)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml_serializer.py
1
 
# -*- coding: UTF-8 -*-
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
2
#
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
22
22
# importing this module is fairly slow because it has to load several
23
23
# ElementTree bits
24
24
 
 
25
from bzrlib import registry
25
26
from bzrlib.trace import mutter, warning
26
27
 
27
28
try:
28
 
    from cElementTree import (ElementTree, SubElement, Element,
29
 
                              XMLTreeBuilder, fromstring, tostring)
30
 
    import elementtree
 
29
    try:
 
30
        # it's in this package in python2.5
 
31
        from xml.etree.cElementTree import (ElementTree, SubElement, Element,
 
32
            XMLTreeBuilder, fromstring, tostring)
 
33
        import xml.etree as elementtree
 
34
    except ImportError:
 
35
        from cElementTree import (ElementTree, SubElement, Element,
 
36
                                  XMLTreeBuilder, fromstring, tostring)
 
37
        import elementtree.ElementTree
 
38
    ParseError = SyntaxError
31
39
except ImportError:
32
40
    mutter('WARNING: using slower ElementTree; consider installing cElementTree'
33
41
           " and make sure it's on your PYTHONPATH")
 
42
    # this copy is shipped with bzr
34
43
    from util.elementtree.ElementTree import (ElementTree, SubElement,
35
44
                                              Element, XMLTreeBuilder,
36
45
                                              fromstring, tostring)
37
46
    import util.elementtree as elementtree
 
47
    from xml.parsers.expat import ExpatError as ParseError
38
48
 
39
49
from bzrlib import errors
40
50
 
41
51
 
42
52
class Serializer(object):
43
53
    """Abstract object serialize/deserialize"""
 
54
 
44
55
    def write_inventory(self, inv, f):
45
56
        """Write inventory to a file"""
46
 
        elt = self._pack_inventory(inv)
47
 
        self._write_element(elt, f)
 
57
        raise NotImplementedError(self.write_inventory)
48
58
 
49
59
    def write_inventory_to_string(self, inv):
50
 
        return tostring(self._pack_inventory(inv)) + '\n'
51
 
 
52
 
    def read_inventory_from_string(self, xml_string):
 
60
        raise NotImplementedError(self.write_inventory_to_string)
 
61
 
 
62
    def read_inventory_from_string(self, xml_string, revision_id=None):
 
63
        """Read xml_string into an inventory object.
 
64
 
 
65
        :param xml_string: The xml to read.
 
66
        :param revision_id: If not-None, the expected revision id of the
 
67
            inventory. Some serialisers use this to set the results' root
 
68
            revision. This should be supplied for deserialising all
 
69
            from-repository inventories so that xml5 inventories that were
 
70
            serialised without a revision identifier can be given the right
 
71
            revision id (but not for working tree inventories where users can
 
72
            edit the data without triggering checksum errors or anything).
 
73
        """
53
74
        try:
54
 
            return self._unpack_inventory(fromstring(xml_string))
55
 
        except SyntaxError, e:
 
75
            return self._unpack_inventory(fromstring(xml_string), revision_id)
 
76
        except ParseError, e:
56
77
            raise errors.UnexpectedInventoryFormat(e)
57
78
 
58
 
    def read_inventory(self, f):
 
79
    def read_inventory(self, f, revision_id=None):
59
80
        try:
60
 
            return self._unpack_inventory(self._read_element(f))
61
 
        except SyntaxError, e:
 
81
            return self._unpack_inventory(self._read_element(f),
 
82
                revision_id=None)
 
83
        except ParseError, e:
62
84
            raise errors.UnexpectedInventoryFormat(e)
63
85
 
64
86
    def write_revision(self, rev, f):
146
168
        elementtree.ElementTree._raise_serialization_error(text)
147
169
 
148
170
elementtree.ElementTree._escape_cdata = _escape_cdata
 
171
 
 
172
 
 
173
class SerializerRegistry(registry.Registry):
 
174
    """Registry for serializer objects"""
 
175
 
 
176
 
 
177
format_registry = SerializerRegistry()
 
178
format_registry.register_lazy('4', 'bzrlib.xml4', 'serializer_v4')
 
179
format_registry.register_lazy('5', 'bzrlib.xml5', 'serializer_v5')
 
180
format_registry.register_lazy('6', 'bzrlib.xml6', 'serializer_v6')
 
181
format_registry.register_lazy('7', 'bzrlib.xml7', 'serializer_v7')
 
182
format_registry.register_lazy('8', 'bzrlib.xml8', 'serializer_v8')