json —- JSON 编码和解码器

源代码:Lib/json/init.py

JSON (JavaScript Object Notation)，由 RFC 7159 (which obsoletes RFC 4627) 和 ECMA-404 指定，是一个受 JavaScript 的对象字面量语法启发的轻量级数据交换格式，尽管它不仅仅是一个严格意义上的 JavaScript 的字集 1。

json 提供了与标准库 marshal 和 pickle 相似的API接口。

对基本的 Python 对象层次结构进行编码：

  1. >>> import json
  2. >>> json.dumps(['foo', {'bar': ('baz', None, 1.0, 2)}])
  3. '["foo", {"bar": ["baz", null, 1.0, 2]}]'
  4. >>> print(json.dumps("\"foo\bar"))
  5. "\"foo\bar"
  6. >>> print(json.dumps('\u1234'))
  7. "\u1234"
  8. >>> print(json.dumps('\\'))
  9. "\\"
  10. >>> print(json.dumps({"c": 0, "b": 0, "a": 0}, sort_keys=True))
  11. {"a": 0, "b": 0, "c": 0}
  12. >>> from io import StringIO
  13. >>> io = StringIO()
  14. >>> json.dump(['streaming API'], io)
  15. >>> io.getvalue()
  16. '["streaming API"]'

紧凑编码:

  1. >>> import json
  2. >>> json.dumps([1, 2, 3, {'4': 5, '6': 7}], separators=(',', ':'))
  3. '[1,2,3,{"4":5,"6":7}]'

美化输出:

  1. >>> import json
  2. >>> print(json.dumps({'4': 5, '6': 7}, sort_keys=True, indent=4))
  3. {
  4.     "4": 5,
  5.     "6": 7
  6. }

JSON解码:

  1. >>> import json
  2. >>> json.loads('["foo", {"bar":["baz", null, 1.0, 2]}]')
  3. ['foo', {'bar': ['baz', None, 1.0, 2]}]
  4. >>> json.loads('"\\"foo\\bar"')
  5. '"foo\x08ar'
  6. >>> from io import StringIO
  7. >>> io = StringIO('["streaming API"]')
  8. >>> json.load(io)
  9. ['streaming API']

特殊JSON对象解码:

  1. >>> import json
  2. >>> def as_complex(dct):
  3. ...     if '__complex__' in dct:
  4. ...         return complex(dct['real'], dct['imag'])
  5. ...     return dct
  6. ...
  7. >>> json.loads('{"__complex__": true, "real": 1, "imag": 2}',
  8. ...     object_hook=as_complex)
  9. (1+2j)
  10. >>> import decimal
  11. >>> json.loads('1.1', parse_float=decimal.Decimal)
  12. Decimal('1.1')

扩展 JSONEncoder:

  1. >>> import json
  2. >>> class ComplexEncoder(json.JSONEncoder):
  3. ...     def default(self, obj):
  4. ...         if isinstance(obj, complex):
  5. ...             return [obj.real, obj.imag]
  6. ...         # Let the base class default method raise the TypeError
  7. ...         return json.JSONEncoder.default(self, obj)
  8. ...
  9. >>> json.dumps(2 + 1j, cls=ComplexEncoder)
  10. '[2.0, 1.0]'
  11. >>> ComplexEncoder().encode(2 + 1j)
  12. '[2.0, 1.0]'
  13. >>> list(ComplexEncoder().iterencode(2 + 1j))
  14. ['[2.0', ', 1.0', ']']

从命令行使用 json.tool 来验证并美化输出：

  1. $ echo '{"json":"obj"}' | python -m json.tool
  2. {
  3.     "json": "obj"
  4. }
  5. $ echo '{1.2:3.4}' | python -m json.tool
  6. Expecting property name enclosed in double quotes: line 1 column 2 (char 1)

详细文档请参见 Command Line Interface。

注解

JSON 是 YAML 1.2 的一个子集。由该模块的默认设置生成的 JSON （尤其是默认的 “分隔符” 设置值）也是 YAML 1.0 and 1.1 的一个子集。因此该模块也能够用于序列化为 YAML。

注解

This module's encoders and decoders preserve input and output order bydefault. Order is only lost if the underlying containers are unordered.

Prior to Python 3.7, dict was not guaranteed to be ordered, soinputs and outputs were typically scrambled unlesscollections.OrderedDict was specifically requested. Startingwith Python 3.7, the regular dict became order preserving, soit is no longer necessary to specify collections.OrderedDict forJSON generation and parsing.

基本使用

  • json.dump(obj, fp, *, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, sort_keys=False, **kw)
  • 使用这个 conversion table 来序列化 obj 为一个 JSON 格式的流并输出到 fp （一个支持 .write() 的 file-like object）。

如果 skipkeys 是 true （默认为 False），那么那些不是基本对象（包括 str, int、float、bool、None）的字典的键会被跳过；否则引发一个 TypeError。

json 模块始终产生 str 对象而非 bytes 对象。因此，fp.write() 必须支持 str 输入。

如果 ensure_ascii 是 true （即默认值），输出保证将所有输入的非 ASCII 字符转义。如果 ensure_ascii 是 false，这些字符会原样输出。

如果 check_circular 是为假值 (默认为 True)，那么容器类型的循环引用检验会被跳过并且循环引用会引发一个 OverflowError (或者更糟的情况)。

如果 allow_nan 是 false（默认为 True），那么在对严格 JSON 规格范围外的 float 类型值（nan、inf 和 -inf）进行序列化时会引发一个 ValueError。如果 allow_nan 是 true，则使用它们的 JavaScript 等价形式（NaN、Infinity 和 -Infinity）。

如果 indent 是一个非负整数或者字符串，那么 JSON 数组元素和对象成员会被美化输出为该值指定的缩进等级。如果缩进等级为零、负数或者 ""，则只会添加换行符。None（默认值）选择最紧凑的表达。使用一个正整数会让每一层缩进同样数量的空格。如果 *indent* 是一个字符串（比如"\t"），那个字符串会被用于缩进每一层。

在 3.2 版更改: 允许使用字符串作为 indent 而不再仅仅是整数。

当指定时，separators 应当是一个 (itemseparator, key_separator) 元组。当 _indent 为 None 时，默认值取 (', ', ': ')，否则取 (',', ': ')。为了得到最紧凑的 JSON 表达式，你应该指定其为 (',', ':') 以消除空白字符。

在 3.4 版更改: 现当 indent 不是 None 时，采用 (',', ': ') 作为默认值。

当 default 被指定时，其应该是一个函数，每当某个对象无法被序列化时它会被调用。它应该返回该对象的一个可以被 JSON 编码的版本或者引发一个 TypeError。如果没有被指定，则会直接引发 TypeError。

如果 sort_keys 是 true（默认为 False），那么字典的输出会以键的顺序排序。

为了使用一个自定义的 JSONEncoder 子类（比如：覆盖了 default() 方法来序列化额外的类型）， 通过 cls 关键字参数来指定；否则将使用 JSONEncoder。

在 3.6 版更改: 所有的可选参数现在是 keyword-only 的了。

注解

与 pickle 和 marshal 不同，JSON 不是一个具有框架的协议，所以尝试多次使用同一个 fp 调用 dump() 来序列化多个对象会产生一个不合规的 JSON 文件。

  • json.dumps(obj, *, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, sort_keys=False, **kw)
  • 使用这个 转换表 将 obj 序列化为 JSON 格式的 str。 其参数的含义与 dump() 中的相同。

注解

JSON 中的键-值对中的键永远是 str 类型的。当一个对象被转化为 JSON 时，字典中所有的键都会被强制转换为字符串。这所造成的结果是字典被转换为 JSON 然后转换回字典时可能和原来的不相等。换句话说，如果 x 具有非字符串的键，则有 loads(dumps(x)) != x。

  • json.load(fp, *, cls=None, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, object_pairs_hook=None, **kw)
  • 使用这个 转换表 将 fp (一个支持 .read() 并包含一个 JSON 文档的 text file 或者 binary file) 反序列化为一个 Python 对象。

object_hook 是一个可选的函数，它会被调用于每一个解码出的对象字面量（即一个 dict）。object_hook 的返回值会取代原本的 dict。这一特性能够被用于实现自定义解码器（如 JSON-RPC 的类型提示)。

object_pairs_hook is an optional function that will be called with theresult of any object literal decoded with an ordered list of pairs. Thereturn value of object_pairs_hook will be used instead of thedict. This feature can be used to implement custom decoders.If object_hook is also defined, the object_pairs_hook takes priority.

在 3.1 版更改: Added support for object_pairs_hook.

parse_float, if specified, will be called with the string of every JSONfloat to be decoded. By default, this is equivalent to float(num_str).This can be used to use another datatype or parser for JSON floats(e.g. decimal.Decimal).

parse_int, if specified, will be called with the string of every JSON intto be decoded. By default, this is equivalent to int(num_str). This canbe used to use another datatype or parser for JSON integers(e.g. float).

parse_constant, if specified, will be called with one of the followingstrings: '-Infinity', 'Infinity', 'NaN'.This can be used to raise an exception if invalid JSON numbersare encountered.

在 3.1 版更改: parse_constant doesn't get called on 'null', 'true', 'false' anymore.

To use a custom JSONDecoder subclass, specify it with the clskwarg; otherwise JSONDecoder is used. Additional keyword argumentswill be passed to the constructor of the class.

If the data being deserialized is not a valid JSON document, aJSONDecodeError will be raised.

在 3.6 版更改: 所有的可选参数现在是 keyword-only 的了。

在 3.6 版更改: fp can now be a binary file. The input encoding should beUTF-8, UTF-16 or UTF-32.

  • json.loads(s, *, cls=None, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, object_pairs_hook=None, **kw)
  • Deserialize s (a str, bytes or bytearrayinstance containing a JSON document) to a Python object using thisconversion table.

The other arguments have the same meaning as in load(), exceptencoding which is ignored and deprecated since Python 3.1.

If the data being deserialized is not a valid JSON document, aJSONDecodeError will be raised.

Deprecated since version 3.1, will be removed in version 3.9: encoding keyword argument.

在 3.6 版更改: s 现在可以为 bytes 或 bytearray 类型。 输入编码应为 UTF-8, UTF-16 或 UTF-32。

编码器和解码器

  • class json.JSONDecoder(*, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, strict=True, object_pairs_hook=None)
  • 简单的JSON解码器。

默认情况下，解码执行以下翻译:

JSON

Python

object

dict

array

list

string

str

整数

int

非整数

float

true

True

false

False

null

None

它还将“NaN”、“Infinity”和“-Infinity”理解为它们对应的“float”值，这超出了JSON规范。

object_hook, if specified, will be called with the result of every JSONobject decoded and its return value will be used in place of the givendict. This can be used to provide custom deserializations (e.g. tosupport JSON-RPC class hinting).

object_pairs_hook, if specified will be called with the result of everyJSON object decoded with an ordered list of pairs. The return value ofobject_pairs_hook will be used instead of the dict. Thisfeature can be used to implement custom decoders. If object_hook is alsodefined, the object_pairs_hook takes priority.

在 3.1 版更改: Added support for object_pairs_hook.

parse_float, if specified, will be called with the string of every JSONfloat to be decoded. By default, this is equivalent to float(num_str).This can be used to use another datatype or parser for JSON floats(e.g. decimal.Decimal).

parse_int, if specified, will be called with the string of every JSON intto be decoded. By default, this is equivalent to int(num_str). This canbe used to use another datatype or parser for JSON integers(e.g. float).

parse_constant, if specified, will be called with one of the followingstrings: '-Infinity', 'Infinity', 'NaN'.This can be used to raise an exception if invalid JSON numbersare encountered.

If strict is false (True is the default), then control characterswill be allowed inside strings. Control characters in this context arethose with character codes in the 0—31 range, including '\t' (tab),'\n', '\r' and '\0'.

If the data being deserialized is not a valid JSON document, aJSONDecodeError will be raised.

在 3.6 版更改: All parameters are now keyword-only.

  • decode(s)
  • 返回 s 的 Python 表示形式（包含一个 JSON 文档的 str 实例）。

如果给定的 JSON 文档无效则将引发 JSONDecodeError。

  • rawdecode(_s)
  • 从 s 中解码出 JSON 文档（以 JSON 文档开头的一个 str 对象）并返回一个 Python 表示形式为 2 元组以及指明该文档在 s 中结束位置的序号。

这可以用于从一个字符串解码JSON文档，该字符串的末尾可能有无关的数据。

  • class json.JSONEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)
  • 用于Python数据结构的可扩展JSON编码器。

Supports the following objects and types by default:

Python

JSON

dict

object

列表、元组

array

str

string

int, float, int- & float派生枚举

number

True

true

False

false

None

null

在 3.4 版更改: Added support for int- and float-derived Enum classes.

To extend this to recognize other objects, subclass and implement adefault() method with another method that returns a serializable objectfor o if possible, otherwise it should call the superclass implementation(to raise TypeError).

If skipkeys is false (the default), then it is a TypeError toattempt encoding of keys that are not str, int,float or None. If skipkeys is true, such items are simplyskipped.

如果 ensure_ascii 是 true （即默认值），输出保证将所有输入的非 ASCII 字符转义。如果 ensure_ascii 是 false，这些字符会原样输出。

If check_circular is true (the default), then lists, dicts, and customencoded objects will be checked for circular references during encoding toprevent an infinite recursion (which would cause an OverflowError).Otherwise, no such check takes place.

If allow_nan is true (the default), then NaN, Infinity, and-Infinity will be encoded as such. This behavior is not JSONspecification compliant, but is consistent with most JavaScript basedencoders and decoders. Otherwise, it will be a ValueError to encodesuch floats.

If sort_keys is true (default: False), then the output of dictionarieswill be sorted by key; this is useful for regression tests to ensure thatJSON serializations can be compared on a day-to-day basis.

如果 indent 是一个非负整数或者字符串，那么 JSON 数组元素和对象成员会被美化输出为该值指定的缩进等级。如果缩进等级为零、负数或者 ""，则只会添加换行符。None（默认值）选择最紧凑的表达。使用一个正整数会让每一层缩进同样数量的空格。如果 *indent* 是一个字符串（比如"\t"），那个字符串会被用于缩进每一层。

在 3.2 版更改: 允许使用字符串作为 indent 而不再仅仅是整数。

当指定时，separators 应当是一个 (itemseparator, key_separator) 元组。当 _indent 为 None 时，默认值取 (', ', ': ')，否则取 (',', ': ')。为了得到最紧凑的 JSON 表达式，你应该指定其为 (',', ':') 以消除空白字符。

在 3.4 版更改: 现当 indent 不是 None 时，采用 (',', ': ') 作为默认值。

当 default 被指定时，其应该是一个函数，每当某个对象无法被序列化时它会被调用。它应该返回该对象的一个可以被 JSON 编码的版本或者引发一个 TypeError。如果没有被指定，则会直接引发 TypeError。

在 3.6 版更改: All parameters are now keyword-only.

  • default(o)
  • Implement this method in a subclass such that it returns a serializableobject for o, or calls the base implementation (to raise aTypeError).

For example, to support arbitrary iterators, you could implement defaultlike this:

  1. def default(self, o):
  2.    try:
  3.        iterable = iter(o)
  4.    except TypeError:
  5.        pass
  6.    else:
  7.        return list(iterable)
  8.    # Let the base class default method raise the TypeError
  9.    return json.JSONEncoder.default(self, o)
  • encode(o)
  • Return a JSON string representation of a Python data structure, o. Forexample:
  1. >>> json.JSONEncoder().encode({"foo": ["bar", "baz"]})
  2. '{"foo": ["bar", "baz"]}'
  • iterencode(o)
  • Encode the given object, o, and yield each string representation asavailable. For example:
  1. for chunk in json.JSONEncoder().iterencode(bigobject):
  2.     mysocket.write(chunk)

异常

  • exception json.JSONDecodeError(msg, doc, pos)

  • Subclass of ValueError with the following additional attributes:

    • msg

    • 未格式化的错误消息。

    • doc

    • The JSON document being parsed.

    • pos

    • The start index of doc where parsing failed.

    • lineno

    • The line corresponding to pos.

    • colno

    • The column corresponding to pos.

3.5 新版功能.

Standard Compliance and Interoperability

The JSON format is specified by RFC 7159 and byECMA-404.This section details this module's level of compliance with the RFC.For simplicity, JSONEncoder and JSONDecoder subclasses, andparameters other than those explicitly mentioned, are not considered.

This module does not comply with the RFC in a strict fashion, implementing someextensions that are valid JavaScript but not valid JSON. In particular:

  • Infinite and NaN number values are accepted and output;

  • Repeated names within an object are accepted, and only the value of the lastname-value pair is used.

Since the RFC permits RFC-compliant parsers to accept input texts that are notRFC-compliant, this module's deserializer is technically RFC-compliant underdefault settings.

Character Encodings

The RFC requires that JSON be represented using either UTF-8, UTF-16, orUTF-32, with UTF-8 being the recommended default for maximum interoperability.

As permitted, though not required, by the RFC, this module's serializer setsensure_ascii=True by default, thus escaping the output so that the resultingstrings only contain ASCII characters.

Other than the ensure_ascii parameter, this module is defined strictly interms of conversion between Python objects andUnicode strings, and thus does not otherwise directly addressthe issue of character encodings.

The RFC prohibits adding a byte order mark (BOM) to the start of a JSON text,and this module's serializer does not add a BOM to its output.The RFC permits, but does not require, JSON deserializers to ignore an initialBOM in their input. This module's deserializer raises a ValueErrorwhen an initial BOM is present.

The RFC does not explicitly forbid JSON strings which contain byte sequencesthat don't correspond to valid Unicode characters (e.g. unpaired UTF-16surrogates), but it does note that they may cause interoperability problems.By default, this module accepts and outputs (when present in the originalstr) code points for such sequences.

Infinite and NaN Number Values

The RFC does not permit the representation of infinite or NaN number values.Despite that, by default, this module accepts and outputs Infinity,-Infinity, and NaN as if they were valid JSON number literal values:

  1. >>> # Neither of these calls raises an exception, but the results are not valid JSON
  2. >>> json.dumps(float('-inf'))
  3. '-Infinity'
  4. >>> json.dumps(float('nan'))
  5. 'NaN'
  6. >>> # Same when deserializing
  7. >>> json.loads('-Infinity')
  8. -inf
  9. >>> json.loads('NaN')
  10. nan

In the serializer, the allow_nan parameter can be used to alter thisbehavior. In the deserializer, the parse_constant parameter can be used toalter this behavior.

Repeated Names Within an Object

The RFC specifies that the names within a JSON object should be unique, butdoes not mandate how repeated names in JSON objects should be handled. Bydefault, this module does not raise an exception; instead, it ignores all butthe last name-value pair for a given name:

  1. >>> weird_json = '{"x": 1, "x": 2, "x": 3}'
  2. >>> json.loads(weird_json)
  3. {'x': 3}

The object_pairs_hook parameter can be used to alter this behavior.

Top-level Non-Object, Non-Array Values

The old version of JSON specified by the obsolete RFC 4627 required thatthe top-level value of a JSON text must be either a JSON object or array(Python dict or list), and could not be a JSON null,boolean, number, or string value. RFC 7159 removed that restriction, andthis module does not and has never implemented that restriction in either itsserializer or its deserializer.

Regardless, for maximum interoperability, you may wish to voluntarily adhereto the restriction yourself.

Implementation Limitations

Some JSON deserializer implementations may set limits on:

  • the size of accepted JSON texts

  • the maximum level of nesting of JSON objects and arrays

  • the range and precision of JSON numbers

  • the content and maximum length of JSON strings

This module does not impose any such limits beyond those of the relevantPython datatypes themselves or the Python interpreter itself.

When serializing to JSON, beware any such limitations in applications that mayconsume your JSON. In particular, it is common for JSON numbers to bedeserialized into IEEE 754 double precision numbers and thus subject to thatrepresentation's range and precision limitations. This is especially relevantwhen serializing Python int values of extremely large magnitude, orwhen serializing instances of "exotic" numerical types such asdecimal.Decimal.

Command Line Interface

Source code:Lib/json/tool.py

The json.tool module provides a simple command line interface to validateand pretty-print JSON objects.

If the optional infile and outfile arguments are notspecified, sys.stdin and sys.stdout will be used respectively:

  1. $ echo '{"json": "obj"}' | python -m json.tool
  2. {
  3.     "json": "obj"
  4. }
  5. $ echo '{1.2:3.4}' | python -m json.tool
  6. Expecting property name enclosed in double quotes: line 1 column 2 (char 1)

在 3.5 版更改: The output is now in the same order as the input. Use the—sort-keys option to sort the output of dictionariesalphabetically by key.

Command line options

  • infile
  • The JSON file to be validated or pretty-printed:
  1. $ python -m json.tool mp_films.json
  2. [
  3.     {
  4.         "title": "And Now for Something Completely Different",
  5.         "year": 1971
  6.     },
  7.     {
  8.         "title": "Monty Python and the Holy Grail",
  9.         "year": 1975
  10.     }
  11. ]

If infile is not specified, read from sys.stdin.

  • outfile

  • Write the output of the infile to the given outfile. Otherwise, write itto sys.stdout.

  • —sort-keys

  • Sort the output of dictionaries alphabetically by key.

3.5 新版功能.

  • —json-lines
  • Parse every input line as separate JSON object.

3.8 新版功能.

  • -h, —help
  • Show the help message.

脚注

  • 1
  • As noted in the errata for RFC 7159,JSON permits literal U+2028 (LINE SEPARATOR) andU+2029 (PARAGRAPH SEPARATOR) characters in strings, whereas JavaScript(as of ECMAScript Edition 5.1) does not.