← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml.py

  • Committer: Robert Collins
  • Date: 2005-12-24 02:20:45 UTC
  • mto: (1185.50.57 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1550.
  • Revision ID: robertc@robertcollins.net-20051224022045-14efc8dfa0e1a4e9
Start tests for api usage.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml.py
1
 
#! /usr/bin/env python
2
1
# -*- coding: UTF-8 -*-
3
2
 
4
3
# This program is free software; you can redistribute it and/or modify
23
22
# importing this module is fairly slow because it has to load several
24
23
# ElementTree bits
25
24
 
 
25
from bzrlib.trace import mutter, warning
 
26
 
26
27
try:
27
 
    from util.cElementTree import ElementTree, SubElement, Element
 
28
    from cElementTree import (ElementTree, SubElement, Element,
 
29
                              XMLTreeBuilder, fromstring, tostring)
28
30
except ImportError:
29
 
    from util.elementtree.ElementTree import ElementTree, SubElement, Element
 
31
    mutter('WARNING: using slower ElementTree; consider installing cElementTree'
 
32
           " and make sure it's on your PYTHONPATH")
 
33
    from util.elementtree.ElementTree import (ElementTree, SubElement,
 
34
                                              Element, XMLTreeBuilder,
 
35
                                              fromstring, tostring)
30
36
 
31
 
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
32
 
        
 
37
from bzrlib.errors import BzrError
33
38
 
34
39
 
35
40
class Serializer(object):
39
44
        elt = self._pack_inventory(inv)
40
45
        self._write_element(elt, f)
41
46
 
 
47
    def write_inventory_to_string(self, inv):
 
48
        return tostring(self._pack_inventory(inv)) + '\n'
 
49
 
 
50
    def read_inventory_from_string(self, xml_string):
 
51
        return self._unpack_inventory(fromstring(xml_string))
 
52
 
42
53
    def read_inventory(self, f):
43
54
        return self._unpack_inventory(self._read_element(f))
44
55
 
 
56
    def write_revision(self, rev, f):
 
57
        self._write_element(self._pack_revision(rev), f)
 
58
 
 
59
    def write_revision_to_string(self, rev):
 
60
        return tostring(self._pack_revision(rev)) + '\n'
 
61
 
 
62
    def read_revision(self, f):
 
63
        return self._unpack_revision(self._read_element(f))
 
64
 
 
65
    def read_revision_from_string(self, xml_string):
 
66
        return self._unpack_revision(fromstring(xml_string))
 
67
 
45
68
    def _write_element(self, elt, f):
46
69
        ElementTree(elt).write(f, 'utf-8')
47
70
        f.write('\n')
48
71
 
49
72
    def _read_element(self, f):
50
73
        return ElementTree().parse(f)
51
 
 
52
 
 
53
 
 
54
 
class _Serializer_v4(Serializer):
55
 
    """Version 0.0.4 serializer"""
56
 
    
57
 
    __slots__ = []
58
 
    
59
 
    def _pack_inventory(self, inv):
60
 
        """Convert to XML Element"""
61
 
        e = Element('inventory')
62
 
        e.text = '\n'
63
 
        if inv.root.file_id not in (None, ROOT_ID):
64
 
            e.set('file_id', inv.root.file_id)
65
 
        for path, ie in inv.iter_entries():
66
 
            e.append(self._pack_entry(ie))
67
 
        return e
68
 
 
69
 
 
70
 
    def _pack_entry(self, ie):
71
 
        """Convert InventoryEntry to XML element"""
72
 
        e = Element('entry')
73
 
        e.set('name', ie.name)
74
 
        e.set('file_id', ie.file_id)
75
 
        e.set('kind', ie.kind)
76
 
 
77
 
        if ie.text_size != None:
78
 
            e.set('text_size', '%d' % ie.text_size)
79
 
 
80
 
        for f in ['text_id', 'text_sha1']:
81
 
            v = getattr(ie, f)
82
 
            if v != None:
83
 
                e.set(f, v)
84
 
 
85
 
        # to be conservative, we don't externalize the root pointers
86
 
        # for now, leaving them as null in the xml form.  in a future
87
 
        # version it will be implied by nested elements.
88
 
        if ie.parent_id != ROOT_ID:
89
 
            assert isinstance(ie.parent_id, basestring)
90
 
            e.set('parent_id', ie.parent_id)
91
 
 
92
 
        e.tail = '\n'
93
 
 
94
 
        return e
95
 
 
96
 
 
97
 
    def _unpack_inventory(self, elt):
98
 
        """Construct from XML Element
99
 
        """
100
 
        assert elt.tag == 'inventory'
101
 
        root_id = elt.get('file_id') or ROOT_ID
102
 
        inv = Inventory(root_id)
103
 
        for e in elt:
104
 
            ie = self._unpack_entry(e)
105
 
            if ie.parent_id == ROOT_ID:
106
 
                ie.parent_id = root_id
107
 
            inv.add(ie)
108
 
        return inv
109
 
 
110
 
 
111
 
    def _unpack_entry(self, elt):
112
 
        assert elt.tag == 'entry'
113
 
 
114
 
        ## original format inventories don't have a parent_id for
115
 
        ## nodes in the root directory, but it's cleaner to use one
116
 
        ## internally.
117
 
        parent_id = elt.get('parent_id')
118
 
        if parent_id == None:
119
 
            parent_id = ROOT_ID
120
 
 
121
 
        ie = InventoryEntry(elt.get('file_id'),
122
 
                              elt.get('name'),
123
 
                              elt.get('kind'),
124
 
                              parent_id)
125
 
        ie.text_id = elt.get('text_id')
126
 
        ie.text_sha1 = elt.get('text_sha1')
127
 
 
128
 
        ## mutter("read inventoryentry: %r" % (elt.attrib))
129
 
 
130
 
        v = elt.get('text_size')
131
 
        ie.text_size = v and int(v)
132
 
 
133
 
        return ie
134
 
 
135
 
 
136
 
"""singleton instance"""
137
 
serializer_v4 = _Serializer_v4()
138
 
 
139
 
 
140
 
 
141
 
 
142
 
 
143
 
def pack_xml(o, f):
144
 
    """Write object o to file f as XML.
145
 
 
146
 
    o must provide a to_element method.
147
 
    """
148
 
    ElementTree(o.to_element()).write(f, 'utf-8')
149
 
    f.write('\n')
150
 
 
151
 
 
152
 
def unpack_xml(cls, f):
153
 
    return cls.from_element(ElementTree().parse(f))