{"author":null,"author_email":"Rodrigo Tobar , Ivan Sagalaev ","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.9","Programming Language :: Python :: Implementation :: CPython","Programming Language :: Python :: Implementation :: PyPy","Topic :: Software Development :: Libraries :: Python Modules"],"description":".. image:: https://github.com/ICRAR/ijson/actions/workflows/deploy-to-pypi.yml/badge.svg\n :target: https://github.com/ICRAR/ijson/actions/workflows/deploy-to-pypi.yml\n\n.. image:: https://github.com/ICRAR/ijson/actions/workflows/fast-built-and-test.yml/badge.svg\n :target: https://github.com/ICRAR/ijson/actions/workflows/deploy-to-pypi.yml\n\n.. image:: https://coveralls.io/repos/github/ICRAR/ijson/badge.svg?branch=master\n :target: https://coveralls.io/github/ICRAR/ijson?branch=master\n\n.. image:: https://badge.fury.io/py/ijson.svg\n :target: https://badge.fury.io/py/ijson\n\n.. image:: https://img.shields.io/pypi/pyversions/ijson.svg\n :target: https://pypi.python.org/pypi/ijson\n\n.. image:: https://img.shields.io/pypi/dd/ijson.svg\n :target: https://pypi.python.org/pypi/ijson\n\n.. image:: https://img.shields.io/pypi/dw/ijson.svg\n :target: https://pypi.python.org/pypi/ijson\n\n.. image:: https://img.shields.io/pypi/dm/ijson.svg\n :target: https://pypi.python.org/pypi/ijson\n\n\n=====\nijson\n=====\n\nIjson is an iterative JSON parser with standard Python iterator interfaces.\n\n.. contents::\n :local:\n\n\nInstallation\n============\n\nIjson is hosted in PyPI, so you should be able to install it via ``pip``::\n\n pip install ijson\n\nBinary wheels are provided\nfor major platforms\nand python versions.\nThese are built and published automatically\nusing `cibuildwheel `_\nvia GitHub Actions.\n\n\nUsage\n=====\n\nAll usage example will be using a JSON document describing geographical\nobjects:\n\n.. code-block:: json\n\n {\n \"earth\": {\n \"europe\": [\n {\"name\": \"Paris\", \"type\": \"city\", \"info\": { ... }},\n {\"name\": \"Thames\", \"type\": \"river\", \"info\": { ... }},\n // ...\n ],\n \"america\": [\n {\"name\": \"Texas\", \"type\": \"state\", \"info\": { ... }},\n // ...\n ]\n }\n }\n\n\nHigh-level interfaces\n---------------------\n\nMost common usage is having ijson yield native Python objects out of a JSON\nstream located under a prefix.\nThis is done using the ``items`` function.\nHere's how to process all European cities:\n\n.. code-block:: python\n\n import ijson\n\n f = urlopen('http://.../')\n objects = ijson.items(f, 'earth.europe.item')\n cities = (o for o in objects if o['type'] == 'city')\n for city in cities:\n do_something_with(city)\n\nFor how to build a prefix see the prefix_ section below.\n\nOther times it might be useful to iterate over object members\nrather than objects themselves (e.g., when objects are too big).\nIn that case one can use the ``kvitems`` function instead:\n\n.. code-block:: python\n\n import ijson\n\n f = urlopen('http://.../')\n european_places = ijson.kvitems(f, 'earth.europe.item')\n names = (v for k, v in european_places if k == 'name')\n for name in names:\n do_something_with(name)\n\n\nLower-level interfaces\n----------------------\n\nSometimes when dealing with a particularly large JSON payload it may worth to\nnot even construct individual Python objects and react on individual events\nimmediately producing some result.\nThis is achieved using the ``parse`` function:\n\n.. code-block:: python\n\n import ijson\n\n parser = ijson.parse(urlopen('http://.../'))\n stream.write('')\n for prefix, event, value in parser:\n if (prefix, event) == ('earth', 'map_key'):\n stream.write('<%s>' % value)\n continent = value\n elif prefix.endswith('.name'):\n stream.write('

Package search

ijson

project_urls

Dependencies

All package metadata

Releases