https://github.com/hay/xml2json

Python script converts XML to JSON or the other way around
https://github.com/hay/xml2json

Last synced: 13 days ago
JSON representation

Python script converts XML to JSON or the other way around

• Host: GitHub
• URL: https://github.com/hay/xml2json
• Owner: hay
• License: mit
• Archived: true
• Created: 2010-09-28T22:39:29.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2019-05-01T18:27:54.000Z (over 5 years ago)
• Last Synced: 2024-08-01T22:57:17.759Z (3 months ago)
• Language: Python
• Homepage: http://github.com/hay/xml2json
• Size: 31.3 KB
• Stars: 463
• Watchers: 26
• Forks: 206
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
XML2JSON

========

**This module is deprecated and will not be updated anymore (May 2019)**

* To convert between text-based data formats (including XML and JSON) use my library [`dataknead`](http://github.com/hay/dataknead).

* To work with XML in Python i recommend the excellent [`xmltodict`](https://github.com/martinblech/xmltodict).

## Deprecated documentation

Python script converts XML to JSON or the other way around

Usage

-----

Make this executable

    $ chmod +x xml2json

Then invoke it from the command line like this

    $ xml2json -t xml2json -o file.json file.xml

Or the other way around

    $ xml2json -t json2xml -o file.xml file.json

Without the `-o` parameter `xml2json` writes to stdout

    $ xml2json -t json2xml file.json

Additional the options:

Strip text (#text and #tail) in the json

    $ xml2json -t xml2json -o file.json file.xml --strip_text

Strip namespace in the json

    $ xml2json -t xml2json -o file.json file.xml --strip_namespace

In code

    from xml2json import json2xml

    d = {'r': {'@p': 'p1', '#text': 't1', 'c': 't2'}}

    print(json2xml(d))

    > b't1t2'

    

Installation

------------

Either clone this repo or use `pip` like this:

    pip install https://github.com/hay/xml2json/zipball/master

License

-------

xml2json is released under the terms of the [MIT license](http://opensource.org/licenses/MIT).

Contributors

------------

This script was originally written by R.White, Rewritten to a command line utility by [Hay Kranen](http://www.haykranen.nl) with contributions from George Hamilton (gmh04) and Dan Brown (jdanbrown)

Links

------

* [Github](http://github.com/hay/xml2json)

How it works

------------

xml2json relies on ElementTree for the XML parsing.  This is based on

pesterfish.py but uses a different XML->JSON mapping.

The XML -> JSON mapping is described [here](http://www.xml.com/pub/a/2006/05/31/converting-between-xml-and-json.html)


XML                              JSON

<e/>                             "e": null

<e>text</e>                      "e": "text"

<e name="value" />               "e": { "@name": "value" }

<e name="value">text</e>         "e": { "@name": "value", "#text": "text" }

<e> <a>text</a ><b>text</b> </e> "e": { "a": "text", "b": "text" }

<e> <a>text</a> <a>text</a> </e> "e": { "a": ["text", "text"] }

<e> text <a>text</a> </e>        "e": { "#text": "text", "a": "text" }



This is very similar to the mapping used for [Yahoo Web Services](http://developer.yahoo.com/common/json.html#xml)

This is a mess in that it is so unpredictable -- it requires lots of testing (e.g. to see if values are lists or strings or dictionaries).  For use in Python this could be vastly cleaner.  Think about whether the internal form can be more self-consistent while maintaining good external characteristics for the JSON.

Look at the Yahoo version closely to see how it works.  Maybe can adopt that completely if it makes more sense...

R. White, 2006 November 6