jsonyx.load

jsonyx.load(fp, *, allow=NOTHING, cache_keys=False, hooks=None, root='.')

Deserialize an open JSON file to a Python object.

Changed in version 2.0: Replaced use_decimal with hooks.

Changed in version 2.2: Added cache_keys (default False instead of True).

Parameters:

• fp (Reader[bytes | str]) – an open JSON file

• allow (Container[str], default: NOTHING) – the JSON deviations from jsonyx.allow

• cache_keys (bool, default: False) – re-use the keys of objects

• hooks (dict[str, _Hook] | None, default: None) – the hooks used for transforming data

• root (_StrPath, default: ".") – the path to the archive containing this JSON file

Raises:

• RecursionError – if the JSON file is too deeply nested

• TruncatedSyntaxError – when failing to decode the file

• ValueError – if a number is too big

Returns:

Any – a Python object

Example:

>>> import jsonyx as json
>>> from io import StringIO
>>> io = StringIO('["reader protocol"]')
>>> json.load(io)
['reader protocol']

Tip

• Specify root to display the zip filename in error messages.

• Use jsonyx.Decoder directly for better performance.

Note

• The input is not read incrementally, but in one-shot.

• The encoding is detected using jsonyx.detect_encoding().

See also

• jsonyx.read() for deserializing from a file.

• jsonyx.loads() for deserializing from a string.

• jsonyx.dump() for serializing to an open file.