summaryrefslogtreecommitdiff
path: root/docs/library/json.rst
diff options
context:
space:
mode:
authorDavePutz <dwputz@gmail.com>2021-02-08 10:39:26 -0600
committerGitHub <noreply@github.com>2021-02-08 10:39:26 -0600
commitcec921f3747beccff10c2d2dfbc237c305083f62 (patch)
tree4fb9ed7d2dc50123b1d858a86f3556b4784405fa /docs/library/json.rst
parent6043fdf94085bf2ec00e9f95149a74fb7eb0c7c4 (diff)
parent482e58307756bfec3cb7d4c0c8d73ffae0ec228d (diff)
Merge pull request #40 from adafruit/main
Update from adafruit main
Diffstat (limited to 'docs/library/json.rst')
-rw-r--r--docs/library/json.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/library/json.rst b/docs/library/json.rst
new file mode 100644
index 000000000..21574e556
--- /dev/null
+++ b/docs/library/json.rst
@@ -0,0 +1,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.