summaryrefslogtreecommitdiff
path: root/docs/library/json.rst
blob: 21574e556b5cabbd4886062d890b55bc059b9c09 (plain)
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
:mod:`json` -- JSON encoding and decoding
==========================================

.. module:: json
   :synopsis: JSON encoding and decoding

|see_cpython_module| :mod:`cpython:json`.

This modules allows to convert between Python objects and the JSON
data format.

Functions
---------

.. function:: dump(obj, stream)

   Serialise ``obj`` to a JSON string, writing it to the given *stream*.

.. function:: dumps(obj)

   Return ``obj`` represented as a JSON string.

.. function:: load(stream)

   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.

.. function:: loads(str)

   Parse the JSON *str* and return an object.  Raises :exc:`ValueError` if the
   string is not correctly formed.