-
Notifications
You must be signed in to change notification settings - Fork 85
/
ak_from_json_schema.py
396 lines (334 loc) · 14.2 KB
/
ak_from_json_schema.py
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
# BSD 3-Clause License; see https://github.com/scikit-hep/awkward-1.0/blob/main/LICENSE
import json
import os
import awkward as ak
np = ak.nplike.NumpyMetadata.instance()
numpy = ak.nplike.Numpy.instance()
def from_json_schema(
source,
schema,
highlevel=True,
behavior=None,
output_initial_size=1024,
output_resize_factor=1.5,
):
"""
Args:
source (str or bytes): JSON-formatted string to convert into an array.
schema (str, bytes, or nested dicts): JSONSchema to assume in the parsing.
The JSON data are *not* validated against the schema; the schema is
only used to accelerate parsing.
highlevel (bool): If True, return an #ak.Array; otherwise, return
a low-level #ak.layout.Content subclass.
behavior (None or dict): Custom #ak.behavior for the output array, if
high-level.
output_initial_size (int): Initial size (in bytes) of output buffers, which
grow as needed to accommodate the size of the dataset.
output_resize_factor (float): Resize multiplier for output buffers, which
determines how quickly they grow; should be strictly greater than 1.
Converts a JSON string into an Awkward Array, using a JSONSchema to accelerate
the parsing of the source and building of the output. The JSON data are not
*validated* against the schema; the schema is *assumed* to be correct.
Supported JSONSchema elements:
* The root of the schema must be `"type": "array"` or `"type": "object"`.
* Every level must have a `"type"`, which can only name one type (as a string
or length-1 list) or one type and `"null"` (as a length-2 list).
* `"type": "boolean"` \u2192 1-byte boolean values.
* `"type": "integer"` \u2192 8-byte integer values.
Numbers may include a fractional part, as per the JSONSchema specification,
but this function ignores any fractional part.
* `"type": "number"` \u2192 8-byte floating-point values.
* `"type": "string"` \u2192 UTF-8 encoded strings. All JSON escape sequences are
supported. Remember that the `source` data are ASCII; Unicode is derived from
"`\\uXXXX`" escape sequences. If an `"enum"` is given, strings are represented
as categorical values (#ak.layout.IndexedArray or #ak.layout.IndexedOptionArray).
* `"type": "array"` \u2192 nested lists. The `"items"` must be specified. If
`"minItems"` and `"maxItems"` are specified and equal to each other, the
list has regular-type (#ak.types.RegularType); otherwise, it has variable-length
type (#ak.types.ListType).
* `"type": "object"` \u2192 nested records. The `"properties"` must be specified,
and any properties in the data not described by `"properties"` will not
appear in the output.
See also #ak.from_json and #ak.to_json.
"""
with ak._v2._util.OperationErrorContext(
"ak._v2.from_json_schema",
dict(
source=source,
schema=schema,
highlevel=highlevel,
behavior=behavior,
output_initial_size=output_initial_size,
output_resize_factor=output_resize_factor,
),
):
return _impl(
source,
schema,
highlevel,
behavior,
output_initial_size,
output_resize_factor,
)
def _impl(
source,
schema,
highlevel,
behavior,
output_initial_size,
output_resize_factor,
):
if not isinstance(source, bytes) and not ak._v2._util.isstr(source):
raise ak._v2._util.error(
NotImplementedError("for now, 'source' must be bytes or str")
)
if isinstance(schema, bytes) or ak._v2._util.isstr(schema):
schema = json.loads(schema)
if not isinstance(schema, dict):
raise ak._v2._util.error(
TypeError(f"malformed JSONSchema: expected dict, got {schema!r}")
)
container = {}
instructions = []
if schema.get("type") == "array":
if "items" not in schema:
raise ak._v2._util.error(
TypeError("JSONSchema type is not concrete: array without items")
)
instructions.append(["TopLevelArray"])
form = build_assembly(schema["items"], container, instructions)
elif schema.get("type") == "object":
form = build_assembly(schema, container, instructions)
else:
raise ak._v2._util.error(
TypeError(
"only 'array' and 'object' types supported at the JSONSchema root"
)
)
specializedjson = ak._ext.SpecializedJSON(
json.dumps(instructions),
output_initial_size=output_initial_size,
output_resize_factor=output_resize_factor,
)
if not specializedjson.parse_string(source):
position = specializedjson.json_position
before = source[max(0, position - 30) : position]
if isinstance(before, bytes):
before = before.decode("ascii", errors="surrogateescape")
before = before.replace(os.linesep, repr(os.linesep).strip("'\""))
if position - 30 > 0:
before = "..." + before
after = source[position : position + 30]
if isinstance(after, bytes):
after = after.decode("ascii", errors="surrogateescape")
if position + 30 < len(source):
after = after + "..."
raise ak._v2._util.error(
ValueError(
"JSON is invalid or does not fit schema at position {}:\n\n {}\n {}".format(
position, before + after, "-" * len(before) + "^"
)
)
)
for key, value in container.items():
if value is None:
container[key] = specializedjson[key]
if schema.get("type") == "array":
length = len(specializedjson)
else:
length = 1
out = ak._v2.operations.convert.from_buffers(
form, length, container, highlevel=highlevel, behavior=behavior
)
if schema.get("type") == "array":
return out
else:
return out[0]
def build_assembly(schema, container, instructions):
if not isinstance(schema, dict):
raise ak._v2._util.error(
TypeError(f"unrecognized JSONSchema: expected dict, got {schema!r}")
)
if "type" not in schema is None:
raise ak._v2._util.error(
TypeError(f"unrecognized JSONSchema: no 'type' in {schema!r}")
)
tpe = schema["type"]
is_optional = False
if isinstance(tpe, list):
if "null" in tpe:
is_optional = True
tpe = [x for x in tpe if x != "null"]
if len(tpe) == 1:
tpe = tpe[0]
if tpe in {"boolean", "integer", "number"}:
# https://json-schema.org/understanding-json-schema/reference/boolean.html
# https://json-schema.org/understanding-json-schema/reference/numeric.html
if tpe == "boolean":
instruction = "FillBoolean"
dtype = "uint8"
primitive = "bool"
elif tpe == "integer":
instruction = "FillInteger"
primitive = dtype = "int64"
elif tpe == "number":
instruction = "FillNumber"
primitive = dtype = "float64"
if is_optional:
mask = f"node{len(container)}"
container[mask + "-mask"] = None
node = f"node{len(container)}"
container[node + "-data"] = None
instructions.append(["FillByteMaskedArray", mask + "-mask", "int8"])
instructions.append([instruction, node + "-data", dtype])
return ak._v2.forms.ByteMaskedForm(
"i8",
ak._v2.forms.NumpyForm(primitive, form_key=node),
valid_when=True,
form_key=mask,
)
else:
node = f"node{len(container)}"
container[node + "-data"] = None
instructions.append([instruction, node + "-data", dtype])
return ak._v2.forms.NumpyForm(primitive, form_key=node)
elif tpe == "string":
# https://json-schema.org/understanding-json-schema/reference/string.html#string
if "enum" in schema:
strings = schema["enum"]
assert isinstance(strings, list)
assert len(strings) >= 1
assert all(ak._v2._util.isstr(x) for x in strings)
bytestrings = [x.encode("utf-8", errors="surrogateescape") for x in strings]
index = f"node{len(container)}"
container[index + "-index"] = None
offsets = f"node{len(container)}"
container[offsets + "-offsets"] = numpy.empty(len(strings) + 1, np.int64)
container[offsets + "-offsets"][0] = 0
container[offsets + "-offsets"][1:] = numpy.cumsum(
[len(x) for x in bytestrings]
)
node = f"container{len(container)}"
container[node + "-data"] = b"".join(bytestrings)
if is_optional:
instruction = "FillNullEnumString"
formtype = ak._v2.forms.IndexedOptionForm
else:
instruction = "FillEnumString"
formtype = ak._v2.forms.IndexedForm
instructions.append([instruction, index + "-index", "int64", strings])
return formtype(
"i64",
ak._v2.forms.ListOffsetForm(
"i64",
ak._v2.forms.NumpyForm(
"uint8", parameters={"__array__": "char"}, form_key=node
),
parameters={"__array__": "string"},
form_key=offsets,
),
parameters={"__array__": "categorical"},
form_key=index,
)
else:
if is_optional:
mask = f"node{container}"
container[mask + "-mask"] = None
instructions.append(["FillByteMaskedArray", mask + "-mask", "int8"])
offsets = f"node{len(container)}"
container[offsets + "-offsets"] = None
node = f"node{len(container)}"
container[node + "-data"] = None
instructions.append(
["FillString", offsets + "-offsets", "int64", node + "-data", "uint8"]
)
out = ak._v2.forms.ListOffsetForm(
"i64",
ak._v2.forms.NumpyForm(
"uint8",
parameters={"__array__": "char"},
form_key=node,
),
parameters={"__array__": "string"},
form_key=offsets,
)
if is_optional:
return ak._v2.forms.ByteMaskedForm(
"i8", out, valid_when=True, form_key=mask
)
else:
return out
elif tpe == "array":
# https://json-schema.org/understanding-json-schema/reference/array.html
if "items" not in schema:
raise ak._v2._util.error(
TypeError("JSONSchema type is not concrete: array without 'items'")
)
if schema.get("minItems") == schema.get("maxItems") != None: # noqa: E711
assert ak._v2._util.isint(schema.get("minItems"))
if is_optional:
mask = f"node{len(container)}"
container[mask + "-index"] = None
instructions.append(
["FillIndexedOptionArray", mask + "-index", "int64"]
)
instructions.append(["FixedLengthList", schema.get("minItems")])
content = build_assembly(schema["items"], container, instructions)
out = ak._v2.forms.RegularForm(content, size=schema.get("minItems"))
if is_optional:
return ak._v2.forms.IndexedOptionForm("i64", out, form_key=mask)
else:
return out
else:
if is_optional:
mask = f"node{len(container)}"
container[mask + "-mask"] = None
instructions.append(["FillByteMaskedArray", mask + "-mask", "int8"])
offsets = f"node{len(container)}"
container[offsets + "-offsets"] = None
instructions.append(["VarLengthList", offsets + "-offsets", "int64"])
content = build_assembly(schema["items"], container, instructions)
out = ak._v2.forms.ListOffsetForm("i64", content, form_key=offsets)
if is_optional:
return ak._v2.forms.ByteMaskedForm(
"i8", out, valid_when=True, form_key=mask
)
else:
return out
elif tpe == "object":
# https://json-schema.org/understanding-json-schema/reference/object.html
if "properties" not in schema:
raise ak._v2._util.error(
TypeError(
"JSONSchema type is not concrete: object without 'properties'"
)
)
names = []
subschemas = []
for name, subschema in schema["properties"].items():
names.append(name)
subschemas.append(subschema)
if is_optional:
mask = f"node{len(container)}"
container[mask + "-index"] = None
instructions.append(["FillIndexedOptionArray", mask + "-index", "int64"])
instructions.append(["KeyTableHeader", len(names)])
startkeys = len(instructions)
for name in names:
instructions.append(["KeyTableItem", name, None])
contents = []
for keyindex, subschema in enumerate(subschemas):
# set the "jump_to" instruction position in the KeyTable
instructions[startkeys + keyindex][2] = len(instructions)
contents.append(build_assembly(subschema, container, instructions))
out = ak._v2.forms.RecordForm(contents, names)
if is_optional:
return ak._v2.forms.IndexedOptionForm("i64", out, form_key=mask)
else:
return out
elif isinstance(tpe, list):
raise ak._v2._util.error(
NotImplementedError("arbitrary unions of types are not yet supported")
)
else:
raise ak._v2._util.error(TypeError(f"unrecognized JSONSchema: {tpe!r}"))