Skip to main content

Extensions for JSONPath RW

Project description

https://travis-ci.org/sileht/python-jsonpath-rw-ext.png?branch=master Latest Version Downloads

Extensions for JSONPath RW

jsonpath-rw-ext extends json-path-rw capabilities by adding multiple extensions. ‘len’ that allows one to get the length of a list. ‘sorted’ that returns a sorted version of a list, ‘arithmetic’ that permits one to make math operation between elements and ‘filter’ to select only certain elements of a list.

Each extensions will be proposed upstream and will stay here only if they are refused.

Quick Start

At the command line:

$ pip install jsonpath-rw-ext

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv jsonpath-rw-ext
$ pip install jsonpath-rw-ext

To replace the jsonpath_rw parser by this one with:

import jsonpath_rw_ext
jsonpath_rw_ext.parse("$.foo").find(...)

Or:

from jsonpath_rw_ext import parser
parser.ExtentedJsonPathParser().parse("$.foo").find(...)

The jsonpath classes are not part of the public API, because the name/structure can change when they will be implemented upstream. Only the syntax shouldn’t change.

Extensions

name

Example

len

  • $.objects.`len`

sub

  • $.field.`sub(/foo\\+(.*)/, \\1)`

split

  • $.field.`split(+, 2, -1)`

  • $.field.`split(sep, segement, maxsplit)`

sorted

  • $.objects.`sorted`

  • $.objects[\some_field]

  • $.objects[\some_field,/other_field]

filter

  • $.objects[?(@some_field > 5)]

  • $.objects[?some_field = “foobar”)]

  • $.objects[?some_field > 5 & other < 2)]

arithmetic (-+*/)

  • $.foo + “_” + $.bar

  • $.foo * 12

  • $.objects[*].cow + $.objects[*].cat

About arithmetic and string

Operations are done with python operators and allows types that python allows, and return [] if the operation can be done due to incompatible types.

When operators are used, a jsonpath must be be fully defined otherwise jsonpath-rw-ext can’t known if the expression is a string or a jsonpath field, in this case it will choice string as type.

Example with data:

{
    'cow': 'foo',
    'fish': 'bar'
}
cow + fish returns cowfish
$.cow + $.fish returns foobar
$.cow + “_” + $.fish returns foo_bar
$.cow + “_” + fish returns foo_fish

About arithmetic and list

Arithmetic can be used against two lists if they have the same size.

Example with data:

{'objects': [
    {'cow': 2, 'cat': 3},
    {'cow': 4, 'cat': 6}
]}
$.objects[*].cow + $.objects[*].cat returns [6, 9]

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

jsonpath-rw-ext-0.3.0.tar.gz (19.2 kB view details)

Uploaded Source

Built Distribution

jsonpath_rw_ext-0.3.0-py2.py3-none-any.whl (16.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file jsonpath-rw-ext-0.3.0.tar.gz.

File metadata

File hashes

Hashes for jsonpath-rw-ext-0.3.0.tar.gz
Algorithm Hash digest
SHA256 652086c35c67d217b29601fdd458da861d64fd44aee8f54daf569f2398d4a96e
MD5 ead5ad8efdb26e339df34aaca63c1bd2
BLAKE2b-256 1f66487a6d38e4c7a730d4e5568d12aded0df07a1112c29d08a79b92d8700622

See more details on using hashes here.

Provenance

File details

Details for the file jsonpath_rw_ext-0.3.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for jsonpath_rw_ext-0.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3ab9138bad53dcbeb18ce1cc5878cef9f797be608e6cb8a029b092c2f8815548
MD5 96607442397c3a6e2658774b1fa8c1f3
BLAKE2b-256 889bc3f55b1766a08e8df77cd1576b0ce19311793133fedbaffd2c3572da371c

See more details on using hashes here.

Provenance

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