dumps() – Dump python object to xml.

A simple xml parse and build library.

lazyxml.dumps(obj, encoding=None, header_declare=True, version=None, root=None, cdata=True, indent=None, ksort=False, reverse=False, errors='strict', hasattr=False, attrkey=None, valuekey=None)

Dump python object to xml.

>>> import lazyxml

>>> data = {'demo': {'foo': '<foo>', 'bar': ['1', '2']}}

>>> lazyxml.dumps(data)
'<?xml version="1.0" encoding="utf-8"?><demo><foo><![CDATA[<foo>]]></foo><bar><![CDATA[1]]></bar><bar><![CDATA[2]]></bar></demo>'

>>> lazyxml.dumps(data, header_declare=False)
'<demo><foo><![CDATA[<foo>]]></foo><bar><![CDATA[1]]></bar><bar><![CDATA[2]]></bar></demo>'

>>> lazyxml.dumps(data, cdata=False)
'<?xml version="1.0" encoding="utf-8"?><demo><foo>&lt;foo&gt;</foo><bar>1</bar><bar>2</bar></demo>'

>>> print lazyxml.dumps(data, indent=' ' * 4)
<?xml version="1.0" encoding="utf-8"?>
<demo>
    <foo><![CDATA[<foo>]]></foo>
    <bar><![CDATA[1]]></bar>
    <bar><![CDATA[2]]></bar>
</demo>

>>> lazyxml.dumps(data, ksort=True)
'<?xml version="1.0" encoding="utf-8"?><demo><bar><![CDATA[1]]></bar><bar><![CDATA[2]]></bar><foo><![CDATA[<foo>]]></foo></demo>'

>>> lazyxml.dumps(data, ksort=True, reverse=True)
'<?xml version="1.0" encoding="utf-8"?><demo><foo><![CDATA[<foo>]]></foo><bar><![CDATA[1]]></bar><bar><![CDATA[2]]></bar></demo>'

Note

Data that has attributes convert to xml see demo/dump.py.

Parameters:
  • obj – data for dump to xml.
  • encoding (str) – xml content encoding. if not set, consts.Default.ENCODING used.
  • header_declare (bool) – declare xml header. Default to True.
  • version (str) – xml version. if not set, consts.Default.VERSION used.
  • root (str) – xml root. Default to None.
  • cdata (bool) – use cdata. Default to True.
  • indent (str) – xml pretty indent. Default to None.
  • ksort (bool) – sort xml element keys. Default to False.
  • reverse (bool) – sort xml element keys but reverse. Default to False.
  • errors (str) – xml content decode error handling scheme. Default to strict.
  • hasattr (bool) – data element has attributes. Default to False.
  • attrkey (str) – element tag attribute identification. if not set, consts.Default.KEY_ATTR used.
  • valuekey (str) – element tag value identification. if not set, consts.Default.KEY_VALUE used.
Return type:

str