JSONPATH
A selector expression for extracting data from JSON.
Quickstarts
Installation
Install the stable version from PYPI.
pip install jsonpath-extractor
Or install the latest version from Github.
pip install git+https://github.com/linw1995/jsonpath.git@master
Usage
{
"goods": [
{"price": 100, "category": "Comic book"},
{"price": 200, "category": "magazine"},
{"price": 200, "no category": ""}
],
"targetCategory": "book"
}
How to parse and extract all the comic book data from the above JSON file.
import json
from jsonpath import parse
with open("example.json", "r") as f:
data = json.load(f)
assert parse("$.goods[contains(@.category, $.targetCategory)]").find(data) == [
{"price": 100, "category": "Comic book"}
]
Or use the jsonpath.core module to extract it.
from jsonpath.core import Root, Contains, Self
assert Root().Name("goods").Predicate(
Contains(Self().Name("category"), Root().Name("targetCategory"))
).find(data) == [{"price": 100, "category": "Comic book"}]
Usage via CLI
The faster way to extract by using CLI.
jp -f example.json "$.goods[contains(@.category, $.targetCategory)]"
Or pass content by pipeline.
cat example.json | jp "$.goods[contains(@.category, $.targetCategory)]"
The output of the above commands.
[
{
"price": 100,
"category": "Comic book"
}
]
Changelog
v0.8.0
Features
Refactor
- 9d9d78f raise AttributeError by object.__getattribute__
- 4191b8c not registers base class "Expr" for chaining invocations
Build
- cc6ab56 2040721 upgrade lark-parser package to latest
- fb7e902 fit with latest PDM
- 10ea6d3 excludes .mypy_cache for local build
Fix
- 1dccec1 fix: right way to generate standalone parser
Contributing
Environment Setup
Clone the source codes from Github.
git clone https://github.com/linw1995/jsonpath.git
cd jsonpath
Setup the development environment. Please make sure you install the pdm, pre-commit and nox CLIs in your environment.
make init
make PYTHON=3.7 init # for specific python version
Linting
Use pre-commit for installing linters to ensure a good code style.
make pre-commit
Run linters. Some linters run via CLI nox, so make sure you install it.
make check-all
Testing
Run quick tests.
make
Run quick tests with verbose.
make vtest
Run tests with coverage. Testing in multiple Python environments is powered by CLI nox.
make cov
Documentation
Run serving documents with live-reloading.
make serve-docs
1 Oct 14, 2021
1 Dec 14, 2022
5 Dec 1, 2021
3 Feb 2, 2022
0 Jan 22, 2022
4 Mar 22, 2022
12 Mar 9, 2022
1 Dec 7, 2021
4 Jul 20, 2022
1 Jan 30, 2022
168 Dec 25, 2022
56 Dec 13, 2022
235 Dec 29, 2022
1.5k Jan 5, 2023
12.6k Dec 30, 2022
16.3k Dec 29, 2022
51 Dec 1, 2021
44 Dec 29, 2022
4 Sep 19, 2022