/
test_schemapi.py
393 lines (301 loc) · 10.5 KB
/
test_schemapi.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
# The contents of this file are automatically written by
# tools/generate_schema_wrapper.py. Do not modify directly.
import copy
import io
import json
import jsonschema
import pickle
import pytest
import numpy as np
from altair import load_schema
from altair.utils.schemapi import (
UndefinedType,
SchemaBase,
Undefined,
_FromDict,
SchemaValidationError,
)
_JSONSCHEMA_DRAFT = load_schema()["$schema"]
# Make tests inherit from _TestSchema, so that when we test from_dict it won't
# try to use SchemaBase objects defined elsewhere as wrappers.
class _TestSchema(SchemaBase):
@classmethod
def _default_wrapper_classes(cls):
return _TestSchema.__subclasses__()
class MySchema(_TestSchema):
_schema = {
"$schema": _JSONSCHEMA_DRAFT,
"definitions": {
"StringMapping": {
"type": "object",
"additionalProperties": {"type": "string"},
},
"StringArray": {"type": "array", "items": {"type": "string"}},
},
"properties": {
"a": {"$ref": "#/definitions/StringMapping"},
"a2": {"type": "object", "additionalProperties": {"type": "number"}},
"b": {"$ref": "#/definitions/StringArray"},
"b2": {"type": "array", "items": {"type": "number"}},
"c": {"type": ["string", "number"]},
"d": {
"anyOf": [
{"$ref": "#/definitions/StringMapping"},
{"$ref": "#/definitions/StringArray"},
]
},
"e": {"items": [{"type": "string"}, {"type": "string"}]},
},
}
class StringMapping(_TestSchema):
_schema = {"$ref": "#/definitions/StringMapping"}
_rootschema = MySchema._schema
class StringArray(_TestSchema):
_schema = {"$ref": "#/definitions/StringArray"}
_rootschema = MySchema._schema
class Derived(_TestSchema):
_schema = {
"$schema": _JSONSCHEMA_DRAFT,
"definitions": {
"Foo": {"type": "object", "properties": {"d": {"type": "string"}}},
"Bar": {"type": "string", "enum": ["A", "B"]},
},
"type": "object",
"additionalProperties": False,
"properties": {
"a": {"type": "integer"},
"b": {"type": "string"},
"c": {"$ref": "#/definitions/Foo"},
},
}
class Foo(_TestSchema):
_schema = {"$ref": "#/definitions/Foo"}
_rootschema = Derived._schema
class Bar(_TestSchema):
_schema = {"$ref": "#/definitions/Bar"}
_rootschema = Derived._schema
class SimpleUnion(_TestSchema):
_schema = {
"$schema": _JSONSCHEMA_DRAFT,
"anyOf": [{"type": "integer"}, {"type": "string"}],
}
class DefinitionUnion(_TestSchema):
_schema = {"anyOf": [{"$ref": "#/definitions/Foo"}, {"$ref": "#/definitions/Bar"}]}
_rootschema = Derived._schema
class SimpleArray(_TestSchema):
_schema = {
"$schema": _JSONSCHEMA_DRAFT,
"type": "array",
"items": {"anyOf": [{"type": "integer"}, {"type": "string"}]},
}
class InvalidProperties(_TestSchema):
_schema = {
"$schema": _JSONSCHEMA_DRAFT,
"type": "object",
"properties": {"for": {}, "as": {}, "vega-lite": {}, "$schema": {}},
}
class Draft7Schema(_TestSchema):
_schema = {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"e": {"items": [{"type": "string"}, {"type": "string"}]},
},
}
class Draft202012Schema(_TestSchema):
_schema = {
"$schema": "http://json-schema.org/draft/2020-12/schema#",
"properties": {
"e": {"items": [{"type": "string"}, {"type": "string"}]},
},
}
def test_construct_multifaceted_schema():
dct = {
"a": {"foo": "bar"},
"a2": {"foo": 42},
"b": ["a", "b", "c"],
"b2": [1, 2, 3],
"c": 42,
"d": ["x", "y", "z"],
"e": ["a", "b"],
}
myschema = MySchema.from_dict(dct)
assert myschema.to_dict() == dct
myschema2 = MySchema(**dct)
assert myschema2.to_dict() == dct
assert isinstance(myschema.a, StringMapping)
assert isinstance(myschema.a2, dict)
assert isinstance(myschema.b, StringArray)
assert isinstance(myschema.b2, list)
assert isinstance(myschema.d, StringArray)
def test_schema_cases():
assert Derived(a=4, b="yo").to_dict() == {"a": 4, "b": "yo"}
assert Derived(a=4, c={"d": "hey"}).to_dict() == {"a": 4, "c": {"d": "hey"}}
assert Derived(a=4, b="5", c=Foo(d="val")).to_dict() == {
"a": 4,
"b": "5",
"c": {"d": "val"},
}
assert Foo(d="hello", f=4).to_dict() == {"d": "hello", "f": 4}
assert Derived().to_dict() == {}
assert Foo().to_dict() == {}
with pytest.raises(jsonschema.ValidationError):
# a needs to be an integer
Derived(a="yo").to_dict()
with pytest.raises(jsonschema.ValidationError):
# Foo.d needs to be a string
Derived(c=Foo(4)).to_dict()
with pytest.raises(jsonschema.ValidationError):
# no additional properties allowed
Derived(foo="bar").to_dict()
def test_round_trip():
D = {"a": 4, "b": "yo"}
assert Derived.from_dict(D).to_dict() == D
D = {"a": 4, "c": {"d": "hey"}}
assert Derived.from_dict(D).to_dict() == D
D = {"a": 4, "b": "5", "c": {"d": "val"}}
assert Derived.from_dict(D).to_dict() == D
D = {"d": "hello", "f": 4}
assert Foo.from_dict(D).to_dict() == D
def test_from_dict():
D = {"a": 4, "b": "5", "c": {"d": "val"}}
obj = Derived.from_dict(D)
assert obj.a == 4
assert obj.b == "5"
assert isinstance(obj.c, Foo)
def test_simple_type():
assert SimpleUnion(4).to_dict() == 4
def test_simple_array():
assert SimpleArray([4, 5, "six"]).to_dict() == [4, 5, "six"]
assert SimpleArray.from_dict(list("abc")).to_dict() == list("abc")
def test_definition_union():
obj = DefinitionUnion.from_dict("A")
assert isinstance(obj, Bar)
assert obj.to_dict() == "A"
obj = DefinitionUnion.from_dict("B")
assert isinstance(obj, Bar)
assert obj.to_dict() == "B"
obj = DefinitionUnion.from_dict({"d": "yo"})
assert isinstance(obj, Foo)
assert obj.to_dict() == {"d": "yo"}
def test_invalid_properties():
dct = {"for": 2, "as": 3, "vega-lite": 4, "$schema": 5}
invalid = InvalidProperties.from_dict(dct)
assert invalid["for"] == 2
assert invalid["as"] == 3
assert invalid["vega-lite"] == 4
assert invalid["$schema"] == 5
assert invalid.to_dict() == dct
def test_undefined_singleton():
assert Undefined is UndefinedType()
def test_schema_validator_selection():
# Tests if the correct validator class is chosen based on the $schema
# property in the schema. Reason for the AttributeError below is, that Draft 2020-12
# introduced changes to the "items" keyword, see
# https://json-schema.org/draft/2020-12/release-notes.html#changes-to-
# items-and-additionalitems
dct = {
"e": ["a", "b"],
}
assert Draft7Schema.from_dict(dct).to_dict() == dct
with pytest.raises(AttributeError, match="'list' object has no attribute 'get'"):
Draft202012Schema.from_dict(dct)
@pytest.fixture
def dct():
return {
"a": {"foo": "bar"},
"a2": {"foo": 42},
"b": ["a", "b", "c"],
"b2": [1, 2, 3],
"c": 42,
"d": ["x", "y", "z"],
}
def test_copy_method(dct):
myschema = MySchema.from_dict(dct)
# Make sure copy is deep
copy = myschema.copy(deep=True)
copy["a"]["foo"] = "new value"
copy["b"] = ["A", "B", "C"]
copy["c"] = 164
assert myschema.to_dict() == dct
# If we ignore a value, changing the copy changes the original
copy = myschema.copy(deep=True, ignore=["a"])
copy["a"]["foo"] = "new value"
copy["b"] = ["A", "B", "C"]
copy["c"] = 164
mydct = myschema.to_dict()
assert mydct["a"]["foo"] == "new value"
assert mydct["b"][0] == dct["b"][0]
assert mydct["c"] == dct["c"]
# If copy is not deep, then changing copy below top level changes original
copy = myschema.copy(deep=False)
copy["a"]["foo"] = "baz"
copy["b"] = ["A", "B", "C"]
copy["c"] = 164
mydct = myschema.to_dict()
assert mydct["a"]["foo"] == "baz"
assert mydct["b"] == dct["b"]
assert mydct["c"] == dct["c"]
def test_copy_module(dct):
myschema = MySchema.from_dict(dct)
cp = copy.deepcopy(myschema)
cp["a"]["foo"] = "new value"
cp["b"] = ["A", "B", "C"]
cp["c"] = 164
assert myschema.to_dict() == dct
def test_attribute_error():
m = MySchema()
with pytest.raises(AttributeError) as err:
m.invalid_attribute
assert str(err.value) == (
"'MySchema' object has no attribute " "'invalid_attribute'"
)
def test_to_from_json(dct):
json_str = MySchema.from_dict(dct).to_json()
new_dct = MySchema.from_json(json_str).to_dict()
assert new_dct == dct
def test_to_from_pickle(dct):
myschema = MySchema.from_dict(dct)
output = io.BytesIO()
pickle.dump(myschema, output)
output.seek(0)
myschema_new = pickle.load(output)
assert myschema_new.to_dict() == dct
def test_class_with_no_schema():
class BadSchema(SchemaBase):
pass
with pytest.raises(ValueError) as err:
BadSchema(4)
assert str(err.value).startswith("Cannot instantiate object")
@pytest.mark.parametrize("use_json", [True, False])
def test_hash_schema(use_json):
classes = _TestSchema._default_wrapper_classes()
for cls in classes:
hsh1 = _FromDict.hash_schema(cls._schema, use_json=use_json)
hsh2 = _FromDict.hash_schema(cls._schema, use_json=use_json)
assert hsh1 == hsh2
assert hash(hsh1) == hash(hsh2)
def test_schema_validation_error():
try:
MySchema(a={"foo": 4})
the_err = None
except jsonschema.ValidationError as err:
the_err = err
assert isinstance(the_err, SchemaValidationError)
message = str(the_err)
assert message.startswith("Invalid specification")
assert "test_schemapi.MySchema->a" in message
assert "validating {!r}".format(the_err.validator) in message
assert the_err.message in message
def test_serialize_numpy_types():
m = MySchema(
a={"date": np.datetime64("2019-01-01")},
a2={"int64": np.int64(1), "float64": np.float64(2)},
b2=np.arange(4),
)
out = m.to_json()
dct = json.loads(out)
assert dct == {
"a": {"date": "2019-01-01T00:00:00"},
"a2": {"int64": 1, "float64": 2},
"b2": [0, 1, 2, 3],
}