Introduction to xmltodict

The xmltodict module in Python enables seamless conversion of XML data to Python dictionaries. This makes it incredibly easy to access, manipulate, and utilize XML data structures within your Python applications. In this post, we will explore various functionalities of the xmltodict API with illustrative code snippets and a comprehensive example of an application that uses these APIs.

Getting Started

To install xmltodict, you can use pip:

pip install xmltodict

Basic Usage

Let’s start with converting an XML string to a Python dictionary:

import xmltodict

xml_data = '''

  Tove
  Jani
  Reminder
  Don't forget me this weekend!

'''

dict_data = xmltodict.parse(xml_data)
print(dict_data)

Conversion from Dictionary to XML

You can easily convert a Python dictionary back to an XML string using xmltodict.unparse():

import xmltodict

dict_data = {
  'note': {
    'to': 'Tove',
    'from': 'Jani',
    'heading': 'Reminder',
    'body': "Don't forget me this weekend!"
  }
}

xml_data = xmltodict.unparse(dict_data, pretty=True)
print(xml_data)

Working with XML Attributes

Attributes associated with XML elements are accessed by using the special ‘@’ key:

import xmltodict

xml_data = '''

  Tove
  Jani
  Reminder
  Don't forget me this weekend!

'''

dict_data = xmltodict.parse(xml_data)
print(dict_data)

Handling Lists

xmltodict automatically converts multiple repeating elements into lists:

import xmltodict

xml_data = '''

  
    John
    30
  
  
    Jane
    25
  

'''

dict_data = xmltodict.parse(xml_data)
print(dict_data)

Comprehensive Application Example

Here is an example of a simple application that reads an XML file, converts it to a dictionary, manipulates data, and writes it back to an XML file:

import xmltodict

def read_xml(file_path):
    with open(file_path, 'r') as file:
        xml_data = file.read()
        return xmltodict.parse(xml_data)

def write_xml(file_path, dict_data):
    with open(file_path, 'w') as file:
        xml_data = xmltodict.unparse(dict_data, pretty=True)
        file.write(xml_data)

def process_users(file_path):
    users_dict = read_xml(file_path)
    
    # Add a new user
    new_user = {'name': 'Alice', 'age': '28'}
    users_dict['users']['user'].append(new_user)
    
    # Write back to the file
    write_xml(file_path, users_dict)

if __name__ == "__main__":
    input_file_path = 'users.xml'
    process_users(input_file_path)

This script reads an XML file containing user data, adds a new user to the list, and writes the updated data back to the file.

By leveraging xmltodict, handling XML data in Python becomes more intuitive and efficient. This allows you to focus more on the business logic rather than dealing with structured data formatting.

Hash: 4a2f0588c936aa14a114a8608b7ce5422e6feb4027abecfbb67130db20c43672