json -- JSON encoding and decoding. =================================== .. This document was autogenerated by Sphinx-autoapi from a .pyi stub or a source code file. .. Do not edit this file, instead edit the source file and run Sphinx to update. .. Source: docs/stubs/json/__init__.pyi .. py:module:: json .. autoapi-nested-parse:: JSON encoding and decoding. |see_cpython_module| :mod:`python:json`. This modules allows to convert between Python objects and the JSON data format. Functions --------- .. autoapisummary:: json.dump json.dumps json.load json.loads Module Contents --------------- .. py:function:: dump(obj, stream, separators=None) -> _typeshed.Incomplete Serialise *obj* to a JSON string, writing it to the given *stream*. If specified, separators should be an ``(item_separator, key_separator)`` tuple. The default is ``(', ', ': ')``. To get the most compact JSON representation, you should specify ``(',', ':')`` to eliminate whitespace. .. py:function:: dumps(obj, separators=None) -> str Return *obj* represented as a JSON string. The arguments have the same meaning as in `dump`. .. py:function:: load(stream) -> _typeshed.Incomplete Parse the given *stream*, interpreting it as a JSON string and deserialising the data to a Python object. The resulting object is returned. Parsing continues until end-of-file is encountered. A :exc:`ValueError` is raised if the data in *stream* is not correctly formed. .. py:function:: loads(str) -> _typeshed.Incomplete Parse the JSON *str* and return an object. Raises :exc:`ValueError` if the string is not correctly formed.