Skip to main content

Easy querying for JSON like structures

Project description

Python library to make querying JSON-like structures easy!

With the explosion of APIs returning JSON the use of JSON like structures (i.e what you get if you take JSON and run it through JSON.loads()) querying these types of structures is a common need.

Most people either manually traverse the structures or write their own querying logic, this library aims to solve that need by providing a general purpose querying utils. It uses the dot notation to traverse structures in a similar fashion to document databases such as MongoDB.

Examples

To demonstrate by example with the following JSON:

json = {
 'header' : {'title' : 'Hello World',
             'year' : 2014},
 'body' : { 'translations' : [
                                {'language' : 'french', 'translation' : 'bonjour'},
                                {'language' : 'german', 'translation' : 'guten tag'}
                             ]
          }
}

Traditional (pre-pson) approach:

>>> json['header']['title']
'Hello World'

New pson approach:

>>> from pson import pathquery as pq

>>> pq(json, 'header.title')
'Hello World'

Some more pson examples:

>>> from pson import pathquery as pq

>>> pq(json, 'header.title')
'Hello World'

# as you'd expect it can return sub-structures
>>> pq(json, 'body')
{'translations': [{'translation': 'bonjour', 'language': 'french'}, {'translation': 'guten tag', 'language': 'german'}]}

# and arrays
>>> pq(json, 'body.translations')
[{'translation': 'bonjour', 'language': 'french'}, {'translation': 'guten tag', 'language': 'german'}]

# you can query into arrays using numerical indicies
>>> pq(json, 'body.translations.0.language')
'french'

# you can also not specify an index and get back an array where the rest of the query
# is applied to every element in the array
>>> pq(json, 'body.translations.language')
['french', 'german']

How does it handle missing values ?

>>> from pson import pathquery as pq

# by default it returns None rather than throwing an exception
>>> pq(json, 'header.author')
None

# you can over-ride what it returns though
>>> pq(json, 'header.author', missing="Unknown")
'Unknown'

# which is useful for situations like where you're building strings and don't want to deal
# with lots of KeyError exceptions
>>> pq(json, 'header.title') + ' by ' + pq(json, 'header.author', missing="Unknown")
'Hello World by Unknown'

Installation

TBD

Authors

Built by Imran Ghory (@imranghory). Released under the MIT Licence. Contributions welcome via Github.

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

pson-0.5.1.tar.gz (4.8 kB view details)

Uploaded Source

File details

Details for the file pson-0.5.1.tar.gz.

File metadata

  • Download URL: pson-0.5.1.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pson-0.5.1.tar.gz
Algorithm Hash digest
SHA256 5b15c2f49d65c390dbab1123d3ec495f47ae0c091e7595b56cb95729c44ba757
MD5 e45b08652184d2b6048860a844f4586f
BLAKE2b-256 0e964aa51228b789fd69654cd51a48a9bdf3bf38d1271899dd8ff347afb7b2f7

See more details on using hashes here.

Supported by

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