Skip to main content

How to convert a dictionary to a dictionary of XML strings in Python

How to convert a dictionary to a dictionary of XML strings in Python.

Here's a detailed step-by-step tutorial on how to convert a dictionary to a dictionary of XML strings in Python, along with multiple code examples.

Step 1: Import the necessary modules​

To begin, we need to import the required modules for working with XML in Python. We'll be using the xml.etree.ElementTree module, which provides a simple and efficient API for parsing and creating XML data.

import xml.etree.ElementTree as ET

Step 2: Define the function to convert the dictionary to XML​

Next, let's define a function that takes a dictionary as input and converts it to a dictionary of XML strings. We'll name the function dict_to_xml.

def dict_to_xml(dictionary):
    root = ET.Element('root')  # Create the root element for the XML tree

    for key, value in dictionary.items():
        element = ET.SubElement(root, key)  # Create a sub-element for each key in the dictionary
        element.text = str(value)  # Set the text content of the sub-element to the corresponding value

    xml_string = ET.tostring(root, encoding='utf-8')  # Convert the XML tree to a string

    return xml_string

In this function, we create the root element of the XML tree named 'root'. Then, for each key-value pair in the dictionary, we create a sub-element under the root element using the key as the element tag. We set the text content of each sub-element to the corresponding value from the dictionary.

Finally, we use the ET.tostring() method to convert the XML tree to a string, specifying the encoding as 'utf-8'.

Step 3: Example usage​

Now, let's demonstrate how to use the dict_to_xml function with an example.

my_dict = {'name': 'John', 'age': 25, 'city': 'New York'}
xml_dict = dict_to_xml(my_dict)

print(xml_dict)

Output:

b'<root><name>John</name><age>25</age><city>New York</city></root>'

In this example, we create a dictionary my_dict with three key-value pairs. We then pass this dictionary to the dict_to_xml function, which converts it into an XML string. Finally, we print the XML string.

Note that the output is prefixed with a 'b' indicating that it is a byte string. You can decode it using xml_dict.decode('utf-8') if you need a string representation.

Step 4: Handling nested dictionaries​

The dict_to_xml function we defined earlier works well for simple dictionaries. However, it doesn't handle nested dictionaries. Let's modify the function to support nested dictionaries.

def dict_to_xml(dictionary, parent=None):
    if parent is None:
        parent = ET.Element('root')

    for key, value in dictionary.items():
        if isinstance(value, dict):
            element = ET.SubElement(parent, key)
            dict_to_xml(value, parent=element)  # Recursively convert the nested dictionary to XML
        else:
            element = ET.SubElement(parent, key)
            element.text = str(value)

    if parent.tag == 'root':
        xml_string = ET.tostring(parent, encoding='utf-8')
        return xml_string

In this modified version of the function, we check if the value of a key is a dictionary using the isinstance() function. If it is, we create a new sub-element under the parent element and recursively call dict_to_xml() on the nested dictionary, specifying the new sub-element as the parent.

If the value is not a dictionary, we create a regular sub-element and set its text content to the value.

Finally, we check if the parent element is the root element. If it is, we convert the entire XML tree to a string and return it.

Step 5: Example usage with nested dictionaries​

Let's now demonstrate the usage of the modified dict_to_xml function with an example containing nested dictionaries.

my_dict = {
    'name': 'John',
    'age': 25,
    'address': {
        'street': '123 Main St',
        'city': 'New York',
        'zipcode': '10001'
    }
}

xml_dict = dict_to_xml(my_dict)

print(xml_dict)

Output:

b'<root><name>John</name><age>25</age><address><street>123 Main St</street><city>New York</city><zipcode>10001</zipcode></address></root>'

In this example, we have a dictionary my_dict with a nested dictionary under the 'address' key. The dict_to_xml function is able to handle this nested dictionary and convert it to XML correctly.

That's it! You now know how to convert a dictionary to a dictionary of XML strings in Python. Feel free to use this approach to convert dictionaries to XML for your specific needs.