← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml.py

  • Committer: Martin Pool
  • Date: 2005-06-28 05:33:40 UTC
  • Revision ID: mbp@sourcefrog.net-20050628053340-ea73b03fbcde9c46
- Remove XMLMixin class in favour of simple pack_xml, unpack_xml functions
  called as needed.  

- Avoid importing xml and ElementTree library unless needed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml.py
20
20
# "XML is like violence: if it doesn't solve your problem, you aren't
21
21
# using enough of it." -- various
22
22
 
23
 
 
24
 
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
25
 
__author__ = "Martin Pool <mbp@canonical.com>"
26
 
 
27
 
_ElementTree = None
28
 
def ElementTree(*args, **kwargs):
29
 
    global _ElementTree
30
 
    if _ElementTree is None:
31
 
        try:
32
 
            from cElementTree import ElementTree
33
 
        except ImportError:
34
 
            from elementtree.ElementTree import ElementTree
35
 
        _ElementTree = ElementTree
36
 
    return _ElementTree(*args, **kwargs)
37
 
 
38
 
_Element = None
39
 
def Element(*args, **kwargs):
40
 
    global _Element
41
 
    if _Element is None:
42
 
        try:
43
 
            from cElementTree import Element
44
 
        except ImportError:
45
 
            from elementtree.ElementTree import Element
46
 
        _Element = Element
47
 
    return _Element(*args, **kwargs)
48
 
 
49
 
 
50
 
_SubElement = None
51
 
def SubElement(*args, **kwargs):
52
 
    global _SubElement
53
 
    if _SubElement is None:
54
 
        try:
55
 
            from cElementTree import SubElement
56
 
        except ImportError:
57
 
            from elementtree.ElementTree import SubElement
58
 
        _SubElement = SubElement
59
 
    return _SubElement(*args, **kwargs)
60
 
 
61
 
 
62
 
class XMLMixin:
63
 
    def to_element(self):
64
 
        raise Exception("XMLMixin.to_element must be overridden in concrete classes")
65
 
    
66
 
    def write_xml(self, f):
67
 
        ElementTree(self.to_element()).write(f, 'utf-8')
68
 
        f.write('\n')
69
 
 
70
 
    def read_xml(cls, f):
71
 
        return cls.from_element(ElementTree().parse(f))
72
 
 
73
 
    read_xml = classmethod(read_xml)
74
 
 
 
23
# importing this module is fairly slow because it has to load several ElementTree bits
 
24
try:
 
25
    from cElementTree import ElementTree, SubElement, Element
 
26
except ImportError:
 
27
    from elementtree.ElementTree import ElementTree, SubElement, Element
 
28
 
 
29
 
 
30
def pack_xml(o, f):
 
31
    """Write object o to file f as XML.
 
32
 
 
33
    o must provide a to_element method.
 
34
    """
 
35
    ElementTree(o.to_element()).write(f, 'utf-8')
 
36
    f.write('\n')
 
37
 
 
38
 
 
39
def unpack_xml(cls, f):
 
40
    return cls.from_element(ElementTree().parse(f))