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
|
"""Test suite for our JSON utilities."""
# Copyright (c) IPython Development Team.
# Distributed under the terms of the Modified BSD License.
import json
import numbers
from binascii import a2b_base64
from datetime import date, datetime
import pytest
from jupyter_client._version import version_info as jupyter_client_version
from ipykernel import jsonutil
from ipykernel.jsonutil import encode_images, json_clean
JUPYTER_CLIENT_MAJOR_VERSION: int = jupyter_client_version[0] # type:ignore
class MyInt:
def __int__(self):
return 389
numbers.Integral.register(MyInt)
class MyFloat:
def __float__(self):
return 3.14
numbers.Real.register(MyFloat)
@pytest.mark.skipif(JUPYTER_CLIENT_MAJOR_VERSION >= 7, reason="json_clean is a no-op")
def test():
# list of input/expected output. Use None for the expected output if it
# can be the same as the input.
pairs = [
(1, None), # start with scalars
(1.0, None),
("a", None),
(True, None),
(False, None),
(None, None),
# Containers
([1, 2], None),
((1, 2), [1, 2]),
({1, 2}, [1, 2]),
(dict(x=1), None),
({"x": 1, "y": [1, 2, 3], "1": "int"}, None),
# More exotic objects
((x for x in range(3)), [0, 1, 2]),
(iter([1, 2]), [1, 2]),
(datetime(1991, 7, 3, 12, 00), "1991-07-03T12:00:00.000000"),
(date(1991, 7, 3), "1991-07-03T00:00:00.000000"),
(MyFloat(), 3.14),
(MyInt(), 389),
]
for val, jval in pairs:
if jval is None:
jval = val # type:ignore
out = json_clean(val)
# validate our cleanup
assert out == jval
# and ensure that what we return, indeed encodes cleanly
json.loads(json.dumps(out))
@pytest.mark.skipif(JUPYTER_CLIENT_MAJOR_VERSION >= 7, reason="json_clean is a no-op")
def test_encode_images():
# invalid data, but the header and footer are from real files
pngdata = b"\x89PNG\r\n\x1a\nblahblahnotactuallyvalidIEND\xaeB`\x82"
jpegdata = b"\xff\xd8\xff\xe0\x00\x10JFIFblahblahjpeg(\xa0\x0f\xff\xd9"
pdfdata = b"%PDF-1.\ntrailer<</Root<</Pages<</Kids[<</MediaBox[0 0 3 3]>>]>>>>>>"
bindata = b"\xff\xff\xff\xff"
fmt = {
"image/png": pngdata,
"image/jpeg": jpegdata,
"application/pdf": pdfdata,
"application/unrecognized": bindata,
}
encoded = json_clean(encode_images(fmt))
for key, value in fmt.items():
# encoded has unicode, want bytes
decoded = a2b_base64(encoded[key])
assert decoded == value
encoded2 = json_clean(encode_images(encoded))
assert encoded == encoded2
for key, value in fmt.items():
decoded = a2b_base64(encoded[key])
assert decoded == value
@pytest.mark.skipif(JUPYTER_CLIENT_MAJOR_VERSION >= 7, reason="json_clean is a no-op")
def test_lambda():
with pytest.raises(ValueError): # noqa: PT011
json_clean(lambda: 1)
@pytest.mark.skipif(JUPYTER_CLIENT_MAJOR_VERSION >= 7, reason="json_clean is a no-op")
def test_exception():
bad_dicts = [
{1: "number", "1": "string"},
{True: "bool", "True": "string"},
]
for d in bad_dicts:
with pytest.raises(ValueError): # noqa: PT011
json_clean(d)
@pytest.mark.skipif(JUPYTER_CLIENT_MAJOR_VERSION >= 7, reason="json_clean is a no-op")
def test_unicode_dict():
data = {"üniço∂e": "üniço∂e"}
clean = jsonutil.json_clean(data)
assert data == clean
|