1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
|
"""A compiled JSONPath ready to be applied to a JSON string or Python object."""
from __future__ import annotations
import itertools
from typing import TYPE_CHECKING
from typing import AsyncIterable
from typing import Iterable
from typing import List
from typing import Optional
from typing import Tuple
from typing import TypeVar
from typing import Union
from jsonpath._data import load_data
from jsonpath.fluent_api import Query
from jsonpath.match import FilterContextVars
from jsonpath.match import JSONPathMatch
from jsonpath.segments import JSONPathRecursiveDescentSegment
from jsonpath.selectors import IndexSelector
from jsonpath.selectors import NameSelector
if TYPE_CHECKING:
from jsonpath._types import JSONData
from .env import JSONPathEnvironment
from .segments import JSONPathSegment
class JSONPath:
"""A compiled JSONPath ready to be applied to a JSON string or Python object.
Arguments:
env: The `JSONPathEnvironment` this path is bound to.
segments: An iterable of `JSONPathSegment` instances, as generated by
a `Parser`.
pseudo_root: Indicates if target JSON values should be wrapped in a single-
element array, so as to make the target root value selectable.
Attributes:
env: The `JSONPathEnvironment` this path is bound to.
selectors: The `JSONPathSelector` instances that make up this path.
"""
__slots__ = ("env", "pseudo_root", "segments")
def __init__(
self,
*,
env: JSONPathEnvironment,
segments: Iterable[JSONPathSegment],
pseudo_root: bool = False,
) -> None:
self.env = env
self.segments = tuple(segments)
self.pseudo_root = pseudo_root
def __str__(self) -> str:
return self.env.root_token + "".join(str(segment) for segment in self.segments)
def __eq__(self, __value: object) -> bool:
return isinstance(__value, JSONPath) and self.segments == __value.segments
def __hash__(self) -> int:
return hash(self.segments)
def findall(
self, data: JSONData, *, filter_context: Optional[FilterContextVars] = None
) -> List[object]:
"""Find all objects in `data` matching the given JSONPath `path`.
If `data` is a string or a file-like objects, it will be loaded
using `json.loads()` and the default `JSONDecoder`.
Arguments:
data: A JSON document or Python object implementing the `Sequence`
or `Mapping` interfaces.
filter_context: Arbitrary data made available to filters using
the _filter context_ selector.
Returns:
A list of matched objects. If there are no matches, the list will
be empty.
Raises:
JSONPathSyntaxError: If the path is invalid.
JSONPathTypeError: If a filter expression attempts to use types in
an incompatible way.
"""
return [
match.obj for match in self.finditer(data, filter_context=filter_context)
]
def finditer(
self, data: JSONData, *, filter_context: Optional[FilterContextVars] = None
) -> Iterable[JSONPathMatch]:
"""Generate `JSONPathMatch` objects for each match.
If `data` is a string or a file-like objects, it will be loaded
using `json.loads()` and the default `JSONDecoder`.
Arguments:
data: A JSON document or Python object implementing the `Sequence`
or `Mapping` interfaces.
filter_context: Arbitrary data made available to filters using
the _filter context_ selector.
Returns:
An iterator yielding `JSONPathMatch` objects for each match.
Raises:
JSONPathSyntaxError: If the path is invalid.
JSONPathTypeError: If a filter expression attempts to use types in
an incompatible way.
"""
_data = load_data(data)
path = self.env.pseudo_root_token if self.pseudo_root else self.env.root_token
matches: Iterable[JSONPathMatch] = [
JSONPathMatch(
filter_context=filter_context or {},
obj=[_data] if self.pseudo_root else _data,
parent=None,
path=path,
parts=(),
root=_data,
)
]
for segment in self.segments:
matches = segment.resolve(matches)
return matches
async def findall_async(
self, data: JSONData, *, filter_context: Optional[FilterContextVars] = None
) -> List[object]:
"""An async version of `findall()`."""
return [
match.obj
async for match in await self.finditer_async(
data, filter_context=filter_context
)
]
async def finditer_async(
self, data: JSONData, *, filter_context: Optional[FilterContextVars] = None
) -> AsyncIterable[JSONPathMatch]:
"""An async version of `finditer()`."""
_data = load_data(data)
path = self.env.pseudo_root_token if self.pseudo_root else self.env.root_token
async def root_iter() -> AsyncIterable[JSONPathMatch]:
yield self.env.match_class(
filter_context=filter_context or {},
obj=[_data] if self.pseudo_root else _data,
parent=None,
path=path,
parts=(),
root=_data,
)
matches: AsyncIterable[JSONPathMatch] = root_iter()
for segment in self.segments:
matches = segment.resolve_async(matches)
return matches
def match(
self, data: JSONData, *, filter_context: Optional[FilterContextVars] = None
) -> Union[JSONPathMatch, None]:
"""Return a `JSONPathMatch` instance for the first object found in _data_.
`None` is returned if there are no matches.
Arguments:
data: A JSON document or Python object implementing the `Sequence`
or `Mapping` interfaces.
filter_context: Arbitrary data made available to filters using
the _filter context_ selector.
Returns:
A `JSONPathMatch` object for the first match, or `None` if there were
no matches.
Raises:
JSONPathSyntaxError: If the path is invalid.
JSONPathTypeError: If a filter expression attempts to use types in
an incompatible way.
"""
try:
return next(iter(self.finditer(data, filter_context=filter_context)))
except StopIteration:
return None
def query(
self, data: JSONData, *, filter_context: Optional[FilterContextVars] = None
) -> Query:
"""Return a `Query` iterator over matches found by applying this path to _data_.
Arguments:
data: A JSON document or Python object implementing the `Sequence`
or `Mapping` interfaces.
filter_context: Arbitrary data made available to filters using
the _filter context_ selector.
Returns:
A query iterator.
Raises:
JSONPathSyntaxError: If the path is invalid.
JSONPathTypeError: If a filter expression attempts to use types in
an incompatible way.
"""
return Query(self.finditer(data, filter_context=filter_context), self.env)
def empty(self) -> bool:
"""Return `True` if this path has no selectors."""
return not bool(self.segments)
def singular_query(self) -> bool:
"""Return `True` if this JSONPath query is a singular query."""
for segment in self.segments:
if isinstance(segment, JSONPathRecursiveDescentSegment):
return False
if len(segment.selectors) == 1 and isinstance(
segment.selectors[0], (NameSelector, IndexSelector)
):
continue
return False
return True
class CompoundJSONPath:
"""Multiple `JSONPath`s combined."""
__slots__ = ("env", "path", "paths")
def __init__(
self,
*,
env: JSONPathEnvironment,
path: Union[JSONPath, CompoundJSONPath],
paths: Iterable[Tuple[str, JSONPath]] = (),
) -> None:
self.env = env
self.path = path
self.paths = tuple(paths)
def __str__(self) -> str:
buf: List[str] = [str(self.path)]
for op, path in self.paths:
buf.append(f" {op} ")
buf.append(str(path))
return "".join(buf)
def __eq__(self, __value: object) -> bool:
return (
isinstance(__value, CompoundJSONPath)
and self.path == __value.path
and self.paths == __value.paths
)
def __hash__(self) -> int:
return hash((self.path, self.paths))
def findall(
self, data: JSONData, *, filter_context: Optional[FilterContextVars] = None
) -> List[object]:
"""Find all objects in `data` matching the given JSONPath `path`.
If `data` is a string or a file-like objects, it will be loaded
using `json.loads()` and the default `JSONDecoder`.
Arguments:
data: A JSON document or Python object implementing the `Sequence`
or `Mapping` interfaces.
filter_context: Arbitrary data made available to filters using
the _filter context_ selector.
Returns:
A list of matched objects. If there are no matches, the list will
be empty.
Raises:
JSONPathSyntaxError: If the path is invalid.
JSONPathTypeError: If a filter expression attempts to use types in
an incompatible way.
"""
objs = self.path.findall(data, filter_context=filter_context)
for op, path in self.paths:
_objs = path.findall(data, filter_context=filter_context)
if op == self.env.union_token:
objs.extend(_objs)
else:
assert op == self.env.intersection_token, op
objs = [obj for obj in objs if obj in _objs]
return objs
def finditer(
self, data: JSONData, *, filter_context: Optional[FilterContextVars] = None
) -> Iterable[JSONPathMatch]:
"""Generate `JSONPathMatch` objects for each match.
If `data` is a string or a file-like objects, it will be loaded
using `json.loads()` and the default `JSONDecoder`.
Arguments:
data: A JSON document or Python object implementing the `Sequence`
or `Mapping` interfaces.
filter_context: Arbitrary data made available to filters using
the _filter context_ selector.
Returns:
An iterator yielding `JSONPathMatch` objects for each match.
Raises:
JSONPathSyntaxError: If the path is invalid.
JSONPathTypeError: If a filter expression attempts to use types in
an incompatible way.
"""
matches = self.path.finditer(data, filter_context=filter_context)
for op, path in self.paths:
_matches = path.finditer(data, filter_context=filter_context)
if op == self.env.union_token:
matches = itertools.chain(matches, _matches)
else:
assert op == self.env.intersection_token
_objs = [match.obj for match in _matches]
matches = (match for match in matches if match.obj in _objs)
return matches
def match(
self, data: JSONData, *, filter_context: Optional[FilterContextVars] = None
) -> Union[JSONPathMatch, None]:
"""Return a `JSONPathMatch` instance for the first object found in _data_.
`None` is returned if there are no matches.
Arguments:
data: A JSON document or Python object implementing the `Sequence`
or `Mapping` interfaces.
filter_context: Arbitrary data made available to filters using
the _filter context_ selector.
Returns:
A `JSONPathMatch` object for the first match, or `None` if there were
no matches.
Raises:
JSONPathSyntaxError: If the path is invalid.
JSONPathTypeError: If a filter expression attempts to use types in
an incompatible way.
"""
try:
return next(iter(self.finditer(data, filter_context=filter_context)))
except StopIteration:
return None
async def findall_async(
self, data: JSONData, *, filter_context: Optional[FilterContextVars] = None
) -> List[object]:
"""An async version of `findall()`."""
objs = await self.path.findall_async(data, filter_context=filter_context)
for op, path in self.paths:
_objs = await path.findall_async(data, filter_context=filter_context)
if op == self.env.union_token:
objs.extend(_objs)
else:
assert op == self.env.intersection_token
objs = [obj for obj in objs if obj in _objs]
return objs
async def finditer_async(
self, data: JSONData, *, filter_context: Optional[FilterContextVars] = None
) -> AsyncIterable[JSONPathMatch]:
"""An async version of `finditer()`."""
matches = await self.path.finditer_async(data, filter_context=filter_context)
for op, path in self.paths:
_matches = await path.finditer_async(data, filter_context=filter_context)
if op == self.env.union_token:
matches = _achain(matches, _matches)
else:
assert op == self.env.intersection_token
_objs = [match.obj async for match in _matches]
matches = (match async for match in matches if match.obj in _objs)
return matches
def query(
self, data: JSONData, *, filter_context: Optional[FilterContextVars] = None
) -> Query:
"""Return a `Query` iterator over matches found by applying this path to _data_.
Arguments:
data: A JSON document or Python object implementing the `Sequence`
or `Mapping` interfaces.
filter_context: Arbitrary data made available to filters using
the _filter context_ selector.
Returns:
A query iterator.
Raises:
JSONPathSyntaxError: If the path is invalid.
JSONPathTypeError: If a filter expression attempts to use types in
an incompatible way.
"""
return Query(self.finditer(data, filter_context=filter_context), self.env)
def union(self, path: JSONPath) -> CompoundJSONPath:
"""Union of this path and another path."""
return self.__class__(
env=self.env,
path=self.path,
paths=self.paths + ((self.env.union_token, path),),
)
def intersection(self, path: JSONPath) -> CompoundJSONPath:
"""Intersection of this path and another path."""
return self.__class__(
env=self.env,
path=self.path,
paths=self.paths + ((self.env.intersection_token, path),),
)
T = TypeVar("T")
async def _achain(*iterables: AsyncIterable[T]) -> AsyncIterable[T]:
for it in iterables:
async for element in it:
yield element
|
