dict2xml

Warnings

• gotcha The library does not support adding attributes directly to XML elements. Dictionary keys are treated as element names, and their values as element content.
  Fix: Consider using a different library if XML attributes are a hard requirement, or structure your dictionary to represent attributes as child elements if possible. For example, `{ 'element': { 'attribute_key': 'attribute_value', 'content': 'text' } }` will result in nested elements, not an element with an attribute.
• gotcha By default, `dict2xml` sorts dictionary keys alphabetically when converting them to XML elements, which can lead to unexpected ordering if not explicitly handled. `OrderedDict` keys are *not* sorted by default.
  Fix: If key order is important and you are not using an `OrderedDict`, you can provide a `data_sorter` to the `Converter` class. For example, `Converter(data_sorter=DataSorter.never()).build(data)` to prevent sorting keys, or `data_sorter=DataSorter.always()` to force sorting, even for `OrderedDict`.
• breaking As of version 1.7.0, `dict2xml` officially dropped support for Python 2. It is now only supported for Python 3.6+ (though it may still work in 3.5).
  Fix: Ensure your project is running on Python 3.6 or newer. If you need Python 2 compatibility, you must use an older version of the `dict2xml` library (e.g., < 1.7.0).
• gotcha The library does not automatically include an XML declaration line (e.g., `<?xml version="1.0" encoding="UTF-8"?>`) in the generated XML string.
  Fix: If an XML declaration is required, you must prepend it manually to the output string.

Install

• pip install dict2xml Install stable version

Imports

• dict2xml

  from dict2xml import dict2xml

  The primary function to convert a dictionary to XML.

Quickstart

This quickstart demonstrates how to convert a nested Python dictionary into an XML string using the `dict2xml` function. It uses the `wrap` parameter to specify a root element and `indent` for readability.

from dict2xml import dict2xml

data = {
    'root_element': {
        'item1': 123,
        'item2': [
            {'sub_item_a': 'hello'},
            {'sub_item_b': 'world'}
        ],
        'item3': {
            'nested_value': 'example'
        }
    }
}

xml_string = dict2xml(data, wrap='root', indent='  ')
print(xml_string)