← 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-09-16 09:19:54 UTC
  • Revision ID: mbp@sourcefrog.net-20050916091954-aee6d7be00db6354
- more docs in commit code

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml.py
1
1
#! /usr/bin/env python
2
 
# -*- coding: UTF-8 -*-
3
2
 
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
20
19
# "XML is like violence: if it doesn't solve your problem, you aren't
21
20
# using enough of it." -- various
22
21
 
23
 
# importing this module is fairly slow because it has to load several ElementTree bits
 
22
# importing this module is fairly slow because it has to load several
 
23
# ElementTree bits
 
24
 
 
25
from bzrlib.trace import mutter, warning
 
26
 
24
27
try:
25
 
    from util.cElementTree import ElementTree, SubElement, Element
 
28
    from cElementTree import (ElementTree, SubElement, Element,
 
29
                              XMLTreeBuilder, fromstring, tostring)
26
30
except ImportError:
27
 
    from util.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))
 
31
    from warnings import warn
 
32
    warn('using slower ElementTree; consider installing cElementTree')
 
33
    from util.elementtree.ElementTree import (ElementTree, SubElement,
 
34
                                              Element, XMLTreeBuilder,
 
35
                                              fromstring, tostring)
 
36
 
 
37
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
 
38
from bzrlib.revision import Revision, RevisionReference        
 
39
from bzrlib.errors import BzrError
 
40
 
 
41
 
 
42
class Serializer(object):
 
43
    """Abstract object serialize/deserialize"""
 
44
    def write_inventory(self, inv, f):
 
45
        """Write inventory to a file"""
 
46
        elt = self._pack_inventory(inv)
 
47
        self._write_element(elt, f)
 
48
 
 
49
    def write_inventory_to_string(self, inv):
 
50
        return tostring(self._pack_inventory(inv))
 
51
 
 
52
    def read_inventory_from_string(self, xml_string):
 
53
        return self._unpack_inventory(fromstring(xml_string))
 
54
 
 
55
    def read_inventory(self, f):
 
56
        return self._unpack_inventory(self._read_element(f))
 
57
 
 
58
    def write_revision(self, rev, f):
 
59
        self._write_element(self._pack_revision(rev), f)
 
60
 
 
61
    def write_revision_to_string(self, rev):
 
62
        return tostring(self._pack_revision(rev), f)
 
63
 
 
64
    def read_revision(self, f):
 
65
        return self._unpack_revision(self._read_element(f))
 
66
 
 
67
    def read_revision_from_string(self, xml_string):
 
68
        return self._unpack_revision(fromstring(xml_string))
 
69
 
 
70
    def _write_element(self, elt, f):
 
71
        ElementTree(elt).write(f, 'utf-8')
 
72
        f.write('\n')
 
73
 
 
74
    def _read_element(self, f):
 
75
        return ElementTree().parse(f)
 
76