This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
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.


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')

# 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, '')

# you can over-ride what it returns though
>>> pq(json, '', missing="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, '', missing="Unknown")
'Hello World by Unknown'




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

Release History

Release History


This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
pson-0.5.1.tar.gz (4.8 kB) Copy SHA256 Checksum SHA256 Source Jan 27, 2014

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting