python-jsonpath

KO | EN

gitlite — search

#javascript #python #golang #go #android #linux #docker #macos #windows #vue #pytorch #mcp #ios #openai

python-jsonpath

(★ 78)

A flexible JSONPath engine for Python with JSON Pointer and JSON Patch

파일 탐색기

최종 버전 다운로드 (.zip)

- - lint.yaml
  - tests-no-regex.yaml
  - tests.yaml
  - typing.yaml
- FUNDING.yml
- - style.css
- advanced.md
- api.md
- async.md
- cli.md
- convenience.md
- custom_api.md
- exceptions.md
- functions.md
- index.md
- pointers.md
- query.md
- quickstart.md
- syntax.md
- - __init__.py
  - _pattern.py
  - arguments.py
  - count.py
  - filter_function.py
  - is_instance.py
  - keys.py
  - length.py
  - match.py
  - search.py
  - starts_with.py
  - typeof.py
  - value.py
- __about__.py
- __init__.py
- __main__.py
- _data.py
- _types.py
- cli.py
- env.py
- exceptions.py
- filter.py
- fluent_api.py
- lex.py
- lru_cache.py
- match.py
- parse.py
- patch.py
- path.py
- pointer.py
- py.typed
- segments.py
- selectors.py
- serialize.py
- stream.py
- token.py
- unescape.py
- __init__.py
- _cts_case.py
- consensus.py
- cts
- current_key_identifier.json
- key_selector.json
- keys_filter_selector.json
- keys_selector.json
- membership_operators.json
- nts
- pseudo_root_identifier.json
- query_intersection.json
- query_union.json
- regex_operator.json
- singular_path_selector.json
- test_async.py
- test_cli.py
- test_compare.py
- test_compliance.py
- test_convenience_api.py
- test_current_key_identifier.py
- test_env.py
- test_errors.py
- test_escaped_backslash_string_literals.py
- test_filter_context.py
- test_filter_expression_caching.py
- test_find_reference.py
- test_fluent_api.py
- test_ietf.py
- test_ietf_comparison.py
- test_ietf_well_typedness.py
- test_iregexp.py
- test_isinstance_function.py
- test_issues.py
- test_json_patch.py
- test_json_patch_rfc6902.py
- test_json_pointer.py
- test_json_pointer_rfc6901.py
- test_key_selector.py
- test_keys_filter_selector.py
- test_keys_function.py
- test_keys_selector.py
- test_lex.json
- test_lex.py
- test_match_api.py
- test_membership_operators.py
- test_nts.py
- test_parse.py
- test_parse_compound_path.py
- test_pseudo_root_identifier.py
- test_query_intersection.py
- test_query_projection.py
- test_query_union.py
- test_regex_cache.py
- test_regex_operator.py
- test_relative_json_pointer.py
- test_relative_json_pointer_ietf.py
- test_singular_path_selector.py
- test_startswith_function.py
- test_strictness.py
- test_typeof_function.py
- test_undefined.py
- test_walk_filter_expression_tree.py
- undefined.json
.gitignore
.gitmodules
CHANGELOG.md
CONTRIBUTING.md
LICENSE.txt
mkdocs.yml
pyproject.toml
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">Python JSONPath</h1>

<p align="center">
A flexible JSONPath engine for Python.
<br>
We follow <a href="https://datatracker.ietf.org/doc/html/rfc9535">RFC 9535</a> and test against the <a href="https://github.com/jsonpath-standard/jsonpath-compliance-test-suite">JSONPath Compliance Test Suite</a>.
</p>

---

**Table of Contents**

- [Install](#install)
- [Links](#links)
- [Related projects](#related-projects)
- [Examples](#examples)
- [License](#license)

## Install

Install Python JSONPath using [pip](https://pip.pypa.io/en/stable/getting-started/):

```
pip install python-jsonpath
```

Or [Pipenv](https://pipenv.pypa.io/en/latest/):

```
pipenv install -u python-jsonpath
```

Or from [conda-forge](https://anaconda.org/conda-forge/python-jsonpath):

```
conda install -c conda-forge python-jsonpath
```

## Links

- Documentation: https://jg-rp.github.io/python-jsonpath/.
- JSONPath Syntax: https://jg-rp.github.io/python-jsonpath/syntax/
- Change log: https://github.com/jg-rp/python-jsonpath/blob/main/CHANGELOG.md
- PyPi: https://pypi.org/project/python-jsonpath
- Source code: https://github.com/jg-rp/python-jsonpath
- Issue tracker: https://github.com/jg-rp/python-jsonpath/issues

## Related projects

- [JSONPath RFC 9535](https://github.com/jg-rp/python-jsonpath-rfc9535) - A minimal, slightly cleaner Python implementation of RFC 9535. If you're not interested JSONPath sytax beyond that defined in RFC 9535, you might choose [jsonpath-rfc9535](https://pypi.org/project/jsonpath-rfc9535/) over [python-jsonpath](https://pypi.org/project/python-jsonpath/).

jsonpath-rfc9535 also includes utilities for verifying and testing the [JSONPath Compliance Test Suite](https://github.com/jsonpath-standard/jsonpath-compliance-test-suite). Most notably the nondeterministic behavior of some JSONPath selectors.

- [JSON P3](https://github.com/jg-rp/json-p3) - RFC 9535 implemented in TypeScript. JSON P3 does not include all the non-standard features of Python JSONPath, but does define some optional [extra syntax](https://jg-rp.github.io/json-p3/guides/jsonpath-extra).

- [Ruby JSON P3](https://github.com/jg-rp/ruby-json-p3) - RFC 9535, RFC 6901 and RFC 6902 implemented in Ruby.

## Examples

### JSONPath

```python
import jsonpath

data = {
    "users": [
        {"name": "Sue", "score": 100},
        {"name": "John", "score": 86},
        {"name": "Sally", "score": 84},
        {"name": "Jane", "score": 55},
    ]
}

user_names = jsonpath.findall("$.users[?@.score < 100].name", data)
print(user_names) # ['John', 'Sally', 'Jane']
```

### JSON Pointer

We include an [RFC 6901](https://datatracker.ietf.org/doc/html/rfc6901) compliant implementation of JSON Pointer. See JSON Pointer [quick start](https://jg-rp.github.io/python-jsonpath/quickstart/#pointerresolvepointer-data), [guide](https://jg-rp.github.io/python-jsonpath/pointers/) and [API reference](https://jg-rp.github.io/python-jsonpath/api/#jsonpath.JSONPointer)

```python
from jsonpath import pointer

data = {
    "users": [
        {"name": "Sue", "score": 100},
        {"name": "John", "score": 86},
        {"name": "Sally", "score": 84},
        {"name": "Jane", "score": 55},
    ]
}

sue_score = pointer.resolve("/users/0/score", data)
print(sue_score)  # 100

jane_score = pointer.resolve(["users", 3, "score"], data)
print(jane_score)  # 55
```

### JSON Patch

We also include an [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902) compliant implementation of JSON Patch. See JSON Patch [quick start](https://jg-rp.github.io/python-jsonpath/quickstart/#patchapplypatch-data) and the [API reference](https://jg-rp.github.io/python-jsonpath/api/#jsonpath.JSONPatch).

> [!WARNING]
> Objects passed to `patch.apply()` and `JSONPatch.apply()` are modified in place, even if a patch operation fails. Use `patch.atomic()` or `JSONPatch.atomic()` if you need to preserve input data on patch failure.

```python
from jsonpath import patch

patch_operations = [
    {"op": "add", "path": "/some/foo", "value": {"foo": {}}},
    {"op": "add", "path": "/some/foo", "value": {"bar": []}},
    {"op": "copy", "from": "/some/other", "path": "/some/foo/else"},
    {"op": "add", "path": "/some/foo/bar/-", "value": 1},
]

data = {"some": {"other": "thing"}}
patch.apply(patch_operations, data)
print(data) # {'some': {'other': 'thing', 'foo': {'bar': [1], 'else': 'thing'}}}
```

Use `patch.atomic()` or `JSONPatch.atomic()` if you need to preserve input data on patch failure.

```python
import contextlib

from jsonpath import JSONPatchError
from jsonpath import patch

data = {"some": {"other": "thing"}}

with contextlib.suppress(JSONPatchError):
    patch.atomic(patch_operations, data)

assert data == {"some": {"other": "thing"}}
```

`patch.patched(ops, data)` and `JSONPatch.patched(data)` apply patch operations to a deep copy of `data`.

```python
from jsonpath import patch

data = {"some": {"other": "thing"}}
patched_data = patch.patched(patch_operations, data)

assert data != patched_data
```

## License

`python-jsonpath` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

python-jsonpath

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

python-jsonpath

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README