Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ability to change standard "item" name #40

Closed
wants to merge 2 commits into from
Closed

Ability to change standard "item" name #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cfad3da
add ability to change default item name
Jun 29, 2015
62648d5
some style fixes
Jun 29, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 24 additions & 18 deletions dicttoxml.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,9 +130,11 @@ def make_valid_xml_name(key, attr):
key = 'key'
return key, attr

def convert(obj, ids, attr_type, parent='root'):
def convert(obj, ids, attr_type, parent='root', custom_item_func=None):
"""Routes the elements of an object to the right function to convert them based on their data type"""
LOG.info('Inside convert(). obj type is: "%s", obj="%s"' % (type(obj).__name__, unicode_me(obj)))
if not custom_item_func:
custom_item_func = lambda x: 'item'
if isinstance(obj, numbers.Number) or type(obj) in (str, unicode):
return convert_kv('item', obj, attr_type)
if hasattr(obj, 'isoformat'):
Expand All @@ -142,12 +144,12 @@ def convert(obj, ids, attr_type, parent='root'):
if obj == None:
return convert_none('item', '', attr_type)
if isinstance(obj, dict):
return convert_dict(obj, ids, parent, attr_type)
return convert_dict(obj, ids, parent, attr_type, custom_item_func)
if isinstance(obj, collections.Iterable):
return convert_list(obj, ids, parent, attr_type)
return convert_list(obj, ids, parent, attr_type, custom_item_func)
raise TypeError('Unsupported data type: %s (%s)' % (obj, type(obj).__name__))

def convert_dict(obj, ids, parent, attr_type):
def convert_dict(obj, ids, parent, attr_type, custom_item_func):
"""Converts a dict into an XML string."""
LOG.info('Inside convert_dict(): obj type is: "%s", obj="%s"' % (type(obj).__name__, unicode_me(obj)))
output = []
Expand All @@ -172,21 +174,21 @@ def convert_dict(obj, ids, parent, attr_type):
if attr_type:
attr['type'] = get_xml_type(val)
addline('<%s%s>%s</%s>' % (
key, make_attrstring(attr), convert_dict(val, ids, key, attr_type), key)
key, make_attrstring(attr), convert_dict(val, ids, key, attr_type, custom_item_func), key)
)
elif isinstance(val, collections.Iterable):
if attr_type:
attr['type'] = get_xml_type(val)
addline('<%s%s>%s</%s>' % (
key, make_attrstring(attr), convert_list(val, ids, key, attr_type), key)
key, make_attrstring(attr), convert_list(val, ids, key, attr_type, custom_item_func), key)
)
elif val is None:
addline(convert_none(key, val, attr_type, attr))
else:
raise TypeError('Unsupported data type: %s (%s)' % (val, type(val).__name__))
return ''.join(output)

def convert_list(items, ids, parent, attr_type):
def convert_list(items, ids, parent, attr_type, custom_item_func):
"""Converts a list into an XML string."""
LOG.info('Inside convert_list()')
output = []
Expand All @@ -195,27 +197,29 @@ def convert_list(items, ids, parent, attr_type):
if ids:
this_id = get_unique_id(parent)

custom_item_name = custom_item_func(parent)

for i, item in enumerate(items):
LOG.info('Looping inside convert_list(): item="%s", type="%s"' % (unicode_me(item), type(item).__name__))
attr = {} if not ids else { 'id': '%s_%s' % (this_id, i+1) }
if isinstance(item, numbers.Number) or type(item) in (str, unicode):
addline(convert_kv('item', item, attr_type, attr))
addline(convert_kv(custom_item_name, item, attr_type, attr))
elif hasattr(item, 'isoformat'): # datetime
addline(convert_kv('item', item.isoformat(), attr_type, attr))
addline(convert_kv(custom_item_name, item.isoformat(), attr_type, attr))
elif type(item) == bool:
addline(convert_bool('item', item, attr_type, attr))
addline(convert_bool(custom_item_name, item, attr_type, attr))
elif isinstance(item, dict):
if not attr_type:
addline('<item>%s</item>' % (convert_dict(item, ids, parent, attr_type)))
addline('<%s>%s</%s>' % (custom_item_name, convert_dict(item, ids, parent, attr_type, custom_item_func), custom_item_name))
else:
addline('<item type="dict">%s</item>' % (convert_dict(item, ids, parent, attr_type)))
addline('<%s type="dict">%s</%s>' % (custom_item_name, convert_dict(item, ids, parent, attr_type, custom_item_func), custom_item_name))
elif isinstance(item, collections.Iterable):
if not attr_type:
addline('<item %s>%s</item>' % (make_attrstring(attr), convert_list(item, ids, 'item', attr_type)))
addline('<%s %s>%s</%s>' % (custom_item_name, make_attrstring(attr), convert_list(item, ids, 'item', attr_type, custom_item_func), custom_item_name))
else:
addline('<item type="list"%s>%s</item>' % (make_attrstring(attr), convert_list(item, ids, 'item', attr_type)))
addline('<%s type="list"%s>%s</%s>' % (custom_item_name, make_attrstring(attr), convert_list(item, ids, 'item', attr_type, custom_item_func), custom_item_name))
elif item is None:
addline(convert_none('item', None, attr_type, attr))
addline(convert_none(custom_item_name, None, attr_type, attr))
else:
raise TypeError('Unsupported data type: %s (%s)' % (item, type(item).__name__))
return ''.join(output)
Expand Down Expand Up @@ -255,18 +259,20 @@ def convert_none(key, val, attr_type, attr={}):
attrstring = make_attrstring(attr)
return '<%s%s></%s>' % (key, attrstring, key)

def dicttoxml(obj, root=True, custom_root='root', ids=False, attr_type=True):
def dicttoxml(obj, root=True, custom_root='root', ids=False, attr_type=True, custom_item_func=None):
"""Converts a python object into XML
attr_type is used to specify if data type for each element should be included in the resulting xml.
By default, it is set to True.
"""
LOG.info('Inside dicttoxml(): type(obj) is: "%s", obj="%s"' % (type(obj).__name__, unicode_me(obj)))
if not custom_item_func:
custom_item_func = lambda x: 'item'
output = []
addline = output.append
if root == True:
addline('<?xml version="1.0" encoding="UTF-8" ?>')
addline('<%s>%s</%s>' % (custom_root, convert(obj, ids, attr_type, parent=custom_root), custom_root))
addline('<%s>%s</%s>' % (custom_root, convert(obj, ids, attr_type, parent=custom_root, custom_item_func=custom_item_func), custom_root))
else:
addline(convert(obj, ids, attr_type, parent=''))
addline(convert(obj, ids, attr_type, parent='', custom_item_func=custom_item_func))
return ''.join(output).encode('utf-8')

18 changes: 18 additions & 0 deletions tests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import unittest
from dicttoxml import dicttoxml


class TestDictToXmlWithCustomItems(unittest.TestCase):

_src_dict = {'Tests': [1, 2, 3]}

def test_custom_items(self):
xml = dicttoxml(self._src_dict, custom_item_func=lambda x: x[:-1])
self.assertEqual(xml, '<?xml version="1.0" encoding="UTF-8" ?><root><Tests type="list"><Test type="int">1</Test><Test type="int">2</Test><Test type="int">3</Test></Tests></root>')

def test_default_items(self):
xml = dicttoxml(self._src_dict)
self.assertEqual(xml, '<?xml version="1.0" encoding="UTF-8" ?><root><Tests type="list"><item type="int">1</item><item type="int">2</item><item type="int">3</item></Tests></root>')

if __name__ == '__main__':
unittest.main()