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-1.0.0.tar.gz (19.6 kB view details)

Uploaded Source

Built Distribution

jsonpath_rw_ext-1.0.0-py2.py3-none-any.whl (16.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for jsonpath-rw-ext-1.0.0.tar.gz
Algorithm Hash digest
SHA256 43f8a8324b4cf8af7d93581f217424d3ffc89bfeaf8a3594ccdf45ea4d2d5dd2
MD5 5f3a7fb34c535e832ac6b68d4f8f55bb
BLAKE2b-256 b3d811a3d276506244d95779b3ac64f1b531f4b4ab3508f261aa639a7db8feeb

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for jsonpath_rw_ext-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 88c7719e8a2090aa70afba41bdfb656f57afb3d1130f8d26ef1911961b740475
MD5 ce6624ad3e0efd66497cca0c8b568ea8
BLAKE2b-256 4a6c6c229e01fd864d640e540c94d07dec9a34328f98087b65d2a44ba342d5a7

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