jsonpath

library0.82.2pypypi✓ verified 35d ago

The `jsonpath` library provides a Pythonic implementation of JSONPath, following the IETF JSONPath draft specification. It allows users to query JSON-like data structures using XPath-like expressions. It's actively developed, with the latest version being 0.82.2, and typically releases updates as the IETF draft progresses or new features are added.

serialization data

package ↗homepage ↗

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Import the module to access `jsonpath.select` for convenience or `jsonpath.JSONPath` for object-oriented usage.

import jsonpath

Import the main class to compile and reuse JSONPath expressions.

from jsonpath import JSONPath

Import the convenience function to directly query data without explicit class instantiation.

from jsonpath import select

This quickstart demonstrates how to use the `jsonpath.select` convenience function for simple queries, and how to use the `jsonpath.JSONPath` class for compiling and reusing path expressions, which is more efficient for repeated queries against different data.

import jsonpath data = { "store": { "book": [ {"category": "reference", "author": "Nigel Rees", "title": "Sayings of the Century", "price": 8.95}, {"category": "fiction", "author": "Evelyn Waugh", "title": "Sword of Honour", "price": 12.99} ], "bicycle": {"color": "red", "price": 19.95} } } # Use the convenience 'select' function to query data path_expression = "$.store.book[*].author" authors = jsonpath.select(path_expression, data) print(f"Authors found: {authors}") # For performance-critical scenarios, compile the path once using JSONPath class from jsonpath import JSONPath json_path = JSONPath(path_expression) authors_compiled = json_path.findall(data) print(f"Authors (compiled path): {authors_compiled}")

Debug

Known footguns

breakingThis library strictly adheres to the IETF JSONPath draft. Its syntax and behavior may differ significantly from other popular Python JSONPath implementations (e.g., `jsonpath_rw`, `jsonpath-ng`). Users migrating or expecting behavior from non-standard JSONPath libraries should carefully review the IETF specification and library documentation.

gotchaFor repeated queries with the same JSONPath expression, using `jsonpath.select()` repeatedly is less efficient than instantiating a `JSONPath` object once and calling its `findall()` method. `select()` re-compiles the path on each call.

gotchaThe `JSONPath` object has both `find()` and `findall()` methods. `find()` returns the first matching element (or `None`), while `findall()` returns a list of all matching elements. Confusing these can lead to unexpected results (e.g., only getting one match when multiple exist).

Upgrade

Version history

Breaking-change detection hasn't run for this library yet.

Audit

Security & dependencies

CVE tracking and dependency tree are planned for a later release.

Agent activity

0 hits · last 30 days

No traffic data recorded yet.

Resources

packagehttps://pypi.org/project/jsonpath/ ↗

homepagehttp://www.ultimate.com/phil/python/#jsonpath ↗