| """Utilities to manipulate JSON objects.""" |
|
|
| |
| |
|
|
| import math |
| import numbers |
| import re |
| import types |
| from binascii import b2a_base64 |
| from datetime import date, datetime |
|
|
| from jupyter_client._version import version_info as jupyter_client_version |
|
|
| next_attr_name = "__next__" |
|
|
| |
| |
| |
|
|
| |
| ISO8601 = "%Y-%m-%dT%H:%M:%S.%f" |
| ISO8601_PAT = re.compile( |
| r"^(\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2})(\.\d{1,6})?Z?([\+\-]\d{2}:?\d{2})?$" |
| ) |
|
|
| |
| |
| datetime.strptime("2000-01-01", "%Y-%m-%d") |
|
|
| |
| |
| |
|
|
|
|
| |
| PNG = b"\x89PNG\r\n\x1a\n" |
| |
| PNG64 = b"iVBORw0KG" |
| JPEG = b"\xff\xd8" |
| |
| JPEG64 = b"/9" |
| |
| GIF_64 = b"R0lGODdh" |
| GIF89_64 = b"R0lGODlh" |
| |
| PDF64 = b"JVBER" |
|
|
| JUPYTER_CLIENT_MAJOR_VERSION = jupyter_client_version[0] |
|
|
|
|
| def encode_images(format_dict): |
| """b64-encodes images in a displaypub format dict |
| |
| Perhaps this should be handled in json_clean itself? |
| |
| Parameters |
| ---------- |
| format_dict : dict |
| A dictionary of display data keyed by mime-type |
| |
| Returns |
| ------- |
| format_dict : dict |
| A copy of the same dictionary, |
| but binary image data ('image/png', 'image/jpeg' or 'application/pdf') |
| is base64-encoded. |
| |
| """ |
|
|
| |
| |
| |
| return format_dict |
|
|
|
|
| def json_clean(obj): |
| """Deprecated, this is a no-op for jupyter-client>=7. |
| |
| Clean an object to ensure it's safe to encode in JSON. |
| |
| Atomic, immutable objects are returned unmodified. Sets and tuples are |
| converted to lists, lists are copied and dicts are also copied. |
| |
| Note: dicts whose keys could cause collisions upon encoding (such as a dict |
| with both the number 1 and the string '1' as keys) will cause a ValueError |
| to be raised. |
| |
| Parameters |
| ---------- |
| obj : any python object |
| |
| Returns |
| ------- |
| out : object |
| A version of the input which will not cause an encoding error when |
| encoded as JSON. Note that this function does not *encode* its inputs, |
| it simply sanitizes it so that there will be no encoding errors later. |
| |
| """ |
| if int(JUPYTER_CLIENT_MAJOR_VERSION) >= 7: |
| return obj |
|
|
| |
| atomic_ok = (str, type(None)) |
|
|
| |
| container_to_list = (tuple, set, types.GeneratorType) |
|
|
| |
| |
|
|
| if isinstance(obj, bool): |
| return obj |
|
|
| if isinstance(obj, numbers.Integral): |
| |
| return int(obj) |
|
|
| if isinstance(obj, numbers.Real): |
| |
| if math.isnan(obj) or math.isinf(obj): |
| return repr(obj) |
| return float(obj) |
|
|
| if isinstance(obj, atomic_ok): |
| return obj |
|
|
| if isinstance(obj, bytes): |
| |
| |
| return b2a_base64(obj).decode("ascii") |
|
|
| if isinstance(obj, container_to_list) or ( |
| hasattr(obj, "__iter__") and hasattr(obj, next_attr_name) |
| ): |
| obj = list(obj) |
|
|
| if isinstance(obj, list): |
| return [json_clean(x) for x in obj] |
|
|
| if isinstance(obj, dict): |
| |
| |
| |
| nkeys = len(obj) |
| nkeys_collapsed = len(set(map(str, obj))) |
| if nkeys != nkeys_collapsed: |
| msg = ( |
| "dict cannot be safely converted to JSON: " |
| "key collision would lead to dropped values" |
| ) |
| raise ValueError(msg) |
| |
| out = {} |
| for k, v in obj.items(): |
| out[str(k)] = json_clean(v) |
| return out |
| if isinstance(obj, datetime | date): |
| return obj.strftime(ISO8601) |
|
|
| |
| raise ValueError("Can't clean for JSON: %r" % obj) |
|
|