{"author":"Martin Blech","author_email":"martinblech@gmail.com","bugtrack_url":null,"classifiers":["Intended Audience :: Developers","License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.6","Programming Language :: Python :: 3.7","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Programming Language :: Python :: Implementation :: PyPy","Topic :: Text Processing :: Markup :: XML"],"description":"# xmltodict\n\n`xmltodict` is a Python module that makes working with XML feel like you are working with [JSON](http://docs.python.org/library/json.html), as in this [\"spec\"](http://www.xml.com/pub/a/2006/05/31/converting-between-xml-and-json.html):\n\n[![Build Status](https://app.travis-ci.com/martinblech/xmltodict.svg?branch=master)](https://app.travis-ci.com/martinblech/xmltodict)\n\n```python\n>>> print(json.dumps(xmltodict.parse(\"\"\"\n... \n... \n... elements\n... more elements\n... \n... \n... element as well\n... \n... \n... \"\"\"), indent=4))\n{\n \"mydocument\": {\n \"@has\": \"an attribute\", \n \"and\": {\n \"many\": [\n \"elements\", \n \"more elements\"\n ]\n }, \n \"plus\": {\n \"@a\": \"complex\", \n \"#text\": \"element as well\"\n }\n }\n}\n```\n\n## Namespace support\n\nBy default, `xmltodict` does no XML namespace processing (it just treats namespace declarations as regular node attributes), but passing `process_namespaces=True` will make it expand namespaces for you:\n\n```python\n>>> xml = \"\"\"\n... \n... 1\n... 2\n... 3\n... \n... \"\"\"\n>>> xmltodict.parse(xml, process_namespaces=True) == {\n... 'http://defaultns.com/:root': {\n... 'http://defaultns.com/:x': '1',\n... 'http://a.com/:y': '2',\n... 'http://b.com/:z': '3',\n... }\n... }\nTrue\n```\n\nIt also lets you collapse certain namespaces to shorthand prefixes, or skip them altogether:\n\n```python\n>>> namespaces = {\n... 'http://defaultns.com/': None, # skip this namespace\n... 'http://a.com/': 'ns_a', # collapse \"http://a.com/\" -> \"ns_a\"\n... }\n>>> xmltodict.parse(xml, process_namespaces=True, namespaces=namespaces) == {\n... 'root': {\n... 'x': '1',\n... 'ns_a:y': '2',\n... 'http://b.com/:z': '3',\n... },\n... }\nTrue\n```\n\n## Streaming mode\n\n`xmltodict` is very fast ([Expat](http://docs.python.org/library/pyexpat.html)-based) and has a streaming mode with a small memory footprint, suitable for big XML dumps like [Discogs](http://discogs.com/data/) or [Wikipedia](http://dumps.wikimedia.org/):\n\n```python\n>>> def handle_artist(_, artist):\n... print(artist['name'])\n... return True\n>>> \n>>> xmltodict.parse(GzipFile('discogs_artists.xml.gz'),\n... item_depth=2, item_callback=handle_artist)\nA Perfect Circle\nFantômas\nKing Crimson\nChris Potter\n...\n```\n\nIt can also be used from the command line to pipe objects to a script like this:\n\n```python\nimport sys, marshal\nwhile True:\n _, article = marshal.load(sys.stdin)\n print(article['title'])\n```\n\n```sh\n$ bunzip2 enwiki-pages-articles.xml.bz2 | xmltodict.py 2 | myscript.py\nAccessibleComputing\nAnarchism\nAfghanistanHistory\nAfghanistanGeography\nAfghanistanPeople\nAfghanistanCommunications\nAutism\n...\n```\n\nOr just cache the dicts so you don't have to parse that big XML file again. You do this only once:\n\n```sh\n$ bunzip2 enwiki-pages-articles.xml.bz2 | xmltodict.py 2 | gzip > enwiki.dicts.gz\n```\n\nAnd you reuse the dicts with every script that needs them:\n\n```sh\n$ gunzip enwiki.dicts.gz | script1.py\n$ gunzip enwiki.dicts.gz | script2.py\n...\n```\n\n## Roundtripping\n\nYou can also convert in the other direction, using the `unparse()` method:\n\n```python\n>>> mydict = {\n... 'response': {\n... 'status': 'good',\n... 'last_updated': '2014-02-16T23:10:12Z',\n... }\n... }\n>>> print(unparse(mydict, pretty=True))\n\n\n\tgood\n\t2014-02-16T23:10:12Z\n\n```\n\nText values for nodes can be specified with the `cdata_key` key in the python dict, while node properties can be specified with the `attr_prefix` prefixed to the key name in the python dict. The default value for `attr_prefix` is `@` and the default value for `cdata_key` is `#text`.\n\n```python\n>>> import xmltodict\n>>> \n>>> mydict = {\n... 'text': {\n... '@color':'red',\n... '@stroke':'2',\n... '#text':'This is a test'\n... }\n... }\n>>> print(xmltodict.unparse(mydict, pretty=True))\n\nThis is a test\n```\n\nLists that are specified under a key in a dictionary use the key as a tag for each item. But if a list does have a parent key, for example if a list exists inside another list, it does not have a tag to use and the items are converted to a string as shown in the example below. To give tags to nested lists, use the `expand_iter` keyword argument to provide a tag as demonstrated below. Note that using `expand_iter` will break roundtripping.\n\n```python\n>>> mydict = {\n... \"line\": {\n... \"points\": [\n... [1, 5],\n... [2, 6],\n... ]\n... }\n... }\n>>> print(xmltodict.unparse(mydict, pretty=True))\n\n\n [1, 5]\n [2, 6]\n\n>>> print(xmltodict.unparse(mydict, pretty=True, expand_iter=\"coord\"))\n\n\n \n 1\n 5\n \n \n 2\n 6\n \n\n```\n\n## Ok, how do I get it?\n\n### Using pypi\n\nYou just need to\n\n```sh\n$ pip install xmltodict\n```\n\n### Using conda\n\nFor installing `xmltodict` using Anaconda/Miniconda (*conda*) from the \n[conda-forge channel][#xmltodict-conda] all you need to do is:\n\n[#xmltodict-conda]: https://anaconda.org/conda-forge/xmltodict\n\n```sh\n$ conda install -c conda-forge xmltodict\n```\n\n### RPM-based distro (Fedora, RHEL, …)\n\nThere is an [official Fedora package for xmltodict](https://apps.fedoraproject.org/packages/python-xmltodict).\n\n```sh\n$ sudo yum install python-xmltodict\n```\n\n### Arch Linux\n\nThere is an [official Arch Linux package for xmltodict](https://www.archlinux.org/packages/community/any/python-xmltodict/).\n\n```sh\n$ sudo pacman -S python-xmltodict\n```\n\n### Debian-based distro (Debian, Ubuntu, …)\n\nThere is an [official Debian package for xmltodict](https://tracker.debian.org/pkg/python-xmltodict).\n\n```sh\n$ sudo apt install python-xmltodict\n```\n\n### FreeBSD\n\nThere is an [official FreeBSD port for xmltodict](https://svnweb.freebsd.org/ports/head/devel/py-xmltodict/).\n\n```sh\n$ pkg install py36-xmltodict\n```\n\n### openSUSE/SLE (SLE 15, Leap 15, Tumbleweed)\n\nThere is an [official openSUSE package for xmltodict](https://software.opensuse.org/package/python-xmltodict).\n\n```sh\n# Python2\n$ zypper in python2-xmltodict\n\n# Python3\n$ zypper in python3-xmltodict\n```\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/martinblech/xmltodict","keywords":null,"license":"MIT","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"xmltodict","package_url":"https://pypi.org/project/xmltodict/","platform":"all","project_url":"https://pypi.org/project/xmltodict/","project_urls":{"Homepage":"https://github.com/martinblech/xmltodict"},"provides_extra":null,"release_url":"https://pypi.org/project/xmltodict/0.14.2/","requires_dist":null,"requires_python":">=3.6","summary":"Makes working with XML feel like you are working with JSON","version":"0.14.2","yanked":false,"yanked_reason":null}

Package search

xmltodict

project_urls

Dependencies

All package metadata

Releases