python-jsonpath 1.2.2__py3-none-any.whl → 1.3.1__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__ = "1.2.2"
+__version__ = "1.3.1"

jsonpath/__init__.py

@@ -24,6 +24,7 @@ from .fluent_api import Projection
 from .fluent_api import Query
 from .lex import Lexer
 from .match import JSONPathMatch
+from .match import NodeList
 from .parse import Parser
 from .patch import JSONPatch
 from .path import CompoundJSONPath
@@ -58,6 +59,7 @@ __all__ = (
     "JSONPointerResolutionError",
     "JSONPointerTypeError",
     "Lexer",
+    "NodeList",
     "match",
     "Parser",
     "Projection",

jsonpath/filter.py

@@ -3,7 +3,6 @@
 from __future__ import annotations
 
 import copy
-import json
 import re
 from abc import ABC
 from abc import abstractmethod
@@ -25,12 +24,13 @@ from .function_extensions import FilterFunction
 from .match import NodeList
 from .selectors import Filter as FilterSelector
 from .selectors import ListSelector
+from .serialize import canonical_string
 
 if TYPE_CHECKING:
     from .path import JSONPath
     from .selectors import FilterContext
 
-# ruff: noqa: D102
+# ruff: noqa: D102, PLW1641
 
 
 class FilterExpression(ABC):
@@ -208,7 +208,7 @@ class StringLiteral(Literal[str]):
     __slots__ = ()
 
     def __str__(self) -> str:
-        return json.dumps(self.value)
+        return canonical_string(self.value)
 
 
 class IntegerLiteral(Literal[int]):
@@ -375,6 +375,12 @@ class InfixExpression(FilterExpression):
         self.right = children[1]
 
 
+PRECEDENCE_LOWEST = 1
+PRECEDENCE_LOGICAL_OR = 3
+PRECEDENCE_LOGICAL_AND = 4
+PRECEDENCE_PREFIX = 7
+
+
 class BooleanExpression(FilterExpression):
     """An expression that always evaluates to `True` or `False`."""
 
@@ -408,13 +414,40 @@ class BooleanExpression(FilterExpression):
         )
 
     def __str__(self) -> str:
-        return str(self.expression)
+        return self._canonical_string(self.expression, PRECEDENCE_LOWEST)
 
     def __eq__(self, other: object) -> bool:
         return (
             isinstance(other, BooleanExpression) and self.expression == other.expression
         )
 
+    def _canonical_string(
+        self, expression: FilterExpression, parent_precedence: int
+    ) -> str:
+        if isinstance(expression, InfixExpression):
+            if expression.operator == "&&":
+                left = self._canonical_string(expression.left, PRECEDENCE_LOGICAL_AND)
+                right = self._canonical_string(expression.right, PRECEDENCE_LOGICAL_AND)
+                expr = f"{left} && {right}"
+                return (
+                    f"({expr})" if parent_precedence >= PRECEDENCE_LOGICAL_AND else expr
+                )
+
+            if expression.operator == "||":
+                left = self._canonical_string(expression.left, PRECEDENCE_LOGICAL_OR)
+                right = self._canonical_string(expression.right, PRECEDENCE_LOGICAL_OR)
+                expr = f"{left} || {right}"
+                return (
+                    f"({expr})" if parent_precedence >= PRECEDENCE_LOGICAL_OR else expr
+                )
+
+        if isinstance(expression, PrefixExpression):
+            operand = self._canonical_string(expression.right, PRECEDENCE_PREFIX)
+            expr = f"!{operand}"
+            return f"({expr})" if parent_precedence > PRECEDENCE_PREFIX else expr
+
+        return str(expression)
+
     def evaluate(self, context: FilterContext) -> bool:
         return context.env.is_truthy(self.expression.evaluate(context))
 

jsonpath/function_extensions/arguments.py

@@ -1,4 +1,5 @@
 """Class-based function extension base."""
+
 import inspect
 from typing import TYPE_CHECKING
 from typing import Any
@@ -26,7 +27,7 @@ def validate(
     params = list(inspect.signature(func).parameters.values())
 
     # Keyword only params are not supported
-    if len([p for p in params if p.kind in (p.KEYWORD_ONLY, p.VAR_KEYWORD)]):
+    if [p for p in params if p.kind in (p.KEYWORD_ONLY, p.VAR_KEYWORD)]:
         raise JSONPathTypeError(
             f"function {token.value!r} requires keyword arguments",
             token=token,

jsonpath/match.py

@@ -1,4 +1,5 @@
 """The JSONPath match object, as returned from `JSONPath.finditer()`."""
+
 from __future__ import annotations
 
 from typing import Any
@@ -104,6 +105,10 @@ class NodeList(List[JSONPathMatch]):
             return self[0].obj
         return [match.obj for match in self]
 
+    def paths(self) -> List[str]:
+        """Return a normalized path for each node in this node list."""
+        return [match.path for match in self]
+
     def empty(self) -> bool:
         """Return `True` if this node list is empty."""
         return not bool(self)

jsonpath/patch.py

@@ -74,7 +74,7 @@ class OpAdd(Op):
             else:
                 parent.insert(int(target), self.value)
         elif isinstance(parent, MutableMapping):
-            parent[target] = self.value
+            parent[str(target)] = self.value
         else:
             raise JSONPatchError(
                 f"unexpected operation on {parent.__class__.__name__!r}"
@@ -124,7 +124,7 @@ class OpAddAp(OpAdd):
     """A non-standard add operation that appends to arrays/lists .
 
     This is like _OpAdd_, but assumes an index of "-" if the path can not
-    be resolved.
+    be resolved rather than raising a JSONPatchError.
 
     **New in version 1.2.0**
     """
@@ -183,7 +183,7 @@ class OpRemove(Op):
         elif isinstance(parent, MutableMapping):
             if obj is UNDEFINED:
                 raise JSONPatchError("can't remove nonexistent property")
-            del parent[self.path.parts[-1]]
+            del parent[str(self.path.parts[-1])]
         else:
             raise JSONPatchError(
                 f"unexpected operation on {parent.__class__.__name__!r}"
@@ -221,7 +221,7 @@ class OpReplace(Op):
         elif isinstance(parent, MutableMapping):
             if obj is UNDEFINED:
                 raise JSONPatchError("can't replace nonexistent property")
-            parent[self.path.parts[-1]] = self.value
+            parent[str(self.path.parts[-1])] = self.value
         else:
             raise JSONPatchError(
                 f"unexpected operation on {parent.__class__.__name__!r}"
@@ -259,7 +259,7 @@ class OpMove(Op):
         if isinstance(source_parent, MutableSequence):
             del source_parent[int(self.source.parts[-1])]
         if isinstance(source_parent, MutableMapping):
-            del source_parent[self.source.parts[-1]]
+            del source_parent[str(self.source.parts[-1])]
 
         dest_parent, _ = self.dest.resolve_parent(data)
 
@@ -270,7 +270,7 @@ class OpMove(Op):
         if isinstance(dest_parent, MutableSequence):
             dest_parent.insert(int(self.dest.parts[-1]), source_obj)
         elif isinstance(dest_parent, MutableMapping):
-            dest_parent[self.dest.parts[-1]] = source_obj
+            dest_parent[str(self.dest.parts[-1])] = source_obj
         else:
             raise JSONPatchError(
                 f"unexpected operation on {dest_parent.__class__.__name__!r}"
@@ -312,7 +312,7 @@ class OpCopy(Op):
         if isinstance(dest_parent, MutableSequence):
             dest_parent.insert(int(self.dest.parts[-1]), copy.deepcopy(source_obj))
         elif isinstance(dest_parent, MutableMapping):
-            dest_parent[self.dest.parts[-1]] = copy.deepcopy(source_obj)
+            dest_parent[str(self.dest.parts[-1])] = copy.deepcopy(source_obj)
         else:
             raise JSONPatchError(
                 f"unexpected operation on {dest_parent.__class__.__name__!r}"
@@ -419,7 +419,7 @@ class JSONPatch:
                     value=self._op_value(operation, "value", "addne", i),
                 )
             elif op == "addap":
-                self.addne(
+                self.addap(
                     path=self._op_pointer(operation, "path", "addap", i),
                     value=self._op_value(operation, "value", "addap", i),
                 )

jsonpath/pointer.py

@@ -485,6 +485,9 @@ class RelativeJSONPointer:
     def __eq__(self, __value: object) -> bool:
         return isinstance(__value, RelativeJSONPointer) and str(self) == str(__value)
 
+    def __hash__(self) -> int:
+        return hash((self.origin, self.index, self.pointer))
+
     def _parse(
         self,
         rel: str,

jsonpath/selectors.py

@@ -1,4 +1,5 @@
 """JSONPath segments and selectors, as returned from `Parser.parse`."""
+
 from __future__ import annotations
 
 from abc import ABC
@@ -17,6 +18,7 @@ from typing import Union
 
 from .exceptions import JSONPathIndexError
 from .exceptions import JSONPathTypeError
+from .serialize import canonical_string
 
 if TYPE_CHECKING:
     from .env import JSONPathEnvironment
@@ -75,7 +77,11 @@ class PropertySelector(JSONPathSelector):
         self.shorthand = shorthand
 
     def __str__(self) -> str:
-        return f"['{self.name}']" if self.shorthand else f"'{self.name}'"
+        return (
+            f"[{canonical_string(self.name)}]"
+            if self.shorthand
+            else f"{canonical_string(self.name)}"
+        )
 
     def __eq__(self, __value: object) -> bool:
         return (
@@ -98,7 +104,7 @@ class PropertySelector(JSONPathSelector):
                     obj=self.env.getitem(match.obj, self.name),
                     parent=match,
                     parts=match.parts + (self.name,),
-                    path=match.path + f"['{self.name}']",
+                    path=match.path + f"[{canonical_string(self.name)}]",
                     root=match.root,
                 )
                 match.add_child(_match)
@@ -117,7 +123,7 @@ class PropertySelector(JSONPathSelector):
                     obj=await self.env.getitem_async(match.obj, self.name),
                     parent=match,
                     parts=match.parts + (self.name,),
-                    path=match.path + f"['{self.name}']",
+                    path=match.path + f"[{canonical_string(self.name)}]",
                     root=match.root,
                 )
                 match.add_child(_match)
@@ -321,20 +327,15 @@ class SliceSelector(JSONPathSelector):
             ):
                 raise JSONPathIndexError("index out of range", token=self.token)
 
-    def _normalized_index(self, obj: Sequence[object], index: int) -> int:
-        if index < 0 and len(obj) >= abs(index):
-            return len(obj) + index
-        return index
-
     def resolve(self, matches: Iterable[JSONPathMatch]) -> Iterable[JSONPathMatch]:
         for match in matches:
             if not isinstance(match.obj, Sequence) or self.slice.step == 0:
                 continue
 
-            idx = self.slice.start or 0
-            step = self.slice.step or 1
-            for obj in self.env.getitem(match.obj, self.slice):
-                norm_index = self._normalized_index(match.obj, idx)
+            for norm_index, obj in zip(  # noqa: B905
+                range(*self.slice.indices(len(match.obj))),
+                self.env.getitem(match.obj, self.slice),
+            ):
                 _match = self.env.match_class(
                     filter_context=match.filter_context(),
                     obj=obj,
@@ -345,7 +346,6 @@ class SliceSelector(JSONPathSelector):
                 )
                 match.add_child(_match)
                 yield _match
-                idx += step
 
     async def resolve_async(
         self, matches: AsyncIterable[JSONPathMatch]
@@ -354,10 +354,10 @@ class SliceSelector(JSONPathSelector):
             if not isinstance(match.obj, Sequence) or self.slice.step == 0:
                 continue
 
-            idx = self.slice.start or 0
-            step = self.slice.step or 1
-            for obj in await self.env.getitem_async(match.obj, self.slice):
-                norm_index = self._normalized_index(match.obj, idx)
+            for norm_index, obj in zip(  # noqa: B905
+                range(*self.slice.indices(len(match.obj))),
+                await self.env.getitem_async(match.obj, self.slice),
+            ):
                 _match = self.env.match_class(
                     filter_context=match.filter_context(),
                     obj=obj,
@@ -368,7 +368,6 @@ class SliceSelector(JSONPathSelector):
                 )
                 match.add_child(_match)
                 yield _match
-                idx += step
 
 
 class WildSelector(JSONPathSelector):
@@ -402,7 +401,7 @@ class WildSelector(JSONPathSelector):
                         obj=val,
                         parent=match,
                         parts=match.parts + (key,),
-                        path=match.path + f"['{key}']",
+                        path=match.path + f"[{canonical_string(key)}]",
                         root=match.root,
                     )
                     match.add_child(_match)
@@ -431,7 +430,7 @@ class WildSelector(JSONPathSelector):
                         obj=val,
                         parent=match,
                         parts=match.parts + (key,),
-                        path=match.path + f"['{key}']",
+                        path=match.path + f"[{canonical_string(key)}]",
                         root=match.root,
                     )
                     match.add_child(_match)
@@ -479,7 +478,7 @@ class RecursiveDescentSelector(JSONPathSelector):
                         obj=val,
                         parent=match,
                         parts=match.parts + (key,),
-                        path=match.path + f"['{key}']",
+                        path=match.path + f"[{canonical_string(key)}]",
                         root=match.root,
                     )
                     match.add_child(_match)
@@ -633,7 +632,7 @@ class Filter(JSONPathSelector):
                                 obj=val,
                                 parent=match,
                                 parts=match.parts + (key,),
-                                path=match.path + f"['{key}']",
+                                path=match.path + f"[{canonical_string(key)}]",
                                 root=match.root,
                             )
                             match.add_child(_match)
@@ -701,7 +700,7 @@ class Filter(JSONPathSelector):
                             obj=val,
                             parent=match,
                             parts=match.parts + (key,),
-                            path=match.path + f"['{key}']",
+                            path=match.path + f"[{canonical_string(key)}]",
                             root=match.root,
                         )
                         match.add_child(_match)

jsonpath/serialize.py

@@ -0,0 +1,13 @@
+"""Helper functions for serializing compiled JSONPath queries."""
+
+import json
+
+
+def canonical_string(value: str) -> str:
+    """Return _value_ as a canonically formatted string literal."""
+    single_quoted = (
+        json.dumps(value, ensure_ascii=False)[1:-1]
+        .replace('\\"', '"')
+        .replace("'", "\\'")
+    )
+    return f"'{single_quoted}'"

{python_jsonpath-1.2.2.dist-info → python_jsonpath-1.3.1.dist-info}/METADATA

@@ -1,12 +1,13 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: python-jsonpath
-Version: 1.2.2
+Version: 1.3.1
 Summary: JSONPath, JSON Pointer and JSON Patch 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: MIT
+License-Expression: MIT
+License-File: LICENSE.txt
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
@@ -96,6 +97,8 @@ conda install -c conda-forge python-jsonpath
 
 - [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_jsonpath-1.2.2.dist-info → python_jsonpath-1.3.1.dist-info}/RECORD

@@ -1,24 +1,25 @@
-jsonpath/__about__.py,sha256=_iZoSz5H1QL_IGahln1eJLDPeCpxCbG73dj16UsIHNM,132
-jsonpath/__init__.py,sha256=bhEkdyCEv_5MS9J-VyMSRAyIRc-jmKFjLee8-3SYQ3U,2368
+jsonpath/__about__.py,sha256=gvEMxyEUsNjYzzau44eiB6YzOhHDm8YRiKAjgKjAExk,132
+jsonpath/__init__.py,sha256=RTvhFGRb7yLLPUe80a6qD2WAv9gXRe5J69kx0-K6HXc,2412
 jsonpath/__main__.py,sha256=6Y5wOE7U-MHymopXOsxofaY30tVZYPGTJO0L4vytoUw,61
 jsonpath/_data.py,sha256=JEpu5Kg0_kgxYKUilBcHVdTmPxf3-Vc0NgaW6olsqyY,577
 jsonpath/cli.py,sha256=scpWfJXl1jLQ80ZyXqMCu8JtRgZUXluC11x6OkC4oeA,10026
 jsonpath/env.py,sha256=EqlLT6_WE7WbChNs_xDipF7V8uGG3EnyKabJ_bstpGs,22815
 jsonpath/exceptions.py,sha256=5n-9vaKTu5asWllHT0IN-824ewcNCyQIyKvQ58TERVk,4351
-jsonpath/filter.py,sha256=b2s_QXjZvcefh7LfDTqSHM-hM5VYy4bpjn1IQRAjeO8,20637
+jsonpath/filter.py,sha256=hat_VU2aXXGUyb7QEYpziW2YRx1DkbJhRCFP_lEPI0M,22051
 jsonpath/fluent_api.py,sha256=mfAA2t-xUGOmGVr_1h9lxo3y4FsAvaxOpvOH8jZ4DHU,9117
 jsonpath/lex.py,sha256=8yrSLd3Q3A9Y4GeacOjboUp40XsR_BkRDQ3CC3UVcP8,10296
-jsonpath/match.py,sha256=b8fkPHsYjJSrTEOi68MFEyOCj0-FoQjFmMq-Ex4qvo0,3503
+jsonpath/match.py,sha256=qJ8IUn8RsuC-iL6RKr2vTn0l1f7bcx1m9cnZiAEqYH0,3657
 jsonpath/parse.py,sha256=s7BuFsSgX2GuDubrFr-SDcCk2ZInGzPV04FNFcUwxPM,25214
-jsonpath/patch.py,sha256=tSr8-cGOY4lgnSX1PTYotObIZfakbTRaktrO4M4dqgQ,25321
+jsonpath/patch.py,sha256=T6CP0GDJg6drD9qWs6ueRFdQRhXj_xPGEtW5x01iJb8,25388
 jsonpath/path.py,sha256=RUeP7k_WcvP5ZnYblcRDd_-wgo9VnMKyIevTcRImYE4,16421
-jsonpath/pointer.py,sha256=v8k16orIFFOHY1q_QRa5dj4gtPKA--YLA9srOLZpK_E,22299
+jsonpath/pointer.py,sha256=ERoBZvw5QlA7aRaecRTYPiQRFLbwTBe41deguJVOf0k,22392
 jsonpath/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-jsonpath/selectors.py,sha256=u7YcHBt_yEQv0CeTtsOwVQuP5bHLT0_lnulUwShCKdQ,27370
+jsonpath/selectors.py,sha256=oesy964W8Qd1qSSb0qtWJY63A2D0lZc0ppF-pGEYmgU,27313
+jsonpath/serialize.py,sha256=viMcWY52wkUseTNfPKillVWswHePJ2L_B3PV3bDVvmU,360
 jsonpath/stream.py,sha256=S1xxgOsJlivu6Y8-kejMoYm7MgSlhjnoX_H5cem5Yhk,2815
 jsonpath/token.py,sha256=2xD2Wrxj7TgyREUhQxzcBcOWLhjz8demYBJ7BqaNJMA,3938
 jsonpath/function_extensions/__init__.py,sha256=wrUayhwlm6iNLnSIx_ER6EeGiqR91T_SIjNBUr42nX0,548
-jsonpath/function_extensions/arguments.py,sha256=whu8c76HGi5Bdj9U39hF71XGoRXpzwdUWmLw6Aumno8,1700
+jsonpath/function_extensions/arguments.py,sha256=gldld_5YHBEWRsZ5jDj9sDm3qj8i6O_8PlOQ3hdH0WU,1696
 jsonpath/function_extensions/count.py,sha256=FzTOkOLa01PFFSR1wjkDEOyBr_ZC_6yrNfFyGgx7NAk,581
 jsonpath/function_extensions/filter_function.py,sha256=B6z-02xO6CtNghLN92Acr_UmeiWwJaRDLCOTMcPOrfg,834
 jsonpath/function_extensions/is_instance.py,sha256=qm9m3UpKJew7qsuSQ5dEem7Ybo4jhCM1uf12wre0SRg,1760
@@ -28,8 +29,8 @@ jsonpath/function_extensions/match.py,sha256=KjsH33fCFGonp2RV__FuaeIOTwLLcvgaaCi
 jsonpath/function_extensions/search.py,sha256=O11fnkHlbvf0QPrLISYfhlPXBvVPBr-U8V0dGbd614Y,710
 jsonpath/function_extensions/typeof.py,sha256=yCAj9zOqSnam1mfHCGolNHWDmsBOvU3rAhbZDYycx50,1780
 jsonpath/function_extensions/value.py,sha256=fQMbPUV87Jn1nOwAlBpTeLmLIG5ejH0XQBOM_SR-Us4,721
-python_jsonpath-1.2.2.dist-info/METADATA,sha256=Mn-V3WnVVD-_id7rRuc5PH0e4bNfmJXVTX10LoRx4Ec,6344
-python_jsonpath-1.2.2.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-python_jsonpath-1.2.2.dist-info/entry_points.txt,sha256=xvbWnAebJyOMI_9ugK0xrpFRlwmEsAJD2kNHU0Dvscc,43
-python_jsonpath-1.2.2.dist-info/licenses/LICENSE.txt,sha256=u7PksAQGI1QYWcERHeauMseZ4XAzDKUrKW8Z4wbeU1k,1101
-python_jsonpath-1.2.2.dist-info/RECORD,,
+python_jsonpath-1.3.1.dist-info/METADATA,sha256=h7wTnS0BuY1FAC3CaPugqm1U5B8k0UFi-XP-70d98Ws,6493
+python_jsonpath-1.3.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_jsonpath-1.3.1.dist-info/entry_points.txt,sha256=xvbWnAebJyOMI_9ugK0xrpFRlwmEsAJD2kNHU0Dvscc,43
+python_jsonpath-1.3.1.dist-info/licenses/LICENSE.txt,sha256=u7PksAQGI1QYWcERHeauMseZ4XAzDKUrKW8Z4wbeU1k,1101
+python_jsonpath-1.3.1.dist-info/RECORD,,

{python_jsonpath-1.2.2.dist-info → python_jsonpath-1.3.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.26.3
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any