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
|
"""Test cases for the fluent API."""
import pytest
from jsonpath import JSONPathMatch
from jsonpath import JSONPointer
from jsonpath import compile # noqa: A004
from jsonpath import query
def test_iter_query() -> None:
"""Test that `query` result is iterable, just like `finditer`."""
it = query("$.some.*", {"some": [0, 1, 2, 3]})
for i, match in enumerate(it):
assert match.value == i
assert [m.obj for m in query("$.some.*", {"some": [0, 1, 2, 3]})] == [0, 1, 2, 3]
def test_query_values() -> None:
"""Test that we can get an iterable of values from a query."""
it = query("$.some.*", {"some": [0, 1, 2, 3]}).values()
assert list(it) == [0, 1, 2, 3]
def test_query_locations() -> None:
"""Test that we can get an iterable of paths from a query."""
it = query("$.some.*", {"some": [0, 1, 2, 3]}).locations()
assert list(it) == [
"$['some'][0]",
"$['some'][1]",
"$['some'][2]",
"$['some'][3]",
]
def test_query_items() -> None:
"""Test that we can get an iterable of values and paths from a query."""
it = query("$.some.*", {"some": [0, 1, 2, 3]}).items()
assert list(it) == [
("$['some'][0]", 0),
("$['some'][1]", 1),
("$['some'][2]", 2),
("$['some'][3]", 3),
]
def test_query_skip() -> None:
"""Test that we can skip matches from the start of a query iterable."""
it = query("$.some.*", {"some": [0, 1, 2, 3]}).skip(2)
matches = list(it)
assert len(matches) == 2 # noqa: PLR2004
assert [m.obj for m in matches] == [2, 3]
def test_query_skip_zero() -> None:
"""Test that we can skip zero matches from the start of a query iterable."""
it = query("$.some.*", {"some": [0, 1, 2, 3]}).skip(0)
matches = list(it)
assert len(matches) == 4 # noqa: PLR2004
assert [m.obj for m in matches] == [0, 1, 2, 3]
def test_query_skip_negative() -> None:
"""Test that we get an exception when skipping a negative value."""
with pytest.raises(ValueError, match="can't drop a negative number of matches"):
query("$.some.*", {"some": [0, 1, 2, 3]}).skip(-1)
def test_query_skip_all() -> None:
"""Test that we can skip all matches from the start of a query iterable."""
it = query("$.some.*", {"some": [0, 1, 2, 3]}).skip(4)
matches = list(it)
assert len(matches) == 0 # noqa: PLR2004
assert [m.obj for m in matches] == []
def test_query_skip_more() -> None:
"""Test that we can skip more results than there are matches."""
it = query("$.some.*", {"some": [0, 1, 2, 3]}).skip(5)
matches = list(it)
assert len(matches) == 0 # noqa: PLR2004
assert [m.obj for m in matches] == []
def test_query_drop() -> None:
"""Test that we can skip matches with `drop`."""
it = query("$.some.*", {"some": [0, 1, 2, 3]}).drop(2)
matches = list(it)
assert len(matches) == 2 # noqa: PLR2004
assert [m.obj for m in matches] == [2, 3]
def test_query_limit() -> None:
"""Test that we can limit the number of matches."""
it = query("$.some.*", {"some": [0, 1, 2, 3]}).limit(2)
matches = list(it)
assert len(matches) == 2 # noqa: PLR2004
assert [m.obj for m in matches] == [0, 1]
def test_query_limit_zero() -> None:
"""Test that we can call limit with zero."""
it = query("$.some.*", {"some": [0, 1, 2, 3]}).limit(0)
matches = list(it)
assert len(matches) == 0 # noqa: PLR2004
assert [m.obj for m in matches] == []
def test_query_limit_more() -> None:
"""Test that we can give limit a number greater than the number of matches."""
it = query("$.some.*", {"some": [0, 1, 2, 3]}).limit(5)
matches = list(it)
assert len(matches) == 4 # noqa: PLR2004
assert [m.obj for m in matches] == [0, 1, 2, 3]
def test_query_limit_all() -> None:
"""Test limit is number of matches."""
it = query("$.some.*", {"some": [0, 1, 2, 3]}).limit(4)
matches = list(it)
assert len(matches) == 4 # noqa: PLR2004
assert [m.obj for m in matches] == [0, 1, 2, 3]
def test_query_limit_negative() -> None:
"""Test that we get an exception if limit is negative."""
with pytest.raises(ValueError, match="can't limit by a negative number of matches"):
query("$.some.*", {"some": [0, 1, 2, 3]}).limit(-1)
def test_query_head() -> None:
"""Test that we can limit the number of matches with `head`."""
it = query("$.some.*", {"some": [0, 1, 2, 3]}).head(2)
matches = list(it)
assert len(matches) == 2 # noqa: PLR2004
assert [m.obj for m in matches] == [0, 1]
def test_query_first() -> None:
"""Test that we can limit the number of matches with `first`."""
it = query("$.some.*", {"some": [0, 1, 2, 3]}).first(2)
matches = list(it)
assert len(matches) == 2 # noqa: PLR2004
assert [m.obj for m in matches] == [0, 1]
def test_query_tail() -> None:
"""Test that we can get the last _n_ matches."""
it = query("$.some.*", {"some": [0, 1, 2, 3]}).tail(2)
matches = list(it)
assert len(matches) == 2 # noqa: PLR2004
assert [m.obj for m in matches] == [2, 3]
def test_query_tail_zero() -> None:
"""Test that we can call `tail` with zero."""
it = query("$.some.*", {"some": [0, 1, 2, 3]}).tail(0)
matches = list(it)
assert len(matches) == 0 # noqa: PLR2004
assert [m.obj for m in matches] == []
def test_query_tail_all() -> None:
"""Test tail is the same as the number of matches."""
it = query("$.some.*", {"some": [0, 1, 2, 3]}).tail(4)
matches = list(it)
assert len(matches) == 4 # noqa: PLR2004
assert [m.obj for m in matches] == [0, 1, 2, 3]
def test_query_tail_more() -> None:
"""Test tail is more than the number of matches."""
it = query("$.some.*", {"some": [0, 1, 2, 3]}).tail(5)
matches = list(it)
assert len(matches) == 4 # noqa: PLR2004
assert [m.obj for m in matches] == [0, 1, 2, 3]
def test_query_tail_negative() -> None:
"""Test that we get an exception if tail is given a negative integer."""
with pytest.raises(ValueError, match="can't select a negative number of matches"):
query("$.some.*", {"some": [0, 1, 2, 3]}).tail(-1)
def test_query_last() -> None:
"""Test that we can get the last _n_ matches with `last`."""
it = query("$.some.*", {"some": [0, 1, 2, 3]}).last(2)
matches = list(it)
assert len(matches) == 2 # noqa: PLR2004
assert [m.obj for m in matches] == [2, 3]
def test_query_first_one() -> None:
"""Test that we can get the first match from a query iterator."""
maybe_match = query("$.some.*", {"some": [0, 1, 2, 3]}).first_one()
assert isinstance(maybe_match, JSONPathMatch)
assert maybe_match.value == 0
def test_query_first_one_of_empty_iterator() -> None:
"""Test that `first_one` returns `None` if the iterator is empty."""
maybe_match = query("$.nosuchthing.*", {"some": [0, 1, 2, 3]}).first_one()
assert maybe_match is None
def test_query_one() -> None:
"""Test that we can get the first match from a query iterator with `one`."""
maybe_match = query("$.some.*", {"some": [0, 1, 2, 3]}).one()
assert isinstance(maybe_match, JSONPathMatch)
assert maybe_match.value == 0
def test_query_last_one() -> None:
"""Test that we can get the last match from a query iterator."""
maybe_match = query("$.some.*", {"some": [0, 1, 2, 3]}).last_one()
assert isinstance(maybe_match, JSONPathMatch)
assert maybe_match.value == 3 # noqa: PLR2004
def test_query_last_of_empty_iterator() -> None:
"""Test that `last_one` returns `None` if the iterator is empty."""
maybe_match = query("$.nosuchthing.*", {"some": [0, 1, 2, 3]}).last_one()
assert maybe_match is None
def test_query_tee() -> None:
"""Test that we can tee a query iterator."""
it1, it2 = query("$.some.*", {"some": [0, 1, 2, 3]}).tee()
rv1 = it1.skip(1).one()
assert rv1 is not None
assert rv1.value == 1
rv2 = it2.skip(2).one()
assert rv2 is not None
assert rv2.value == 2 # noqa: PLR2004
def test_query_pointers() -> None:
"""Test that we can get pointers from a query."""
pointers = list(query("$.some.*", {"some": [0, 1, 2, 3]}).pointers())
assert len(pointers) == 4 # noqa: PLR2004
assert pointers[0] == JSONPointer("/some/0")
def test_query_take() -> None:
"""Test that we can take matches from a query iterable."""
it = query("$.some.*", {"some": [0, 1, 2, 3]})
head = list(it.take(2).values())
assert len(head) == 2 # noqa: PLR2004
assert head == [0, 1]
assert list(it.values()) == [2, 3]
def test_query_take_all() -> None:
"""Test that we can take all matches from a query iterable."""
it = query("$.some.*", {"some": [0, 1, 2, 3]})
head = list(it.take(4).values())
assert len(head) == 4 # noqa: PLR2004
assert head == [0, 1, 2, 3]
assert list(it.values()) == []
def test_query_take_more() -> None:
"""Test that we can take more matches than there are nodes."""
it = query("$.some.*", {"some": [0, 1, 2, 3]})
head = list(it.take(5).values())
assert len(head) == 4 # noqa: PLR2004
assert head == [0, 1, 2, 3]
assert list(it.values()) == []
def test_query_from_compiled_path() -> None:
"""Test that we can get a query iterator from a compiled path."""
path = compile("$.some.*")
it = path.query({"some": [0, 1, 2, 3]}).values()
assert list(it) == [0, 1, 2, 3]
def test_query_from_compiled_compound_path() -> None:
"""Test that we can get a query iterator from a compiled path."""
path = compile("$.some[0] | $.some[2]")
it = path.query({"some": [0, 1, 2, 3]}).values()
assert list(it) == [0, 2]
|
