A robust and extended implementation of JSONPath with read and update capability, and a clear AST
Project description
https://github.com/kennknowles/python-jsonpath-rw
This package provides a robust implementation of JSONPath with read and update capability as well as additional operators, described below.
This package differs from other JSONPath implementations in that it is a full language implementation, meaning the JSONPath expressions are first class objects, easy to analyze, transform, parse, print, and extend. (You can also execute them :-)
JSONPath Syntax
The JSONPath syntax supported by this library includes some additional features and omits some problematic features (those that make it unportable). In particular, some new operators such as | and where are available, and parentheses are used for grouping not for callbacks into Python, since with these changes the language is not trivially associative. Also, fields may be quoted whether or not they are contained in brackets.
Atomic expressions:
Syntax |
Meaning |
---|---|
$ |
The root object |
field |
Specified field(s), described below |
[ field ] |
Same as field |
[ idx ] |
Array access, described below (this is always unambiguous with field access) |
Jsonpath operators:
Syntax |
Meaning |
---|---|
jsonpath1 . jsonpath2 |
All nodes matched by jsonpath2 starting at any node matching jsonpath1 |
jsonpath [ whatever ] |
Same as jsonpath.whatever |
jsonpath1 .. jsonpath2 |
All nodes matched by jsonpath2 that descend from any node matching jsonpath1 |
jsonpath1 where jsonpath2 |
Any nodes matching jsonpath1 with a child matching jsonpath2 |
Also jsonpath1 | jsonpath2 for union (but I have not convinced Github-Flavored Markdown to allow me to put that in a table)
Field specifiers ( field ):
Syntax |
Meaning |
---|---|
fieldname |
the field fieldname (from the “current” object) |
"fieldname" |
same as above, for allowing special characters in the fieldname |
'fieldname' |
ditto |
* |
any field |
field , field |
either of the named fields (you can always build equivalent jsonpath using |) |
Array specifiers ( idx ):
Syntax |
Meaning |
---|---|
|
array index (may be comma-separated list) |
|
array slicing (note that step is unimplemented only due to lack of need thus far) |
|
any array index |
Programmatic JSONPath
If you are programming in Python and would like a more robust way to create JSONPath expressions that does not depend on a parser, it is very easy to do so directly, and here are some examples:
Root()
Slice(start=0, end=None, step=None)
Fields('foo', 'bar')
Index(42)
Child(Fields('foo'), Index(42))
Where(Slice(), Fields('subfield'))
Descendants(jsonpath, jsonpath)
More to explore
There are way too many jsonpath implementations out there to discuss. Some are robust, some are toy projects that still work fine, some are exercises. There will undoubtedly be many more. This one is made for use in released, maintained code, and in particular for programmatic access to the abstract syntax and extension. But JSONPath at its simplest just isn’t that complicated, so you can probably use any of them successfully. Why not this one?
The original proposal, as far as I know:
JSONPath - XPath for JSON by Stefan Goessner.
Contributors
Copyright and License
Copyright 2013- Kenneth Knowles
Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file jsonpath-rw-0.4.tar.gz
.
File metadata
- Download URL: jsonpath-rw-0.4.tar.gz
- Upload date:
- Size: 9.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 781d94f2ab7a1126abd724aa217b5cbffec83cca0b4ac756b3fa9e101a649fee |
|
MD5 | 31acdff75a04bd0250802a8074cc80b6 |
|
BLAKE2b-256 | 834b6135a07f34166371bd8ce8bf9755551a91574e09d77e8c7e15cc293089a4 |