blob: 85798fa2cf723a7e4e84b7990e976ef83f6172a4 [file] [log] [blame]
Christian Heimes90540002008-05-08 14:29:10 +00001:mod:`json` --- JSON encoder and decoder
2========================================
3
4.. module:: json
5 :synopsis: Encode and decode the JSON format.
Terry Jan Reedyfa089b92016-06-11 15:02:54 -04006
Christian Heimes90540002008-05-08 14:29:10 +00007.. moduleauthor:: Bob Ippolito <bob@redivi.com>
8.. sectionauthor:: Bob Ippolito <bob@redivi.com>
Christian Heimes90540002008-05-08 14:29:10 +00009
Terry Jan Reedyfa089b92016-06-11 15:02:54 -040010**Source code:** :source:`Lib/json/__init__.py`
11
12--------------
13
Antoine Pitrou331624b2012-08-24 19:37:23 +020014`JSON (JavaScript Object Notation) <http://json.org>`_, specified by
Serhiy Storchaka7a6915e2014-11-27 19:41:47 +020015:rfc:`7159` (which obsoletes :rfc:`4627`) and by
16`ECMA-404 <http://www.ecma-international.org/publications/standards/Ecma-404.htm>`_,
17is a lightweight data interchange format inspired by
Georg Brandl5d941342016-02-26 19:37:12 +010018`JavaScript <https://en.wikipedia.org/wiki/JavaScript>`_ object literal syntax
Serhiy Storchaka7a6915e2014-11-27 19:41:47 +020019(although it is not a strict subset of JavaScript [#rfc-errata]_ ).
Christian Heimes90540002008-05-08 14:29:10 +000020
21:mod:`json` exposes an API familiar to users of the standard library
22:mod:`marshal` and :mod:`pickle` modules.
23
24Encoding basic Python object hierarchies::
Georg Brandl48310cd2009-01-03 21:18:54 +000025
Christian Heimes90540002008-05-08 14:29:10 +000026 >>> import json
27 >>> json.dumps(['foo', {'bar': ('baz', None, 1.0, 2)}])
28 '["foo", {"bar": ["baz", null, 1.0, 2]}]'
Neal Norwitz752abd02008-05-13 04:55:24 +000029 >>> print(json.dumps("\"foo\bar"))
Christian Heimes90540002008-05-08 14:29:10 +000030 "\"foo\bar"
Benjamin Peterson2505bc62008-05-15 02:17:58 +000031 >>> print(json.dumps('\u1234'))
Christian Heimes90540002008-05-08 14:29:10 +000032 "\u1234"
Neal Norwitz752abd02008-05-13 04:55:24 +000033 >>> print(json.dumps('\\'))
Christian Heimes90540002008-05-08 14:29:10 +000034 "\\"
Neal Norwitz752abd02008-05-13 04:55:24 +000035 >>> print(json.dumps({"c": 0, "b": 0, "a": 0}, sort_keys=True))
Christian Heimes90540002008-05-08 14:29:10 +000036 {"a": 0, "b": 0, "c": 0}
Benjamin Peterson2505bc62008-05-15 02:17:58 +000037 >>> from io import StringIO
Christian Heimes90540002008-05-08 14:29:10 +000038 >>> io = StringIO()
39 >>> json.dump(['streaming API'], io)
40 >>> io.getvalue()
41 '["streaming API"]'
42
43Compact encoding::
44
45 >>> import json
Sergey Fedoseeva7fbad92017-09-09 21:39:36 +050046 >>> json.dumps([1, 2, 3, {'4': 5, '6': 7}], separators=(',', ':'))
Christian Heimes90540002008-05-08 14:29:10 +000047 '[1,2,3,{"4":5,"6":7}]'
48
49Pretty printing::
50
51 >>> import json
Neal Norwitz752abd02008-05-13 04:55:24 +000052 >>> print(json.dumps({'4': 5, '6': 7}, sort_keys=True, indent=4))
Christian Heimes90540002008-05-08 14:29:10 +000053 {
Georg Brandl48310cd2009-01-03 21:18:54 +000054 "4": 5,
Christian Heimes90540002008-05-08 14:29:10 +000055 "6": 7
56 }
57
58Decoding JSON::
Georg Brandl48310cd2009-01-03 21:18:54 +000059
Christian Heimes90540002008-05-08 14:29:10 +000060 >>> import json
61 >>> json.loads('["foo", {"bar":["baz", null, 1.0, 2]}]')
Benjamin Peterson2505bc62008-05-15 02:17:58 +000062 ['foo', {'bar': ['baz', None, 1.0, 2]}]
Christian Heimes90540002008-05-08 14:29:10 +000063 >>> json.loads('"\\"foo\\bar"')
Benjamin Peterson2505bc62008-05-15 02:17:58 +000064 '"foo\x08ar'
65 >>> from io import StringIO
Christian Heimes90540002008-05-08 14:29:10 +000066 >>> io = StringIO('["streaming API"]')
67 >>> json.load(io)
Benjamin Peterson2505bc62008-05-15 02:17:58 +000068 ['streaming API']
Christian Heimes90540002008-05-08 14:29:10 +000069
70Specializing JSON object decoding::
71
72 >>> import json
73 >>> def as_complex(dct):
74 ... if '__complex__' in dct:
75 ... return complex(dct['real'], dct['imag'])
76 ... return dct
Benjamin Peterson2505bc62008-05-15 02:17:58 +000077 ...
Christian Heimes90540002008-05-08 14:29:10 +000078 >>> json.loads('{"__complex__": true, "real": 1, "imag": 2}',
79 ... object_hook=as_complex)
80 (1+2j)
81 >>> import decimal
82 >>> json.loads('1.1', parse_float=decimal.Decimal)
83 Decimal('1.1')
84
85Extending :class:`JSONEncoder`::
Georg Brandl48310cd2009-01-03 21:18:54 +000086
Christian Heimes90540002008-05-08 14:29:10 +000087 >>> import json
88 >>> class ComplexEncoder(json.JSONEncoder):
89 ... def default(self, obj):
90 ... if isinstance(obj, complex):
91 ... return [obj.real, obj.imag]
R David Murraydd246172013-03-17 21:52:35 -040092 ... # Let the base class default method raise the TypeError
Christian Heimes90540002008-05-08 14:29:10 +000093 ... return json.JSONEncoder.default(self, obj)
Benjamin Peterson2505bc62008-05-15 02:17:58 +000094 ...
Georg Brandl0bb73b82010-09-03 22:36:22 +000095 >>> json.dumps(2 + 1j, cls=ComplexEncoder)
Christian Heimes90540002008-05-08 14:29:10 +000096 '[2.0, 1.0]'
97 >>> ComplexEncoder().encode(2 + 1j)
98 '[2.0, 1.0]'
99 >>> list(ComplexEncoder().iterencode(2 + 1j))
Georg Brandl0bb73b82010-09-03 22:36:22 +0000100 ['[2.0', ', 1.0', ']']
Georg Brandl48310cd2009-01-03 21:18:54 +0000101
Christian Heimes90540002008-05-08 14:29:10 +0000102
Serhiy Storchaka46936d52018-04-08 19:18:04 +0300103Using :mod:`json.tool` from the shell to validate and pretty-print:
Christian Heimes90540002008-05-08 14:29:10 +0000104
Serhiy Storchaka46936d52018-04-08 19:18:04 +0300105.. code-block:: shell-session
Georg Brandl48310cd2009-01-03 21:18:54 +0000106
Georg Brandl946faa32014-10-28 22:54:24 +0100107 $ echo '{"json":"obj"}' | python -m json.tool
Christian Heimes90540002008-05-08 14:29:10 +0000108 {
109 "json": "obj"
110 }
Georg Brandl946faa32014-10-28 22:54:24 +0100111 $ echo '{1.2:3.4}' | python -m json.tool
Serhiy Storchakac510a042013-02-21 20:19:16 +0200112 Expecting property name enclosed in double quotes: line 1 column 2 (char 1)
Christian Heimes90540002008-05-08 14:29:10 +0000113
Benjamin Peterson940e2072014-03-21 23:17:29 -0500114See :ref:`json-commandline` for detailed documentation.
115
Georg Brandl48310cd2009-01-03 21:18:54 +0000116.. note::
Christian Heimes90540002008-05-08 14:29:10 +0000117
Antoine Pitrou331624b2012-08-24 19:37:23 +0200118 JSON is a subset of `YAML <http://yaml.org/>`_ 1.2. The JSON produced by
119 this module's default settings (in particular, the default *separators*
120 value) is also a subset of YAML 1.0 and 1.1. This module can thus also be
121 used as a YAML serializer.
Christian Heimes90540002008-05-08 14:29:10 +0000122
123
124Basic Usage
125-----------
126
Serhiy Storchakaaacd53f2016-06-22 00:03:20 +0300127.. function:: dump(obj, fp, *, skipkeys=False, ensure_ascii=True, \
Andrew Svetlov2ec53be2012-10-28 14:10:30 +0200128 check_circular=True, allow_nan=True, cls=None, \
129 indent=None, separators=None, default=None, \
130 sort_keys=False, **kw)
Christian Heimes90540002008-05-08 14:29:10 +0000131
132 Serialize *obj* as a JSON formatted stream to *fp* (a ``.write()``-supporting
Ezio Melotti6d2bc6e2013-03-29 03:59:29 +0200133 :term:`file-like object`) using this :ref:`conversion table
134 <py-to-json-table>`.
Christian Heimes90540002008-05-08 14:29:10 +0000135
Serhiy Storchaka15287f82016-06-30 13:59:12 +0300136 If *skipkeys* is true (default: ``False``), then dict keys that are not
Antoine Pitrou00d650b2011-01-21 21:37:32 +0000137 of a basic type (:class:`str`, :class:`int`, :class:`float`, :class:`bool`,
138 ``None``) will be skipped instead of raising a :exc:`TypeError`.
Christian Heimes90540002008-05-08 14:29:10 +0000139
Benjamin Petersonc6b607d2009-05-02 12:36:44 +0000140 The :mod:`json` module always produces :class:`str` objects, not
141 :class:`bytes` objects. Therefore, ``fp.write()`` must support :class:`str`
142 input.
143
Serhiy Storchaka15287f82016-06-30 13:59:12 +0300144 If *ensure_ascii* is true (the default), the output is guaranteed to
Éric Araujo6f7aa002012-01-16 10:09:20 +0100145 have all incoming non-ASCII characters escaped. If *ensure_ascii* is
Serhiy Storchaka15287f82016-06-30 13:59:12 +0300146 false, these characters will be output as-is.
Éric Araujo6f7aa002012-01-16 10:09:20 +0100147
Serhiy Storchaka15287f82016-06-30 13:59:12 +0300148 If *check_circular* is false (default: ``True``), then the circular
Christian Heimes90540002008-05-08 14:29:10 +0000149 reference check for container types will be skipped and a circular reference
150 will result in an :exc:`OverflowError` (or worse).
151
Serhiy Storchaka15287f82016-06-30 13:59:12 +0300152 If *allow_nan* is false (default: ``True``), then it will be a
Christian Heimes90540002008-05-08 14:29:10 +0000153 :exc:`ValueError` to serialize out of range :class:`float` values (``nan``,
Serhiy Storchaka15287f82016-06-30 13:59:12 +0300154 ``inf``, ``-inf``) in strict compliance of the JSON specification.
155 If *allow_nan* is true, their JavaScript equivalents (``NaN``,
156 ``Infinity``, ``-Infinity``) will be used.
Christian Heimes90540002008-05-08 14:29:10 +0000157
Raymond Hettingerb643ef82010-10-31 08:00:16 +0000158 If *indent* is a non-negative integer or string, then JSON array elements and
159 object members will be pretty-printed with that indent level. An indent level
R David Murrayd5315482011-04-12 21:09:18 -0400160 of 0, negative, or ``""`` will only insert newlines. ``None`` (the default)
161 selects the most compact representation. Using a positive integer indent
Petri Lehtinen72c6eef2012-08-27 20:27:30 +0300162 indents that many spaces per level. If *indent* is a string (such as ``"\t"``),
R David Murrayd5315482011-04-12 21:09:18 -0400163 that string is used to indent each level.
Christian Heimes90540002008-05-08 14:29:10 +0000164
Petri Lehtinen72b14262012-08-28 07:08:44 +0300165 .. versionchanged:: 3.2
166 Allow strings for *indent* in addition to integers.
167
Ezio Melotti10031442012-11-29 00:42:56 +0200168 If specified, *separators* should be an ``(item_separator, key_separator)``
169 tuple. The default is ``(', ', ': ')`` if *indent* is ``None`` and
170 ``(',', ': ')`` otherwise. To get the most compact JSON representation,
171 you should specify ``(',', ':')`` to eliminate whitespace.
172
173 .. versionchanged:: 3.4
174 Use ``(',', ': ')`` as default if *indent* is not ``None``.
Christian Heimes90540002008-05-08 14:29:10 +0000175
Serhiy Storchaka15287f82016-06-30 13:59:12 +0300176 If specified, *default* should be a function that gets called for objects that
177 can't otherwise be serialized. It should return a JSON encodable version of
178 the object or raise a :exc:`TypeError`. If not specified, :exc:`TypeError`
179 is raised.
Christian Heimes90540002008-05-08 14:29:10 +0000180
Serhiy Storchaka15287f82016-06-30 13:59:12 +0300181 If *sort_keys* is true (default: ``False``), then the output of
Andrew Svetlov2ec53be2012-10-28 14:10:30 +0200182 dictionaries will be sorted by key.
183
Georg Brandl1f01deb2009-01-03 22:47:39 +0000184 To use a custom :class:`JSONEncoder` subclass (e.g. one that overrides the
Christian Heimes90540002008-05-08 14:29:10 +0000185 :meth:`default` method to serialize additional types), specify it with the
Georg Brandld4460aa2010-10-15 17:03:02 +0000186 *cls* kwarg; otherwise :class:`JSONEncoder` is used.
Christian Heimes90540002008-05-08 14:29:10 +0000187
Serhiy Storchakaaacd53f2016-06-22 00:03:20 +0300188 .. versionchanged:: 3.6
189 All optional parameters are now :ref:`keyword-only <keyword-only_parameter>`.
Christian Heimes90540002008-05-08 14:29:10 +0000190
Serhiy Storchakaaacd53f2016-06-22 00:03:20 +0300191
192.. function:: dumps(obj, *, skipkeys=False, ensure_ascii=True, \
Andrew Svetlov2ec53be2012-10-28 14:10:30 +0200193 check_circular=True, allow_nan=True, cls=None, \
194 indent=None, separators=None, default=None, \
195 sort_keys=False, **kw)
Christian Heimes90540002008-05-08 14:29:10 +0000196
Ezio Melotti6d2bc6e2013-03-29 03:59:29 +0200197 Serialize *obj* to a JSON formatted :class:`str` using this :ref:`conversion
198 table <py-to-json-table>`. The arguments have the same meaning as in
199 :func:`dump`.
Christian Heimes90540002008-05-08 14:29:10 +0000200
Ezio Melotti60adf952011-04-15 07:37:00 +0300201 .. note::
202
Georg Brandl340d2692011-04-16 16:54:15 +0200203 Unlike :mod:`pickle` and :mod:`marshal`, JSON is not a framed protocol,
204 so trying to serialize multiple objects with repeated calls to
205 :func:`dump` using the same *fp* will result in an invalid JSON file.
206
Senthil Kumaranf2123d22012-03-17 00:40:34 -0700207 .. note::
208
209 Keys in key/value pairs of JSON are always of the type :class:`str`. When
210 a dictionary is converted into JSON, all the keys of the dictionary are
Terry Jan Reedy9cbcc2f2013-03-08 19:35:15 -0500211 coerced to strings. As a result of this, if a dictionary is converted
Senthil Kumaranf2123d22012-03-17 00:40:34 -0700212 into JSON and then back into a dictionary, the dictionary may not equal
213 the original one. That is, ``loads(dumps(x)) != x`` if x has non-string
214 keys.
Christian Heimes90540002008-05-08 14:29:10 +0000215
Serhiy Storchakaaacd53f2016-06-22 00:03:20 +0300216.. function:: load(fp, *, cls=None, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, object_pairs_hook=None, **kw)
Christian Heimes90540002008-05-08 14:29:10 +0000217
Antoine Pitrou15251a92012-08-24 19:49:08 +0200218 Deserialize *fp* (a ``.read()``-supporting :term:`file-like object`
Ezio Melotti6d2bc6e2013-03-29 03:59:29 +0200219 containing a JSON document) to a Python object using this :ref:`conversion
220 table <json-to-py-table>`.
Christian Heimes90540002008-05-08 14:29:10 +0000221
Christian Heimes90540002008-05-08 14:29:10 +0000222 *object_hook* is an optional function that will be called with the result of
Benjamin Peterson25c95f12009-05-08 20:42:26 +0000223 any object literal decoded (a :class:`dict`). The return value of
Christian Heimes90540002008-05-08 14:29:10 +0000224 *object_hook* will be used instead of the :class:`dict`. This feature can be used
Antoine Pitrou331624b2012-08-24 19:37:23 +0200225 to implement custom decoders (e.g. `JSON-RPC <http://www.jsonrpc.org>`_
226 class hinting).
Christian Heimes90540002008-05-08 14:29:10 +0000227
Raymond Hettinger9b8d0692009-04-21 03:27:12 +0000228 *object_pairs_hook* is an optional function that will be called with the
Benjamin Peterson25c95f12009-05-08 20:42:26 +0000229 result of any object literal decoded with an ordered list of pairs. The
Raymond Hettinger9b8d0692009-04-21 03:27:12 +0000230 return value of *object_pairs_hook* will be used instead of the
INADA Naoki629338f2018-04-03 12:39:47 +0900231 :class:`dict`. This feature can be used to implement custom decoders.
232 If *object_hook* is also defined, the *object_pairs_hook* takes priority.
Raymond Hettinger9b8d0692009-04-21 03:27:12 +0000233
234 .. versionchanged:: 3.1
Hirokazu Yamamotoae9eb5c2009-04-26 03:34:06 +0000235 Added support for *object_pairs_hook*.
Raymond Hettinger9b8d0692009-04-21 03:27:12 +0000236
Christian Heimes90540002008-05-08 14:29:10 +0000237 *parse_float*, if specified, will be called with the string of every JSON
238 float to be decoded. By default, this is equivalent to ``float(num_str)``.
239 This can be used to use another datatype or parser for JSON floats
240 (e.g. :class:`decimal.Decimal`).
241
242 *parse_int*, if specified, will be called with the string of every JSON int
243 to be decoded. By default, this is equivalent to ``int(num_str)``. This can
244 be used to use another datatype or parser for JSON integers
245 (e.g. :class:`float`).
246
247 *parse_constant*, if specified, will be called with one of the following
Hynek Schlawack9729fd42012-05-16 19:01:04 +0200248 strings: ``'-Infinity'``, ``'Infinity'``, ``'NaN'``.
249 This can be used to raise an exception if invalid JSON numbers
Christian Heimes90540002008-05-08 14:29:10 +0000250 are encountered.
251
Hynek Schlawackf54c0602012-05-20 18:32:53 +0200252 .. versionchanged:: 3.1
Hynek Schlawack1203e832012-05-20 12:03:17 +0200253 *parse_constant* doesn't get called on 'null', 'true', 'false' anymore.
254
Christian Heimes90540002008-05-08 14:29:10 +0000255 To use a custom :class:`JSONDecoder` subclass, specify it with the ``cls``
Georg Brandld4460aa2010-10-15 17:03:02 +0000256 kwarg; otherwise :class:`JSONDecoder` is used. Additional keyword arguments
257 will be passed to the constructor of the class.
Christian Heimes90540002008-05-08 14:29:10 +0000258
Felix Crux60fb9712013-08-12 17:39:51 -0400259 If the data being deserialized is not a valid JSON document, a
Serhiy Storchaka47efb4a2015-01-26 13:16:30 +0200260 :exc:`JSONDecodeError` will be raised.
Christian Heimes90540002008-05-08 14:29:10 +0000261
Serhiy Storchakaaacd53f2016-06-22 00:03:20 +0300262 .. versionchanged:: 3.6
263 All optional parameters are now :ref:`keyword-only <keyword-only_parameter>`.
264
265.. function:: loads(s, *, encoding=None, cls=None, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, object_pairs_hook=None, **kw)
Christian Heimes90540002008-05-08 14:29:10 +0000266
Nick Coghlanb1615622016-09-10 20:16:18 +1000267 Deserialize *s* (a :class:`str`, :class:`bytes` or :class:`bytearray`
268 instance containing a JSON document) to a Python object using this
269 :ref:`conversion table <json-to-py-table>`.
Christian Heimes90540002008-05-08 14:29:10 +0000270
Antoine Pitrou00d650b2011-01-21 21:37:32 +0000271 The other arguments have the same meaning as in :func:`load`, except
272 *encoding* which is ignored and deprecated.
Christian Heimes90540002008-05-08 14:29:10 +0000273
Felix Cruxb4357992013-08-12 17:39:51 -0400274 If the data being deserialized is not a valid JSON document, a
Serhiy Storchaka47efb4a2015-01-26 13:16:30 +0200275 :exc:`JSONDecodeError` will be raised.
Christian Heimes90540002008-05-08 14:29:10 +0000276
Raymond Hettingera57a8a32017-01-19 21:39:37 -0800277 .. versionchanged:: 3.6
278 *s* can now be of type :class:`bytes` or :class:`bytearray`. The
279 input encoding should be UTF-8, UTF-16 or UTF-32.
280
281
Antoine Pitrou331624b2012-08-24 19:37:23 +0200282Encoders and Decoders
Christian Heimes90540002008-05-08 14:29:10 +0000283---------------------
284
Serhiy Storchakaaacd53f2016-06-22 00:03:20 +0300285.. class:: JSONDecoder(*, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, strict=True, object_pairs_hook=None)
Christian Heimes90540002008-05-08 14:29:10 +0000286
287 Simple JSON decoder.
288
289 Performs the following translations in decoding by default:
290
Ezio Melotti6d2bc6e2013-03-29 03:59:29 +0200291 .. _json-to-py-table:
292
Christian Heimes90540002008-05-08 14:29:10 +0000293 +---------------+-------------------+
294 | JSON | Python |
295 +===============+===================+
296 | object | dict |
297 +---------------+-------------------+
298 | array | list |
299 +---------------+-------------------+
Benjamin Petersonc6b607d2009-05-02 12:36:44 +0000300 | string | str |
Christian Heimes90540002008-05-08 14:29:10 +0000301 +---------------+-------------------+
Georg Brandl639ce962009-04-11 18:18:16 +0000302 | number (int) | int |
Christian Heimes90540002008-05-08 14:29:10 +0000303 +---------------+-------------------+
304 | number (real) | float |
305 +---------------+-------------------+
306 | true | True |
307 +---------------+-------------------+
308 | false | False |
309 +---------------+-------------------+
310 | null | None |
311 +---------------+-------------------+
312
313 It also understands ``NaN``, ``Infinity``, and ``-Infinity`` as their
314 corresponding ``float`` values, which is outside the JSON spec.
315
Christian Heimes90540002008-05-08 14:29:10 +0000316 *object_hook*, if specified, will be called with the result of every JSON
317 object decoded and its return value will be used in place of the given
318 :class:`dict`. This can be used to provide custom deserializations (e.g. to
319 support JSON-RPC class hinting).
320
Raymond Hettinger9b8d0692009-04-21 03:27:12 +0000321 *object_pairs_hook*, if specified will be called with the result of every
322 JSON object decoded with an ordered list of pairs. The return value of
323 *object_pairs_hook* will be used instead of the :class:`dict`. This
INADA Naoki629338f2018-04-03 12:39:47 +0900324 feature can be used to implement custom decoders. If *object_hook* is also
325 defined, the *object_pairs_hook* takes priority.
Raymond Hettinger9b8d0692009-04-21 03:27:12 +0000326
327 .. versionchanged:: 3.1
Hirokazu Yamamotoae9eb5c2009-04-26 03:34:06 +0000328 Added support for *object_pairs_hook*.
Raymond Hettinger9b8d0692009-04-21 03:27:12 +0000329
Christian Heimes90540002008-05-08 14:29:10 +0000330 *parse_float*, if specified, will be called with the string of every JSON
331 float to be decoded. By default, this is equivalent to ``float(num_str)``.
332 This can be used to use another datatype or parser for JSON floats
333 (e.g. :class:`decimal.Decimal`).
334
335 *parse_int*, if specified, will be called with the string of every JSON int
336 to be decoded. By default, this is equivalent to ``int(num_str)``. This can
337 be used to use another datatype or parser for JSON integers
338 (e.g. :class:`float`).
339
340 *parse_constant*, if specified, will be called with one of the following
Serhiy Storchaka022371f2016-11-12 22:47:16 +0200341 strings: ``'-Infinity'``, ``'Infinity'``, ``'NaN'``.
342 This can be used to raise an exception if invalid JSON numbers
Christian Heimes90540002008-05-08 14:29:10 +0000343 are encountered.
344
Serhiy Storchaka15287f82016-06-30 13:59:12 +0300345 If *strict* is false (``True`` is the default), then control characters
Georg Brandld4460aa2010-10-15 17:03:02 +0000346 will be allowed inside strings. Control characters in this context are
Serhiy Storchakac7b1a0b2016-11-26 13:43:28 +0200347 those with character codes in the 0--31 range, including ``'\t'`` (tab),
Georg Brandld4460aa2010-10-15 17:03:02 +0000348 ``'\n'``, ``'\r'`` and ``'\0'``.
349
Felix Crux654f0032013-08-12 17:39:51 -0400350 If the data being deserialized is not a valid JSON document, a
Serhiy Storchaka47efb4a2015-01-26 13:16:30 +0200351 :exc:`JSONDecodeError` will be raised.
Christian Heimes90540002008-05-08 14:29:10 +0000352
Serhiy Storchakaaacd53f2016-06-22 00:03:20 +0300353 .. versionchanged:: 3.6
354 All parameters are now :ref:`keyword-only <keyword-only_parameter>`.
355
Christian Heimes90540002008-05-08 14:29:10 +0000356 .. method:: decode(s)
357
Benjamin Petersonc6b607d2009-05-02 12:36:44 +0000358 Return the Python representation of *s* (a :class:`str` instance
Martin Panterd21e0b52015-10-10 10:36:22 +0000359 containing a JSON document).
Christian Heimes90540002008-05-08 14:29:10 +0000360
Serhiy Storchaka47efb4a2015-01-26 13:16:30 +0200361 :exc:`JSONDecodeError` will be raised if the given JSON document is not
362 valid.
363
Christian Heimes90540002008-05-08 14:29:10 +0000364 .. method:: raw_decode(s)
365
Benjamin Petersonc6b607d2009-05-02 12:36:44 +0000366 Decode a JSON document from *s* (a :class:`str` beginning with a
367 JSON document) and return a 2-tuple of the Python representation
368 and the index in *s* where the document ended.
Christian Heimes90540002008-05-08 14:29:10 +0000369
370 This can be used to decode a JSON document from a string that may have
371 extraneous data at the end.
372
373
Serhiy Storchakaaacd53f2016-06-22 00:03:20 +0300374.. class:: JSONEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)
Christian Heimes90540002008-05-08 14:29:10 +0000375
376 Extensible JSON encoder for Python data structures.
377
378 Supports the following objects and types by default:
379
Ezio Melotti6d2bc6e2013-03-29 03:59:29 +0200380 .. _py-to-json-table:
381
Ethan Furmana4998a72013-08-10 13:01:45 -0700382 +----------------------------------------+---------------+
383 | Python | JSON |
384 +========================================+===============+
385 | dict | object |
386 +----------------------------------------+---------------+
387 | list, tuple | array |
388 +----------------------------------------+---------------+
389 | str | string |
390 +----------------------------------------+---------------+
391 | int, float, int- & float-derived Enums | number |
392 +----------------------------------------+---------------+
393 | True | true |
394 +----------------------------------------+---------------+
395 | False | false |
396 +----------------------------------------+---------------+
397 | None | null |
398 +----------------------------------------+---------------+
399
400 .. versionchanged:: 3.4
401 Added support for int- and float-derived Enum classes.
Christian Heimes90540002008-05-08 14:29:10 +0000402
403 To extend this to recognize other objects, subclass and implement a
404 :meth:`default` method with another method that returns a serializable object
405 for ``o`` if possible, otherwise it should call the superclass implementation
406 (to raise :exc:`TypeError`).
407
Serhiy Storchaka15287f82016-06-30 13:59:12 +0300408 If *skipkeys* is false (the default), then it is a :exc:`TypeError` to
Serhiy Storchakaecf41da2016-10-19 16:29:26 +0300409 attempt encoding of keys that are not :class:`str`, :class:`int`,
410 :class:`float` or ``None``. If *skipkeys* is true, such items are simply
411 skipped.
Christian Heimes90540002008-05-08 14:29:10 +0000412
Serhiy Storchaka15287f82016-06-30 13:59:12 +0300413 If *ensure_ascii* is true (the default), the output is guaranteed to
Benjamin Petersonc6b607d2009-05-02 12:36:44 +0000414 have all incoming non-ASCII characters escaped. If *ensure_ascii* is
Serhiy Storchaka15287f82016-06-30 13:59:12 +0300415 false, these characters will be output as-is.
Christian Heimes90540002008-05-08 14:29:10 +0000416
Serhiy Storchaka15287f82016-06-30 13:59:12 +0300417 If *check_circular* is true (the default), then lists, dicts, and custom
Christian Heimes90540002008-05-08 14:29:10 +0000418 encoded objects will be checked for circular references during encoding to
419 prevent an infinite recursion (which would cause an :exc:`OverflowError`).
420 Otherwise, no such check takes place.
421
Serhiy Storchaka15287f82016-06-30 13:59:12 +0300422 If *allow_nan* is true (the default), then ``NaN``, ``Infinity``, and
Christian Heimes90540002008-05-08 14:29:10 +0000423 ``-Infinity`` will be encoded as such. This behavior is not JSON
424 specification compliant, but is consistent with most JavaScript based
425 encoders and decoders. Otherwise, it will be a :exc:`ValueError` to encode
426 such floats.
427
Serhiy Storchaka15287f82016-06-30 13:59:12 +0300428 If *sort_keys* is true (default: ``False``), then the output of dictionaries
Christian Heimes90540002008-05-08 14:29:10 +0000429 will be sorted by key; this is useful for regression tests to ensure that
430 JSON serializations can be compared on a day-to-day basis.
431
Petri Lehtinen72b14262012-08-28 07:08:44 +0300432 If *indent* is a non-negative integer or string, then JSON array elements and
433 object members will be pretty-printed with that indent level. An indent level
434 of 0, negative, or ``""`` will only insert newlines. ``None`` (the default)
435 selects the most compact representation. Using a positive integer indent
436 indents that many spaces per level. If *indent* is a string (such as ``"\t"``),
437 that string is used to indent each level.
438
439 .. versionchanged:: 3.2
440 Allow strings for *indent* in addition to integers.
Christian Heimes90540002008-05-08 14:29:10 +0000441
442 If specified, *separators* should be an ``(item_separator, key_separator)``
Ezio Melotti10031442012-11-29 00:42:56 +0200443 tuple. The default is ``(', ', ': ')`` if *indent* is ``None`` and
444 ``(',', ': ')`` otherwise. To get the most compact JSON representation,
445 you should specify ``(',', ':')`` to eliminate whitespace.
446
447 .. versionchanged:: 3.4
448 Use ``(',', ': ')`` as default if *indent* is not ``None``.
Christian Heimes90540002008-05-08 14:29:10 +0000449
Serhiy Storchaka15287f82016-06-30 13:59:12 +0300450 If specified, *default* should be a function that gets called for objects that
451 can't otherwise be serialized. It should return a JSON encodable version of
452 the object or raise a :exc:`TypeError`. If not specified, :exc:`TypeError`
453 is raised.
Christian Heimes90540002008-05-08 14:29:10 +0000454
Serhiy Storchakaaacd53f2016-06-22 00:03:20 +0300455 .. versionchanged:: 3.6
456 All parameters are now :ref:`keyword-only <keyword-only_parameter>`.
457
Christian Heimes90540002008-05-08 14:29:10 +0000458
459 .. method:: default(o)
460
461 Implement this method in a subclass such that it returns a serializable
462 object for *o*, or calls the base implementation (to raise a
463 :exc:`TypeError`).
464
465 For example, to support arbitrary iterators, you could implement default
466 like this::
Georg Brandl48310cd2009-01-03 21:18:54 +0000467
Christian Heimes90540002008-05-08 14:29:10 +0000468 def default(self, o):
469 try:
Benjamin Petersone9bbc8b2008-09-28 02:06:32 +0000470 iterable = iter(o)
Christian Heimes90540002008-05-08 14:29:10 +0000471 except TypeError:
Benjamin Petersone9bbc8b2008-09-28 02:06:32 +0000472 pass
Christian Heimes90540002008-05-08 14:29:10 +0000473 else:
474 return list(iterable)
R David Murraydd246172013-03-17 21:52:35 -0400475 # Let the base class default method raise the TypeError
Georg Brandl0bb73b82010-09-03 22:36:22 +0000476 return json.JSONEncoder.default(self, o)
Christian Heimes90540002008-05-08 14:29:10 +0000477
478
479 .. method:: encode(o)
480
481 Return a JSON string representation of a Python data structure, *o*. For
482 example::
483
Georg Brandl0bb73b82010-09-03 22:36:22 +0000484 >>> json.JSONEncoder().encode({"foo": ["bar", "baz"]})
Christian Heimes90540002008-05-08 14:29:10 +0000485 '{"foo": ["bar", "baz"]}'
486
487
488 .. method:: iterencode(o)
489
490 Encode the given object, *o*, and yield each string representation as
491 available. For example::
Georg Brandl48310cd2009-01-03 21:18:54 +0000492
Georg Brandl0bb73b82010-09-03 22:36:22 +0000493 for chunk in json.JSONEncoder().iterencode(bigobject):
Christian Heimes90540002008-05-08 14:29:10 +0000494 mysocket.write(chunk)
Antoine Pitrou331624b2012-08-24 19:37:23 +0200495
496
Serhiy Storchaka47efb4a2015-01-26 13:16:30 +0200497Exceptions
498----------
499
Serhiy Storchaka5becf382017-05-27 16:11:18 +0300500.. exception:: JSONDecodeError(msg, doc, pos)
Serhiy Storchaka47efb4a2015-01-26 13:16:30 +0200501
Martin Panteref107ee2017-01-24 00:26:56 +0000502 Subclass of :exc:`ValueError` with the following additional attributes:
Serhiy Storchaka47efb4a2015-01-26 13:16:30 +0200503
Martin Panteref107ee2017-01-24 00:26:56 +0000504 .. attribute:: msg
Serhiy Storchaka47efb4a2015-01-26 13:16:30 +0200505
Martin Panteref107ee2017-01-24 00:26:56 +0000506 The unformatted error message.
Serhiy Storchaka47efb4a2015-01-26 13:16:30 +0200507
Martin Panteref107ee2017-01-24 00:26:56 +0000508 .. attribute:: doc
Serhiy Storchaka47efb4a2015-01-26 13:16:30 +0200509
Martin Panteref107ee2017-01-24 00:26:56 +0000510 The JSON document being parsed.
Serhiy Storchaka47efb4a2015-01-26 13:16:30 +0200511
Martin Panteref107ee2017-01-24 00:26:56 +0000512 .. attribute:: pos
Serhiy Storchaka47efb4a2015-01-26 13:16:30 +0200513
Martin Panteref107ee2017-01-24 00:26:56 +0000514 The start index of *doc* where parsing failed.
Serhiy Storchaka47efb4a2015-01-26 13:16:30 +0200515
Martin Panteref107ee2017-01-24 00:26:56 +0000516 .. attribute:: lineno
Serhiy Storchaka47efb4a2015-01-26 13:16:30 +0200517
Martin Panteref107ee2017-01-24 00:26:56 +0000518 The line corresponding to *pos*.
Serhiy Storchaka47efb4a2015-01-26 13:16:30 +0200519
Martin Panteref107ee2017-01-24 00:26:56 +0000520 .. attribute:: colno
Serhiy Storchaka47efb4a2015-01-26 13:16:30 +0200521
Martin Panteref107ee2017-01-24 00:26:56 +0000522 The column corresponding to *pos*.
Serhiy Storchaka47efb4a2015-01-26 13:16:30 +0200523
524 .. versionadded:: 3.5
525
526
Serhiy Storchaka7a6915e2014-11-27 19:41:47 +0200527Standard Compliance and Interoperability
528----------------------------------------
Antoine Pitrou331624b2012-08-24 19:37:23 +0200529
Serhiy Storchaka7a6915e2014-11-27 19:41:47 +0200530The JSON format is specified by :rfc:`7159` and by
531`ECMA-404 <http://www.ecma-international.org/publications/standards/Ecma-404.htm>`_.
532This section details this module's level of compliance with the RFC.
533For simplicity, :class:`JSONEncoder` and :class:`JSONDecoder` subclasses, and
534parameters other than those explicitly mentioned, are not considered.
Antoine Pitrou331624b2012-08-24 19:37:23 +0200535
536This module does not comply with the RFC in a strict fashion, implementing some
537extensions that are valid JavaScript but not valid JSON. In particular:
538
Antoine Pitrou331624b2012-08-24 19:37:23 +0200539- Infinite and NaN number values are accepted and output;
540- Repeated names within an object are accepted, and only the value of the last
541 name-value pair is used.
542
543Since the RFC permits RFC-compliant parsers to accept input texts that are not
544RFC-compliant, this module's deserializer is technically RFC-compliant under
545default settings.
546
547Character Encodings
548^^^^^^^^^^^^^^^^^^^
549
Serhiy Storchaka7a6915e2014-11-27 19:41:47 +0200550The RFC requires that JSON be represented using either UTF-8, UTF-16, or
551UTF-32, with UTF-8 being the recommended default for maximum interoperability.
Antoine Pitrou331624b2012-08-24 19:37:23 +0200552
553As permitted, though not required, by the RFC, this module's serializer sets
554*ensure_ascii=True* by default, thus escaping the output so that the resulting
555strings only contain ASCII characters.
556
557Other than the *ensure_ascii* parameter, this module is defined strictly in
558terms of conversion between Python objects and
Serhiy Storchaka7a6915e2014-11-27 19:41:47 +0200559:class:`Unicode strings <str>`, and thus does not otherwise directly address
560the issue of character encodings.
Antoine Pitrou331624b2012-08-24 19:37:23 +0200561
Serhiy Storchaka7a6915e2014-11-27 19:41:47 +0200562The RFC prohibits adding a byte order mark (BOM) to the start of a JSON text,
563and this module's serializer does not add a BOM to its output.
564The RFC permits, but does not require, JSON deserializers to ignore an initial
565BOM in their input. This module's deserializer raises a :exc:`ValueError`
566when an initial BOM is present.
Antoine Pitrou331624b2012-08-24 19:37:23 +0200567
Serhiy Storchaka7a6915e2014-11-27 19:41:47 +0200568The RFC does not explicitly forbid JSON strings which contain byte sequences
569that don't correspond to valid Unicode characters (e.g. unpaired UTF-16
570surrogates), but it does note that they may cause interoperability problems.
571By default, this module accepts and outputs (when present in the original
Serhiy Storchakad3faf432015-01-18 11:28:37 +0200572:class:`str`) code points for such sequences.
Antoine Pitrou331624b2012-08-24 19:37:23 +0200573
574
575Infinite and NaN Number Values
576^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
577
578The RFC does not permit the representation of infinite or NaN number values.
579Despite that, by default, this module accepts and outputs ``Infinity``,
580``-Infinity``, and ``NaN`` as if they were valid JSON number literal values::
581
582 >>> # Neither of these calls raises an exception, but the results are not valid JSON
583 >>> json.dumps(float('-inf'))
584 '-Infinity'
585 >>> json.dumps(float('nan'))
586 'NaN'
587 >>> # Same when deserializing
588 >>> json.loads('-Infinity')
589 -inf
590 >>> json.loads('NaN')
591 nan
592
593In the serializer, the *allow_nan* parameter can be used to alter this
594behavior. In the deserializer, the *parse_constant* parameter can be used to
595alter this behavior.
596
597
598Repeated Names Within an Object
599^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
600
601The RFC specifies that the names within a JSON object should be unique, but
Serhiy Storchaka7a6915e2014-11-27 19:41:47 +0200602does not mandate how repeated names in JSON objects should be handled. By
Antoine Pitrou331624b2012-08-24 19:37:23 +0200603default, this module does not raise an exception; instead, it ignores all but
604the last name-value pair for a given name::
605
606 >>> weird_json = '{"x": 1, "x": 2, "x": 3}'
607 >>> json.loads(weird_json)
608 {'x': 3}
609
610The *object_pairs_hook* parameter can be used to alter this behavior.
Benjamin Peterson940e2072014-03-21 23:17:29 -0500611
Serhiy Storchaka7a6915e2014-11-27 19:41:47 +0200612
613Top-level Non-Object, Non-Array Values
614^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
615
616The old version of JSON specified by the obsolete :rfc:`4627` required that
617the top-level value of a JSON text must be either a JSON object or array
618(Python :class:`dict` or :class:`list`), and could not be a JSON null,
619boolean, number, or string value. :rfc:`7159` removed that restriction, and
620this module does not and has never implemented that restriction in either its
621serializer or its deserializer.
622
623Regardless, for maximum interoperability, you may wish to voluntarily adhere
624to the restriction yourself.
625
626
627Implementation Limitations
628^^^^^^^^^^^^^^^^^^^^^^^^^^
629
630Some JSON deserializer implementations may set limits on:
631
632* the size of accepted JSON texts
633* the maximum level of nesting of JSON objects and arrays
634* the range and precision of JSON numbers
635* the content and maximum length of JSON strings
636
637This module does not impose any such limits beyond those of the relevant
638Python datatypes themselves or the Python interpreter itself.
639
640When serializing to JSON, beware any such limitations in applications that may
641consume your JSON. In particular, it is common for JSON numbers to be
642deserialized into IEEE 754 double precision numbers and thus subject to that
643representation's range and precision limitations. This is especially relevant
644when serializing Python :class:`int` values of extremely large magnitude, or
645when serializing instances of "exotic" numerical types such as
646:class:`decimal.Decimal`.
647
Benjamin Peterson940e2072014-03-21 23:17:29 -0500648.. _json-commandline:
649
650Command Line Interface
651----------------------
652
Terry Jan Reedydcb6c882016-06-22 22:46:34 -0400653.. module:: json.tool
654 :synopsis: A command line to validate and pretty-print JSON.
655
656**Source code:** :source:`Lib/json/tool.py`
657
658--------------
659
Benjamin Peterson940e2072014-03-21 23:17:29 -0500660The :mod:`json.tool` module provides a simple command line interface to validate
661and pretty-print JSON objects.
662
Georg Brandl9e7fbde2014-09-21 00:38:13 +0200663If the optional ``infile`` and ``outfile`` arguments are not
Serhiy Storchaka46936d52018-04-08 19:18:04 +0300664specified, :attr:`sys.stdin` and :attr:`sys.stdout` will be used respectively:
665
666.. code-block:: shell-session
Benjamin Peterson940e2072014-03-21 23:17:29 -0500667
668 $ echo '{"json": "obj"}' | python -m json.tool
669 {
670 "json": "obj"
671 }
672 $ echo '{1.2:3.4}' | python -m json.tool
673 Expecting property name enclosed in double quotes: line 1 column 2 (char 1)
674
Berker Peksag39e4c4d2014-11-10 09:56:54 +0200675.. versionchanged:: 3.5
676 The output is now in the same order as the input. Use the
677 :option:`--sort-keys` option to sort the output of dictionaries
678 alphabetically by key.
Benjamin Peterson940e2072014-03-21 23:17:29 -0500679
680Command line options
681^^^^^^^^^^^^^^^^^^^^
682
Benjamin Petersonfc8e9882014-04-13 19:52:14 -0400683.. cmdoption:: infile
Benjamin Peterson940e2072014-03-21 23:17:29 -0500684
Serhiy Storchaka46936d52018-04-08 19:18:04 +0300685 The JSON file to be validated or pretty-printed:
686
687 .. code-block:: shell-session
Benjamin Peterson940e2072014-03-21 23:17:29 -0500688
689 $ python -m json.tool mp_films.json
690 [
691 {
692 "title": "And Now for Something Completely Different",
693 "year": 1971
694 },
695 {
696 "title": "Monty Python and the Holy Grail",
697 "year": 1975
698 }
699 ]
700
Benjamin Petersonfc8e9882014-04-13 19:52:14 -0400701 If *infile* is not specified, read from :attr:`sys.stdin`.
702
703.. cmdoption:: outfile
Benjamin Peterson940e2072014-03-21 23:17:29 -0500704
705 Write the output of the *infile* to the given *outfile*. Otherwise, write it
706 to :attr:`sys.stdout`.
707
Berker Peksag39e4c4d2014-11-10 09:56:54 +0200708.. cmdoption:: --sort-keys
709
710 Sort the output of dictionaries alphabetically by key.
711
712 .. versionadded:: 3.5
713
Benjamin Peterson940e2072014-03-21 23:17:29 -0500714.. cmdoption:: -h, --help
715
716 Show the help message.
Serhiy Storchaka715f01b2014-11-27 19:45:31 +0200717
Serhiy Storchaka7a6915e2014-11-27 19:41:47 +0200718
719.. rubric:: Footnotes
720
721.. [#rfc-errata] As noted in `the errata for RFC 7159
Serhiy Storchaka6dff0202016-05-07 10:49:07 +0300722 <https://www.rfc-editor.org/errata_search.php?rfc=7159>`_,
Serhiy Storchaka7a6915e2014-11-27 19:41:47 +0200723 JSON permits literal U+2028 (LINE SEPARATOR) and
724 U+2029 (PARAGRAPH SEPARATOR) characters in strings, whereas JavaScript
725 (as of ECMAScript Edition 5.1) does not.