Skip to main content

Iterative JSON parser with a standard Python iterator interface

Project description

https://travis-ci.org/ICRAR/ijson.svg?branch=master

ijson

Ijson is an iterative JSON parser with a standard Python iterator interface.

Usage

All usage example will be using a JSON document describing geographical objects:

{
  "earth": {
    "europe": [
      {"name": "Paris", "type": "city", "info": { ... }},
      {"name": "Thames", "type": "river", "info": { ... }},
      // ...
    ],
    "america": [
      {"name": "Texas", "type": "state", "info": { ... }},
      // ...
    ]
  }
}

Most common usage is having ijson yield native Python objects out of a JSON stream located under a prefix. Here’s how to process all European cities:

import ijson

f = urlopen('http://.../')
objects = ijson.items(f, 'earth.europe.item')
cities = (o for o in objects if o['type'] == 'city')
for city in cities:
    do_something_with(city)

Sometimes when dealing with a particularly large JSON payload it may worth to not even construct individual Python objects and react on individual events immediately producing some result:

import ijson

parser = ijson.parse(urlopen('http://.../'))
stream.write('<geo>')
for prefix, event, value in parser:
    if (prefix, event) == ('earth', 'map_key'):
        stream.write('<%s>' % value)
        continent = value
    elif prefix.endswith('.name'):
        stream.write('<object name="%s"/>' % value)
    elif (prefix, event) == ('earth.%s' % continent, 'end_map'):
        stream.write('</%s>' % continent)
stream.write('</geo>')

Backends

Ijson provides several implementations of the actual parsing in the form of backends located in ijson/backends:

  • yajl2_c: a C extension using YAJL 2.x. This is the fastest, but might require a compiler and the YAJL development files to be present when installing this package. Binary wheel distributions exist for major platforms/architectures to spare users from having to compile the package.

  • yajl2_cffi: wrapper around YAJL 2.x using CFFI.

  • yajl2: wrapper around YAJL 2.x using ctypes, for when you can’t use CFFI for some reason.

  • yajl: deprecated YAJL 1.x + ctypes wrapper, for even older systems.

  • python: pure Python parser, good to use with PyPy

You can import a specific backend and use it in the same way as the top level library:

import ijson.backends.yajl2_cffi as ijson

for item in ijson.items(...):
    # ...

Importing the top level library as import ijson uses the pure Python backend.

Acknowledgements

ijson was originally developed and actively maintained until 2016 by Ivan Sagalaev. In 2019 he handed over the maintenance of the project and the PyPI ownership.

Python parser in ijson is relatively simple thanks to Douglas Crockford who invented a strict, easy to parse syntax.

The YAJL library by Lloyd Hilaiel is the most popular and efficient way to parse JSON in an iterative fashion.

Ijson was inspired by yajl-py wrapper by Hatem Nassrat. Though ijson borrows almost nothing from the actual yajl-py code it was used as an example of integration with yajl using ctypes.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ijson-2.4.tar.gz (17.6 kB view hashes)

Uploaded Source

Built Distributions

ijson-2.4-cp37-cp37m-manylinux1_x86_64.whl (59.9 kB view hashes)

Uploaded CPython 3.7m

ijson-2.4-cp37-cp37m-macosx_10_6_x86_64.whl (22.7 kB view hashes)

Uploaded CPython 3.7m macOS 10.6+ x86-64

ijson-2.4-cp36-cp36m-manylinux1_x86_64.whl (59.9 kB view hashes)

Uploaded CPython 3.6m

ijson-2.4-cp36-cp36m-macosx_10_6_x86_64.whl (22.7 kB view hashes)

Uploaded CPython 3.6m macOS 10.6+ x86-64

ijson-2.4-cp35-cp35m-manylinux1_x86_64.whl (59.9 kB view hashes)

Uploaded CPython 3.5m

ijson-2.4-cp35-cp35m-macosx_10_6_x86_64.whl (22.7 kB view hashes)

Uploaded CPython 3.5m macOS 10.6+ x86-64

ijson-2.4-cp34-cp34m-manylinux1_x86_64.whl (59.7 kB view hashes)

Uploaded CPython 3.4m

ijson-2.4-cp34-cp34m-macosx_10_6_x86_64.whl (22.7 kB view hashes)

Uploaded CPython 3.4m macOS 10.6+ x86-64

ijson-2.4-cp27-cp27mu-manylinux1_x86_64.whl (57.9 kB view hashes)

Uploaded CPython 2.7mu

ijson-2.4-cp27-cp27m-manylinux1_x86_64.whl (57.9 kB view hashes)

Uploaded CPython 2.7m

ijson-2.4-cp27-cp27m-macosx_10_6_x86_64.whl (22.6 kB view hashes)

Uploaded CPython 2.7m macOS 10.6+ x86-64

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page