`json.md`

296 строк · 23.5 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.0/library/json.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `json` – JSON кодировщик и декодировщик89JSON (JavaScript Object Notation) \<[http://json.org](https://python-all.ru/3.0/library/json.html)\> – это подмножество синтаксиса JavaScript (ECMA-262, 3-е издание), используемое в качестве легковесного формата обмена данными.1011`json` предоставляет API, знакомый пользователям модулей стандартной библиотеки [`marshal`](https://python-all.ru/3.0/library/marshal.html#module-marshal) и [`pickle`](https://python-all.ru/3.0/library/pickle.html#module-pickle).1213Кодирование иерархий базовых объектов Python:1415```python16>>> import json17>>> json.dumps(['foo', {'bar': ('baz', None, 1.0, 2)}])18'["foo", {"bar": ["baz", null, 1.0, 2]}]'19>>> print(json.dumps("\"foo\bar"))20"\"foo\bar"21>>> print(json.dumps('\u1234'))22"\u1234"23>>> print(json.dumps('\\'))24"\\"25>>> print(json.dumps({"c": 0, "b": 0, "a": 0}, sort_keys=True))26{"a": 0, "b": 0, "c": 0}27>>> from io import StringIO28>>> io = StringIO()29>>> json.dump(['streaming API'], io)30>>> io.getvalue()31'["streaming API"]'32```3334Компактное кодирование:3536```python37>>> import json38>>> json.dumps([1,2,3,{'4': 5, '6': 7}], separators=(',',':'))39'[1,2,3,{"4":5,"6":7}]'40```4142Красивое форматирование:4344```python45>>> import json46>>> print(json.dumps({'4': 5, '6': 7}, sort_keys=True, indent=4))47{48    "4": 5,49    "6": 750}51```5253Декодирование JSON:5455```python56>>> import json57>>> json.loads('["foo", {"bar":["baz", null, 1.0, 2]}]')58['foo', {'bar': ['baz', None, 1.0, 2]}]59>>> json.loads('"\\"foo\\bar"')60'"foo\x08ar'61>>> from io import StringIO62>>> io = StringIO('["streaming API"]')63>>> json.load(io)64['streaming API']65```6667Специализированное декодирование объектов JSON:6869```python70>>> import json71>>> def as_complex(dct):72...     if '__complex__' in dct:73...         return complex(dct['real'], dct['imag'])74...     return dct75...76>>> json.loads('{"__complex__": true, "real": 1, "imag": 2}',77...     object_hook=as_complex)78(1+2j)79>>> import decimal80>>> json.loads('1.1', parse_float=decimal.Decimal)81Decimal('1.1')82```8384Расширение [`JSONEncoder`](https://python-all.ru/3.0/library/json.html#json.JSONEncoder):8586```python87>>> import json88>>> class ComplexEncoder(json.JSONEncoder):89...     def default(self, obj):90...         if isinstance(obj, complex):91...             return [obj.real, obj.imag]92...         return json.JSONEncoder.default(self, obj)93...94>>> dumps(2 + 1j, cls=ComplexEncoder)95'[2.0, 1.0]'96>>> ComplexEncoder().encode(2 + 1j)97'[2.0, 1.0]'98>>> list(ComplexEncoder().iterencode(2 + 1j))99['[', '2.0', ', ', '1.0', ']']100```101102Использование json.tool из командной оболочки для проверки и форматирования:103104```text105$ echo '{"json":"obj"}' | python -mjson.tool106{107    "json": "obj"108}109$ echo '{ 1.2:3.4}' | python -mjson.tool110Expecting property name: line 1 column 2 (char 2)111```112113> **Примечание**114>115> JSON, создаваемый стандартными настройками этого модуля, является подмножеством YAML, поэтому его также можно использовать в качестве сериализатора для YAML.116117## Основное использование118119#### `[json.dump]json.dump(obj, fp[, skipkeys[, ensure_ascii[, check_circular[, allow_nan[, cls[, indent[, separators[, encoding[, default[, **kw]]]]]]]]]])`120121Сериализует *obj* в поток в формате JSON и записывает его в *fp* (поддерживающий `.write()` объект, похожий на файл).122123Если *skipkeys* равно `True` (по умолчанию: `False`), то ключи словаря, не являющиеся базовыми типами ([`str`](https://python-all.ru/3.0/library/functions.html#str), `unicode`, [`int`](https://python-all.ru/3.0/library/functions.html#int), `long`, [`float`](https://python-all.ru/3.0/library/functions.html#float), [`bool`](https://python-all.ru/3.0/library/functions.html#bool), `None`) будут пропущены вместо возбуждения [`TypeError`](https://python-all.ru/3.0/library/exceptions.html#exceptions.TypeError).124125Если *ensure\_ascii* равно `False` (по умолчанию: `True`), то некоторые фрагменты, записанные в *fp*, могут быть экземплярами `unicode` в соответствии с обычными правилами приведения [`str`](https://python-all.ru/3.0/library/functions.html#str) к `unicode` в Python. Если `fp.write()` явно не поддерживает `unicode` (как, например, [`codecs.getwriter()`](https://python-all.ru/3.0/library/codecs.html#codecs.getwriter)), это скорее всего приведёт к ошибке.126127Если *check\_circular* равно `False` (по умолчанию: `True`), то проверка циклических ссылок для контейнерных типов будет пропущена, и циклическая ссылка приведет к [`OverflowError`](https://python-all.ru/3.0/library/exceptions.html#exceptions.OverflowError) (или хуже).128129Если *allow\_nan* равно `False` (по умолчанию: `True`), то сериализация значений [`float`](https://python-all.ru/3.0/library/functions.html#float) вне допустимого диапазона (`nan`, `inf`, `-inf`) будет вызывать [`ValueError`](https://python-all.ru/3.0/library/exceptions.html#exceptions.ValueError) в строгом соответствии со спецификацией JSON, вместо использования JavaScript-эквивалентов (`NaN`, `Infinity`, `-Infinity`).130131Если *indent* – неотрицательное целое число, то элементы массивов и члены объектов JSON будут выводиться с отступами этого уровня. Уровень отступа 0 будет вставлять только новые строки. `None` (по умолчанию) выбирает наиболее компактное представление.132133Если *separators* является кортежем `(item_separator, dict_separator)`, то он будет использоваться вместо разделителей по умолчанию `(', ', ': ')`. `(',', ':')` – это наиболее компактное представление JSON.134135*encoding* – это кодировка символов для экземпляров str, по умолчанию UTF-8.136137*default(obj)* – это функция, которая должна возвращать сериализуемую версию *obj* или возбуждать [`TypeError`](https://python-all.ru/3.0/library/exceptions.html#exceptions.TypeError). По умолчанию просто возбуждается [`TypeError`](https://python-all.ru/3.0/library/exceptions.html#exceptions.TypeError).138139Чтобы использовать пользовательский подкласс [`JSONEncoder`](https://python-all.ru/3.0/library/json.html#json.JSONEncoder) (например, переопределяющий метод `default()` для сериализации дополнительных типов), укажите его с помощью аргумента *cls*.140141#### `[json.dumps]json.dumps(obj[, skipkeys[, ensure_ascii[, check_circular[, allow_nan[, cls[, indent[, separators[, encoding[, default[, **kw]]]]]]]]]])`142143Сериализует *obj* в строку [`str`](https://python-all.ru/3.0/library/functions.html#str) в формате JSON.144145Если *ensure\_ascii* равно `False`, то возвращаемое значение будет экземпляром `unicode`. Остальные аргументы имеют тот же смысл, что и в [`dump()`](https://python-all.ru/3.0/library/json.html#json.dump).146147#### `[json.load]json.load(fp[, encoding[, cls[, object_hook[, parse_float[, parse_int[, parse_constant[, **kw]]]]]]])`148149Десериализует *fp* (объект, похожий на файл, поддерживающий `.read()` и содержащий JSON-документ) в объект Python.150151Если содержимое *fp* закодировано в ASCII-совместимой кодировке, отличной от UTF-8 (например, latin-1), необходимо указать соответствующее имя *encoding*. Кодировки, не основанные на ASCII (такие как UCS-2), не допускаются, и их следует обернуть с помощью `codecs.getreader(fp)(encoding)`, или просто декодировать в объект `unicode` и передать в [`loads()`](https://python-all.ru/3.0/library/json.html#json.loads).152153*object\_hook* – это необязательная функция, которая будет вызвана с результатом декодирования любого объектного литерала ([`dict`](https://python-all.ru/3.0/library/stdtypes.html#dict)). Возвращаемое значение *object\_hook* будет использоваться вместо [`dict`](https://python-all.ru/3.0/library/stdtypes.html#dict). Эта возможность может использоваться для реализации пользовательских декодировщиков (например, подсказки классов JSON-RPC).154155*parse\_float*, если указан, будет вызван со строкой каждого декодируемого JSON-числа с плавающей точкой. По умолчанию это эквивалентно `float(num_str)`. Это можно использовать для применения другого типа данных или парсера для JSON чисел с плавающей точкой (например, [`decimal.Decimal`](https://python-all.ru/3.0/library/decimal.html#decimal.Decimal)).156157*parse\_int*, если указан, будет вызван со строкой каждого декодируемого JSON-целого числа. По умолчанию это эквивалентно `int(num_str)`. Это можно использовать для применения другого типа данных или парсера для JSON целых чисел (например, [`float`](https://python-all.ru/3.0/library/functions.html#float)).158159*parse\_constant*, если указан, будет вызван с одной из следующих строк: `'-Infinity'`, `'Infinity'`, `'NaN'`, `'null'`, `'true'`, `'false'`. Это может быть использовано для возбуждения исключения при обнаружении недопустимых JSON чисел.160161Чтобы использовать пользовательский подкласс [`JSONDecoder`](https://python-all.ru/3.0/library/json.html#json.JSONDecoder), укажите его с помощью аргумента `cls` именованный аргумент. Дополнительные именованные аргументы будут переданы конструктору класса.162163#### `[json.loads]json.loads(s[, encoding[, cls[, object_hook[, parse_float[, parse_int[, parse_constant[, **kw]]]]]]])`164165Десериализует *s* (экземпляр [`str`](https://python-all.ru/3.0/library/functions.html#str) или `unicode`, содержащий JSON- документ) в объект Python.166167Если *s* является экземпляром [`str`](https://python-all.ru/3.0/library/functions.html#str) и закодирован в ASCII-совместимой кодировке, отличной от UTF-8 (например, latin-1), необходимо указать соответствующее имя *encoding*. Кодировки, не основанные на ASCII (такие как UCS-2), не допускаются и должны быть сначала декодированы в `unicode`.168169Остальные аргументы имеют тот же смысл, что и в [`dump()`](https://python-all.ru/3.0/library/json.html#json.dump).170171## Кодировщики и декодировщики172173#### `[json.JSONDecoder]class json.JSONDecoder([encoding[, object_hook[, parse_float[, parse_int[, parse_constant[, strict]]]]]])`174175Простой JSON-декодер.176177По умолчанию выполняет следующие преобразования при декодировании:178179| JSON | Python |180| --- | --- |181| объект | dict |182| массив | список |183| строка | unicode |184| число (int) | int, long |185| число (вещественное) | float |186| истина | True |187| ложь | False |188| null | None |189190Он также понимает `NaN`, `Infinity` и `-Infinity` как соответствующие значения `float`, что выходит за рамки спецификации JSON.191192*encoding* определяет кодировку, используемую для интерпретации любых объектов [`str`](https://python-all.ru/3.0/library/functions.html#str), декодированных этим экземпляром (по умолчанию UTF-8). Он не влияет на декодирование объектов `unicode`.193194Обратите внимание, что сейчас работают только кодировки, являющиеся надмножеством ASCII. Строки других кодировок нужно передавать как `unicode`.195196*object\_hook*, если указан, будет вызван с результатом декодирования каждого JSON-объекта, и его возвращаемое значение будет использовано вместо переданного [`dict`](https://python-all.ru/3.0/library/stdtypes.html#dict). Это может быть использовано для предоставления пользовательских десериализаций (например, для поддержки JSON-RPC подсказок классов).197198*parse\_float*, если указан, будет вызван со строкой каждого декодируемого JSON-числа с плавающей точкой. По умолчанию это эквивалентно `float(num_str)`. Это можно использовать для применения другого типа данных или парсера для JSON чисел с плавающей точкой (например, [`decimal.Decimal`](https://python-all.ru/3.0/library/decimal.html#decimal.Decimal)).199200*parse\_int*, если указан, будет вызван со строкой каждого декодируемого JSON-целого числа. По умолчанию это эквивалентно `int(num_str)`. Это можно использовать для применения другого типа данных или парсера для JSON целых чисел (например, [`float`](https://python-all.ru/3.0/library/functions.html#float)).201202*parse\_constant*, если указан, будет вызван с одной из следующих строк: `'-Infinity'`, `'Infinity'`, `'NaN'`, `'null'`, `'true'`, `'false'`. Это может быть использовано для возбуждения исключения при обнаружении недопустимых JSON чисел.203204#### `[json.JSONDecoder.decode]decode(s)`205206Возвращает Python-представление207208*s*209210(экземпляра211212[`str`](https://python-all.ru/3.0/library/functions.html#str)213214или215216`unicode`217218, содержащего документ JSON).219220#### `[json.JSONDecoder.raw_decode]raw_decode(s)`221222Декодирует документ JSON из *s* ([`str`](https://python-all.ru/3.0/library/functions.html#str) или `unicode`, начинающегося с документа JSON) и возвращает кортеж из двух элементов: представление Python и индекс в *s*, по которому заканчивается документ.223224Это можно использовать для декодирования JSON-документа из строки, в конце которой могут быть лишние данные.225226#### `[json.JSONEncoder]class json.JSONEncoder([skipkeys[, ensure_ascii[, check_circular[, allow_nan[, sort_keys[, indent[, separators[, encoding[, default]]]]]]]]])`227228Расширяемый JSON-кодировщик для структур данных Python.229230По умолчанию поддерживает следующие объекты и типы:231232| Python | JSON |233| --- | --- |234| dict | объект |235| list, tuple | массив |236| str, unicode | строка |237| int, long, float | число |238| True | истина |239| False | ложь |240| None | null |241242Чтобы расширить это для распознавания других объектов, создайте подкласс и реализуйте метод [`default()`](https://python-all.ru/3.0/library/json.html#json.JSONEncoder.default): с помощью другого метода он должен возвращать сериализуемый объект для `o`, если это возможно; в противном случае следует вызвать реализацию суперкласса (чтобы возбудить [`TypeError`](https://python-all.ru/3.0/library/exceptions.html#exceptions.TypeError)).243244Если *skipkeys* равен `False` (по умолчанию), то попытка кодировать ключи, не являющиеся str, int, long, float или None, приводит к [`TypeError`](https://python-all.ru/3.0/library/exceptions.html#exceptions.TypeError). Если *skipkeys* равен `True`, такие элементы просто пропускаются.245246Если *ensure\_ascii* равен `True` (по умолчанию), результат гарантированно будет объектом [`str`](https://python-all.ru/3.0/library/functions.html#str) со всеми входящими символами unicode, экранированными. Если *ensure\_ascii* равен `False`, результатом будет объект unicode.247248Если *check\_circular* равен `True` (по умолчанию), то списки, словари и пользовательские кодированные объекты будут проверяться на циклические ссылки во время кодирования, чтобы предотвратить бесконечную рекурсию (которая привела бы к [`OverflowError`](https://python-all.ru/3.0/library/exceptions.html#exceptions.OverflowError)). В противном случае такая проверка не производится.249250Если *allow\_nan* равен `True` (по умолчанию), то `NaN`, `Infinity` и `-Infinity` будут кодироваться как есть. Это поведение не соответствует спецификации JSON, но согласовано с большинством кодировщиков и декодировщиков на JavaScript. В противном случае кодирование таких чисел с плавающей точкой приведёт к [`ValueError`](https://python-all.ru/3.0/library/exceptions.html#exceptions.ValueError).251252Если *sort\_keys* равен `True` (по умолчанию), то вывод словарей будет отсортирован по ключам; это полезно для регрессионных тестов, чтобы обеспечить возможность сравнивать JSON-сериализации на постоянной основе.253254Если *indent* – неотрицательное целое число (по умолчанию оно равно `None`), то элементы JSON-массива и члены объекта будут выводиться с форматированием и отступами этого уровня. Уровень отступа 0 будет только вставлять новые строки. `None` – это наиболее компактное представление.255256Если указано, *separators* должны быть кортежем вида `(item_separator, key_separator)`. По умолчанию – `(', ', ': ')`. Чтобы получить наиболее компактное представление JSON, укажите `(',', ':')`, чтобы убрать пробелы.257258Если указан, *default* – это функция, которая вызывается для объектов, которые иначе не могут быть сериализованы. Она должна возвращать версию объекта, пригодную для кодирования в JSON, или возбуждать [`TypeError`](https://python-all.ru/3.0/library/exceptions.html#exceptions.TypeError).259260Если *encoding* не равен `None`, то все входные строки будут преобразованы в unicode с использованием этой кодировки перед JSON-кодированием. По умолчанию – UTF-8.261262#### `[json.JSONEncoder.default]default(o)`263264Реализуйте этот метод в подклассе так, чтобы он возвращал сериализуемый объект для *o* или вызывал базовую реализацию (чтобы возбудить [`TypeError`](https://python-all.ru/3.0/library/exceptions.html#exceptions.TypeError)).265266Например, чтобы поддерживать произвольные итераторы, можно реализовать default следующим образом:267268```python269def default(self, o):270   try:271       iterable = iter(o)272   except TypeError:273       pass274   else:275       return list(iterable)276   return JSONEncoder.default(self, o)277```278279#### `[json.JSONEncoder.encode]encode(o)`280281Возвращает строковое представление структуры данных Python в формате JSON, *o*. Например:282283```python284>>> JSONEncoder().encode({"foo": ["bar", "baz"]})285'{"foo": ["bar", "baz"]}'286```287288#### `[json.JSONEncoder.iterencode]iterencode(o)`289290Кодирует заданный объект *o* и выдаёт каждое строковое представление по мере готовности. Например:291292```python293for chunk in JSONEncoder().iterencode(bigobject):294    mysocket.write(chunk)295```296