python.xmldict Namespace Reference

Classes
class	XmlDictObject
	module implementation ---------------------------------------------------— More...

Functions
	_dict2xml_recurse (parent, dictitem)
	dict2xml (xmldict)
	_xml2dict_recurse (node, dictclass)
	xml2dict (root, dictclass=XmlDictObject)

Variables
str	__doc__
str	__author__ = "Sebastien Binet <binet@cern.ch>"
list	__all__
	module data -------------------------------------------------------------—

Function Documentation

_dict2xml_recurse()

python.xmldict._dict2xml_recurse ( parent, dictitem )

protected

Definition at line 78 of file xmldict.py.

def _dict2xml_recurse(parent, dictitem):
    assert type(dictitem) is not type(list)
 
    if isinstance(dictitem, dict):
        for (tag, child) in dictitem.iteritems():
            if isinstance(child, str):
                child = _xml_escape(child)
            if str(tag) == '_text':
                parent.text = str(child)
            elif type(child) is type(list):
                for listchild in child:
                    elem = ElementTree.Element(tag)
                    parent.append(elem)
                    _dict2xml_recurse (elem, listchild)
            else:                
                elem = ElementTree.Element(tag)
                parent.append(elem)
                _dict2xml_recurse (elem, child)
    else:
        parent.text = str(dictitem)
    

_xml2dict_recurse()

python.xmldict._xml2dict_recurse ( node, dictclass )

protected

Definition at line 106 of file xmldict.py.

def _xml2dict_recurse (node, dictclass):
    nodedict = dictclass()
    
    if len(node.items()) > 0:
        # if we have attributes, set them
        nodedict.update(dict((k, _xml_unescape(v) if isinstance(v, str) else v)
                             for k,v in node.items()))
    
    for child in node:
        # recursively add the element's children
        newitem = _xml2dict_recurse (child, dictclass)
        if isinstance(newitem, str):
            newitem = _xml_unescape(newitem)
        if child.tag in nodedict:
            # found duplicate tag, force a list
            if isinstance(nodedict[child.tag], list):
                # append to existing list
                nodedict[child.tag].append(newitem)
            else:
                # convert to list
                nodedict[child.tag] = [nodedict[child.tag], newitem]
        else:
            # only one, directly set the dictionary
            nodedict[child.tag] = newitem
 
    if node.text is None: 
        text = ''
    else: 
        text = node.text.strip()
    
    if len(nodedict) > 0:            
        # if we have a dictionary add the text as a dictionary value
        # (if there is any)
        if len(text) > 0:
            nodedict['_text'] = text
    else:
        # if we don't have child nodes or attributes, just set the text
        if node.text: nodedict = node.text.strip()
        else:         nodedict = ""
        
    return nodedict
        

dict2xml()

python.xmldict.dict2xml

(

xmldict

)

convert a python dictionary into an XML tree

Definition at line 99 of file xmldict.py.

def dict2xml(xmldict):
    """convert a python dictionary into an XML tree"""
    roottag = xmldict.keys()[0]
    root = ElementTree.Element(roottag)
    _dict2xml_recurse (root, xmldict[roottag])
    return root
 

xml2dict()

python.xmldict.xml2dict	(		root,
			dictclass = XmlDictObject )

convert an xml tree into a python dictionary

Definition at line 148 of file xmldict.py.

def xml2dict (root, dictclass=XmlDictObject):
    """convert an xml tree into a python dictionary
    """
    return dictclass({root.tag: _xml2dict_recurse (root, dictclass)})

Variable Documentation

__all__

list python.xmldict.__all__

private

Initial value:

=  [
    'xml2dict',
    'dict2xml',
    ]

module data -------------------------------------------------------------—

Definition at line 20 of file xmldict.py.

__author__

str python.xmldict.__author__ = "Sebastien Binet <binet@cern.ch>"

private

Definition at line 11 of file xmldict.py.

__doc__

str python.xmldict.__doc__

private

Initial value:

=  """\
functions to convert an XML file into a python dict, back and forth
"""

Definition at line 8 of file xmldict.py.