JSONPath, JSON Pointer and JSON Patch for Python

Warnings

• breaking Version 2.0.0 introduced significant breaking changes to JSONPath syntax in the default configuration. Unquoted property names are no longer treated as literals in bracket notation. It also introduced a new 'strict mode' enforcing full RFC 9535 compliance.
  Fix: Review JSONPath queries using unquoted bracket notation (e.g., `$.obj[prop]`) and update them to use quoted strings (e.g., `$.obj['prop']`) or dot notation (`$.obj.prop`). If strict RFC 9535 compliance is desired, enable `strict=True` in query functions like `findall()` or `compile()`.
• breaking JSON Pointers with negative indices are no longer permitted by default, aligning with RFC 6901. Attempting to use a negative index will raise a `JSONPointerIndexError`.
  Fix: If negative indices are required for JSON Pointers, set `JSONPointer.min_int_index` to a suitably negative integer to override the default behavior.
• breaking Support for Python 3.7 was dropped.
  Fix: Upgrade to Python 3.8 or newer.
• gotcha Parsing of non-standard JSONPath regular expression literals containing an escaped solidus (`/`) was incorrect prior to v2.0.2, affecting queries using the regex operator `=~`.
  Fix: Upgrade to version 2.0.2 or higher to ensure correct parsing of such regex literals.
• gotcha The non-standard JSON Patch operation `addap` (add-after-property) was behaving incorrectly, like `addne` (add-if-not-exists), in versions prior to 1.3.1. Also, JSON Patch operations on mappings with integer-like targets could behave unexpectedly.
  Fix: Upgrade to version 1.3.1 or higher for corrected behavior of `addap` and improved handling of integer-like targets in JSON Patch operations.

Install

• pip install python-jsonpath Install with pip

Imports

• jsonpath

  import jsonpath

  There are multiple Python JSONPath implementations; 'jsonpath_ng' is a different library.

Quickstart

This quickstart demonstrates basic JSONPath queries using `findall()` and `compile()` to extract data from a sample JSON structure. It shows how to select elements, filter by conditions, and compile paths for efficiency.

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},
            {"category": "fiction", "author": "Herman Melville", "title": "Moby Dick", "isbn": "0-553-21311-3", "price": 8.99},
            {"category": "fiction", "author": "J. R. R. Tolkien", "title": "The Lord of the Rings", "isbn": "0-395-19395-8", "price": 22.99}
        ],
        "bicycle": {"color": "red", "price": 19.95}
    },
    "expensive": 10
}

# Find the titles of all books
book_titles = jsonpath.findall("$.store.book[*].title", data)
print(f"Book Titles: {book_titles}")

# Find all books cheaper than $10
cheap_books = jsonpath.findall("$.store.book[?(@.price < 10)].title", data)
print(f"Cheap Book Titles: {cheap_books}")

# Compile a JSONPath expression for repeated use
compiled_path = jsonpath.compile("$.store.book[?(@.category == 'fiction')].author")
fiction_authors = compiled_path.findall(data)
print(f"Fiction Authors: {fiction_authors}")