python-jsonpath 0.5.0__py3-none-any.whl → 0.5.0.post1__py3-none-any.whl

jsonpath/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2023-present James Prior <jamesgr.prior@gmail.com>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "0.5.0"
+__version__ = "0.5.0-post.1"

jsonpath/__init__.py

@@ -7,6 +7,7 @@ from .exceptions import JSONPathError
 from .exceptions import JSONPathNameError
 from .exceptions import JSONPathSyntaxError
 from .exceptions import JSONPathTypeError
+from .filter import UNDEFINED
 from .lex import Lexer
 from .match import JSONPathMatch
 from .parse import Parser
@@ -29,6 +30,7 @@ __all__ = (
     "JSONPathTypeError",
     "Lexer",
     "Parser",
+    "UNDEFINED",
 )
 
 

jsonpath/function_extensions/match.py

@@ -31,7 +31,7 @@ class Match:
 
         try:
             return bool(re.fullmatch(pattern, string))
-        except TypeError:
+        except (TypeError, re.error):
             return False
 
     def validate(

jsonpath/function_extensions/search.py

@@ -31,7 +31,7 @@ class Search:
 
         try:
             return bool(re.search(pattern, string))
-        except TypeError:
+        except (TypeError, re.error):
             return False
 
     def validate(

python_jsonpath-0.5.0.post1.dist-info/METADATA

@@ -0,0 +1,113 @@
+Metadata-Version: 2.1
+Name: python-jsonpath
+Version: 0.5.0.post1
+Summary: Another JSONPath implementation for Python.
+Project-URL: Documentation, https://jg-rp.github.io/python-jsonpath/
+Project-URL: Issues, https://github.com/jg-rp/python-jsonpath/issues
+Project-URL: Source, https://github.com/jg-rp/python-jsonpath
+Author-email: James Prior <jamesgr.prior@gmail.com>
+License-Expression: MIT
+License-File: LICENSE.txt
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+
+# Python JSONPath
+
+[![PyPI - Version](https://img.shields.io/pypi/v/python-jsonpath.svg?style=flat-square)](https://pypi.org/project/python-jsonpath)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/jg-rp/python-jsonpath/tests.yaml?branch=main&label=tests&style=flat-square)](https://github.com/jg-rp/python-jsonpath/actions)
+[![PyPI - License](https://img.shields.io/pypi/l/python-jsonpath?style=flat-square)](https://github.com/jg-rp/python-jsonpath/blob/main/LICENSE.txt)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/python-jsonpath.svg?style=flat-square)](https://pypi.org/project/python-jsonpath)
+
+---
+
+A flexible JSONPath engine for Python.
+
+**Table of Contents**
+
+- [Install](#install)
+- [Links](#links)
+- [Example](#example)
+- [License](#license)
+
+## Install
+
+Install Python JSONPath using [Pipenv](https://pipenv.pypa.io/en/latest/):
+
+```console
+pipenv install -u python-jsonpath
+```
+
+or [pip](https://pip.pypa.io/en/stable/getting-started/):
+
+```console
+pip install 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
+
+## Example
+
+```python
+import jsonpath
+
+data = {
+    "categories": [
+        {
+            "name": "footwear",
+            "products": [
+                {
+                    "title": "Trainers",
+                    "description": "Fashionable trainers.",
+                    "price": 89.99,
+                },
+                {
+                    "title": "Barefoot Trainers",
+                    "description": "Running trainers.",
+                    "price": 130.00,
+                },
+            ],
+        },
+        {
+            "name": "headwear",
+            "products": [
+                {
+                    "title": "Cap",
+                    "description": "Baseball cap",
+                    "price": 15.00,
+                },
+                {
+                    "title": "Beanie",
+                    "description": "Winter running hat.",
+                    "price": 9.00,
+                },
+            ],
+        },
+    ],
+    "price_cap": 10,
+}
+
+products = jsonpath.findall("$..products.*", data)
+print(products)
+```
+
+## License
+
+`python-jsonpath` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

{python_jsonpath-0.5.0.dist-info → python_jsonpath-0.5.0.post1.dist-info}/RECORD

@@ -1,5 +1,5 @@
-jsonpath/__about__.py,sha256=Ax8OiI676rrCyu2AoHuXuKLac1vAQLMmF61nDm1Q2xo,132
-jsonpath/__init__.py,sha256=rqknIKK4kCu_mlKsCe9c9CoH4W4exuOgmG7Wp0qg5Ao,1023
+jsonpath/__about__.py,sha256=hZldckvbIhXFrYcYa_nKfZAxjOcYFuOGy9lZRk4iF8I,139
+jsonpath/__init__.py,sha256=gUgI3mFEPMOAtgh_Pfx6iq-Vq1SIsybOsC_Lixp7qZo,1070
 jsonpath/env.py,sha256=E3LDUjdj-XXFw5koMkaVBhgwWNFRFDjxuUwUL08U6mM,14434
 jsonpath/exceptions.py,sha256=A6lCV7Mtm5ZorJX2cr8qXXWXBqLyX4hRzs6y5rzc4zs,1906
 jsonpath/filter.py,sha256=cVWygNCUGNVmDUDrVJCb8qCz4su_tjD45r0qmziW1hY,12325
@@ -7,6 +7,7 @@ jsonpath/lex.py,sha256=OXz8Az0gMoWQ7XRK1wzGlZ5tbWydfplfQnOI35_4VyY,10881
 jsonpath/match.py,sha256=lJn27VWgTMUeAEO4FtmAmUPvf9FK7hTF8f2yq38KiOk,2513
 jsonpath/parse.py,sha256=MXNQ-TyDLceBP5dWZkQolXpmRDbu8OG2SCGCdJuMmxM,19148
 jsonpath/path.py,sha256=Jp-NQp7bnBWBDqkCrunwWOk8Ujiu2atb9Tc6wTznDjY,11290
+jsonpath/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 jsonpath/selectors.py,sha256=6TIrYpMSvH8NDqfSIo1-4KezS29OFmYMdBdoGdvkpfM,22016
 jsonpath/stream.py,sha256=V9OtMAYl6jdsj2G8e3u-vH7L4iFhA-vm4Z2Aom10Dxk,2567
 jsonpath/token.py,sha256=BS01OCzriOGn85NkyGoC93h_96BQn-GXeeeM2k_sDPc,3650
@@ -14,10 +15,10 @@ jsonpath/function_extensions/__init__.py,sha256=HFtDFqurbIly31Z5R5p5CmpP_su5MOHB
 jsonpath/function_extensions/arguments.py,sha256=buFAlfRZtH-yPT_ENJetZlehHMiGkZF0Ew_xw_4WRyc,1694
 jsonpath/function_extensions/keys.py,sha256=vNdIV8xqr1LMG6RLJwb6iA5-VXgYSZu6CqprXEs6rYM,364
 jsonpath/function_extensions/length.py,sha256=QdwkLLNTbgNKWIx1M8umAHnc5vyc9cjM_vODc6hXDK0,313
-jsonpath/function_extensions/match.py,sha256=8LbDE9gy-9dlxhj4-Tg2Ib4mxRLB42tQapK_X51bVBE,1685
-jsonpath/function_extensions/search.py,sha256=xHO_6OrNYKwpfwWxE8aK5gv_k1De_4gPay5mPIeFGxg,1686
+jsonpath/function_extensions/match.py,sha256=yyv9LMItJBs_20MTPRq7SKn1RrUrXcJtT9oX-WAqS4g,1697
+jsonpath/function_extensions/search.py,sha256=WaX2PDa7Zp6deh5H88r1oSoWbNHnnFMwGd0wygIOyms,1698
 jsonpath/function_extensions/value.py,sha256=7qBf02eqwj6HJp_Gaaw_8UPoH_cAouBfzBEmmb6joRk,402
-python_jsonpath-0.5.0.dist-info/METADATA,sha256=jwzqCUyWL__1x8iX-RwI8RthCh8UatwQRcJUAq0o3Jw,12104
-python_jsonpath-0.5.0.dist-info/WHEEL,sha256=Fd6mP6ydyRguakwUJ05oBE7fh2IPxgtDN9IwHJ9OqJQ,87
-python_jsonpath-0.5.0.dist-info/licenses/LICENSE.txt,sha256=u7PksAQGI1QYWcERHeauMseZ4XAzDKUrKW8Z4wbeU1k,1101
-python_jsonpath-0.5.0.dist-info/RECORD,,
+python_jsonpath-0.5.0.post1.dist-info/METADATA,sha256=gxF3x6alLfirs4vi1kfZ_RB2Znaqmawq4fKhaDLdWFs,3653
+python_jsonpath-0.5.0.post1.dist-info/WHEEL,sha256=Fd6mP6ydyRguakwUJ05oBE7fh2IPxgtDN9IwHJ9OqJQ,87
+python_jsonpath-0.5.0.post1.dist-info/licenses/LICENSE.txt,sha256=u7PksAQGI1QYWcERHeauMseZ4XAzDKUrKW8Z4wbeU1k,1101
+python_jsonpath-0.5.0.post1.dist-info/RECORD,,

python_jsonpath-0.5.0.dist-info/METADATA

@@ -1,321 +0,0 @@
-Metadata-Version: 2.1
-Name: python-jsonpath
-Version: 0.5.0
-Summary: Another JSONPath implementation for Python.
-Project-URL: Documentation, https://jg-rp.github.io/python-jsonpath/
-Project-URL: Issues, https://github.com/jg-rp/python-jsonpath/issues
-Project-URL: Source, https://github.com/jg-rp/python-jsonpath
-Author-email: James Prior <jamesgr.prior@gmail.com>
-License-Expression: MIT
-License-File: LICENSE.txt
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-
-# Python JSONPath
-
-[![PyPI - Version](https://img.shields.io/pypi/v/python-jsonpath.svg?style=flat-square)](https://pypi.org/project/python-jsonpath)
-[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/jg-rp/python-jsonpath/tests.yaml?branch=main&label=tests&style=flat-square)](https://github.com/jg-rp/python-jsonpath/actions)
-[![PyPI - License](https://img.shields.io/pypi/l/python-jsonpath?style=flat-square)](https://github.com/jg-rp/python-jsonpath/blob/main/LICENSE.txt)
-[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/python-jsonpath.svg?style=flat-square)](https://pypi.org/project/python-jsonpath)
-
----
-
-**Table of Contents**
-
-- [Install](#install)
-- [API](#api)
-- [Syntax](#syntax)
-- [License](#license)
-
-A flexible JSONPath engine for Python.
-
-JSONPath is a mini language for extracting objects from data formatted in JavaScript Object Notation, or equivalent Python objects, like dictionaries and lists.
-
-```python
-import jsonpath
-
-data = {
-    "categories": [
-        {
-            "name": "footwear",
-            "products": [
-                {
-                    "title": "Trainers",
-                    "description": "Fashionable trainers.",
-                    "price": 89.99,
-                },
-                {
-                    "title": "Barefoot Trainers",
-                    "description": "Running trainers.",
-                    "price": 130.00,
-                },
-            ],
-        },
-        {
-            "name": "headwear",
-            "products": [
-                {
-                    "title": "Cap",
-                    "description": "Baseball cap",
-                    "price": 15.00,
-                },
-                {
-                    "title": "Beanie",
-                    "description": "Winter running hat.",
-                    "price": 9.00,
-                },
-            ],
-        },
-    ],
-    "price_cap": 10,
-}
-
-products = jsonpath.findall("$..products.*", data)
-print(products)
-```
-
-## Install
-
-Install Python JSONPath using [Pipenv](https://pipenv.pypa.io/en/latest/):
-
-```console
-pipenv install -u python-jsonpath
-```
-
-or [pip](https://pip.pypa.io/en/stable/getting-started/):
-
-```console
-pip install python-jsonpath
-```
-
-or [pipx](https://pypa.github.io/pipx/)
-
-```console
-pipx install python-jsonpath
-```
-
-## API
-
-### jsonpath.findall
-
-`findall(path: str, data: Sequence | Mapping) -> list[object]`
-
-Find all objects in `data` matching the given JSONPath `path`. If data is a string, it will be loaded using `json.loads()` and the default `JSONDecoder`.
-
-Returns a list of matched objects, or an empty list if there were no matches.
-
-### jsonpath.finditer
-
-`finditer(path: str, data: Sequence | Mapping) -> iterable[JSONPathMatch]`
-
-Return an iterator yielding a `JSONPathMatch` instance for each match of the `path` in the given `data`. If data is a string, it will be loaded using `json.loads()` and the default `JSONDecoder`.
-
-### jsonpath.compile
-
-`compile(path: str) -> JSONPath | CompoundJSONPath`
-
-Prepare a path for repeated matching against different data. `jsonpath.findall()` and `jsonpath.finditer()` are convenience functions that call `compile()` for you.
-
-`JSONPath` and `CompoundJSONPath` both have `findall()` and `finditer()` methods that behave the same as `jsonpath.findall()` and `jsonpath.finditer()`, just without the path argument.
-
-### async
-
-`findall_async()` and `finditer_async()` are async equivalents of `findall()` and `finditer()`. They are used when integrating Python JSONPath with [Python Liquid](https://github.com/jg-rp/liquid) and use Python Liquid's [async protocol](https://jg-rp.github.io/liquid/introduction/async-support).
-
-### Extra filter context
-
-`findall()` and `finditer()` take an optional `filter_context` argument, being a mapping of strings to arbitrary data that can be referenced from a [filter expression](#filters-expression).
-
-Use `#` to query extra filter data, similar to how one might use `@` or `$`.
-
-## Syntax
-
-Python JSONPath's default syntax is an opinionated combination of JSONPath features from existing, popular implementations, and much of the [IETF JSONPath draft](https://datatracker.ietf.org/doc/html/draft-ietf-jsonpath-base-11). If you're already familiar with JSONPath syntax, skip to [notable differences](#notable-differences).
-
-Imagine a JSON document as a tree structure, where each object (mapping) and array can contain more objects (mappings), arrays and scalar values. Every object (mapping), array and scalar value is a node in the tree, and the outermost object (mapping) or array is the "root" node.
-
-For our purposes, a JSON "document" could be a file containing valid JSON data, a Python string containing valid JSON data, or a Python `Object` made up of dictionaries (or any [Mapping](https://docs.python.org/3/library/collections.abc.html#collections-abstract-base-classes)), lists (or any [Sequence](https://docs.python.org/3/library/collections.abc.html#collections-abstract-base-classes)), strings, etc.
-
-We chain _selectors_ together to retrieve nodes from the target document. Each selector operates on the nodes matched by preceding selectors.
-
-### Root (`$`)
-
-`$` refers to the first node in the target document, be it an object or an array. Unless referencing the root node from inside a filter expression, `$` is optional. The following two examples are equivalent.
-
-```text
-$.categories.*.name
-```
-
-```text
-categories.*.name
-```
-
-An empty path or a path containing just the root (`$`) selector returns the input data in its entirety.
-
-### Properties (`.thing`, `[thing]` or `['thing']`)
-
-Select nodes by property/key name using dot notation (`.something`) or bracket notation (`[something]`). If a target property/key contains reserved characters, it must use bracket notation and be enclosed in quotes (`['thing']`).
-
-A dot in front of bracket notation is OK, but unnecessary. The following examples are equivalent.
-
-```text
-$.categories[0].name
-```
-
-```text
-$.categories[0][name]
-```
-
-```text
-$.categories[0]['name']
-```
-
-### Array indices (`[0]` or `[-1]`)
-
-Select an item from an array by its index. Indices are zero-based and enclosed in brackets. If the index is negative, items are selected from the end of the array. Considering example data from the top of this page, the following examples are equivalent.
-
-```text
-$.categories[0]
-```
-
-```text
-$.categories[-1]
-```
-
-### Wildcard (`.*` or `[*]`)
-
-Select all elements from an array or all values from an object using `*`. These two examples are equivalent.
-
-```text
-$.categories[0].products.*
-```
-
-```text
-$.categories[0].products[*]
-```
-
-### Slices (`[0:-1]` or `[-1:0:-1]`)
-
-Select a range of elements from an array using slice notation. The start index, stop index and step are all optional. These examples are equivalent.
-
-```text
-$.categories[0:]
-```
-
-```text
-$.categories[0:-1:]
-```
-
-```text
-$.categories[0:-1:1]
-```
-
-```text
-$.categories[::]
-```
-
-### Lists (`[1, 2, 10:20]`)
-
-Select multiple indices, slices or properties using list notation (sometimes known as a "union" or "segment", we use "union" to mean something else).
-
-```text
-$..products.*.[title, price]
-```
-
-### Recursive descent (`..`)
-
-The `..` selector visits every node beneath the current selection. If a property selector, using dot notation, follows `..`, the dot is optional. These two examples are equivalent.
-
-```text
-$..title
-```
-
-```text
-$...title
-```
-
-### Filters (`[?(EXPRESSION)]`)
-
-Filters allow you to remove nodes from a selection using a Boolean expression. Within a filter, `@` refers to the current node and `$` refers to the root node in the target document. `@` and `$` can be used to select nodes as part of the expression. Since version 0.3.0, the parentheses are optional, as per the IETF JSONPath draft. These two examples are equivalent.
-
-```text
-$..products[?(@.price < $.price_cap)]
-```
-
-```text
-$..products[?@.price < $.price_cap]
-```
-
-Comparison operators include `==`, `!=`, `<`, `>`, `<=` and `>=`. Plus `<>` as an alias for `!=`.
-
-`in` and `contains` are membership operators. `left in right` is equivalent to `right contains left`.
-
-`&&` and `||` are logical operators, `and` and `or` work too.
-
-`=~` matches the left value with a regular expression literal. Regular expressions use a syntax similar to that found in JavaScript, where the pattern to match is surrounded by slashes, optionally followed by flags.
-
-```text
-$..products[?(@.description =~ /.*trainers/i)]
-```
-
-Filters can use [function extensions](#function-extensions) too.
-
-### Union (`|`) and intersection (`&`)
-
-Union (`|`) and intersection (`&`) are similar to Python's set operations, but we don't dedupe the matches (matches will often contain unhashable objects).
-
-The `|` operator combines matches from two or more paths. This example selects a single list of all prices, plus the price cap as the last element.
-
-```text
-$..products.*.price | $.price_cap
-```
-
-The `&` operator produces matches that are common to both left and right paths. This example would select the list of products that are common to both the "footwear" and "headwear" categories.
-
-```text
-$.categories[?(@.name == 'footwear')].products.* & $.categories[?(@.name == 'headwear')].products.*
-```
-
-Note that `|` and `&` are not allowed inside filter expressions.
-
-## Function extensions
-
-TODO:
-
-## Notable differences
-
-This is a list of things that you might find in other JSONPath implementation that we don't support (yet).
-
-- We don't support extension functions of the form `selector.func()`.
-- We always return a list of matches from `jsonpath.findall()`, never a scalar value.
-- We do not support arithmetic in filter expression.
-- Python JSONPath is strictly read only. There are no update "selectors", although a Python API for working with `JSONPathMatch`s may well be added in the future.
-
-And this is a list of areas where we deviate from the [IETF JSONPath draft](https://datatracker.ietf.org/doc/html/draft-ietf-jsonpath-base-11).
-
-- We don't yet follow all "non-singular query" rules when evaluating a filter comparison.
-- We don't yet force the result of some filter functions to be compared.
-- Whitespace is mostly insignificant unless inside quotes.
-- The root token (default `$`) is optional.
-- Paths starting with a dot (`.`) are OK. `.thing` is the same as `$.thing`, as is `thing`, `$[thing]` and `$["thing"]`.
-
-And this is a list of features that are uncommon or unique to Python JSONPath.
-
-- `|` is a union operator, where matches from two or more JSONPaths are combined. This is not part of the Python API, but built-in to the JSONPath syntax.
-- `&` is an intersection operator, where we exclude matches that don't exist in both left and right paths. This is not part of the Python API, but built-in to the JSONPath syntax.
-- `#` is a filter context selector. With usage similar to `$` and `@`, `#` exposes arbitrary data from the `filter_context` argument to `findall()` and `finditer()`.
-
-## License
-
-`python-jsonpath` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.