№23 Модуль JSON / Уроки по Python для начинающих
JSON является синтаксисом для хранения и обмена данными. JSON — это текст, написанный в стиле объекта JavaScript.
JSON в Python
Конвертация из JSON в Python
Конвертировать из Python в JSON
Вы можете преобразовать следующие типов объекты Python в строки JSON:
Конвертируем объекты Python в строки JSON и выведите значения:
Когда вы конвертируете из Python в JSON, объекты Python преобразуются в эквивалент JSON:
| Python | JSON |
|---|---|
| dict | Object |
| list | Array |
| tuple | Array |
| str | String |
| int | Number |
| float | Number |
| True | true |
| False | false |
| None | null |
Конвертируйте объект Python, содержащий все типы конвертируемых данных:
Как конвертировать кириллицу
Если в данных Python есть символы кириллицы, метод json.dumps() преобразует их с кодировкой по умолчанию. Что бы сохранить кириллицу используйте параметр ensure_ascii=False
Форматирование результата
В приведенном выше примере выводится строка JSON, но читать ее не так просто, без отступов и переносов строк.
У метода json.dumps() есть параметры, облегчающие чтение результата.
Используем параметр indent для определения количества отступов:
JSON (JavaScript Object Notation-формат передачи данных), определен стандартом RFC 7159 (который вытекает из устаревшей версии RFC 4627) и ECMA-404, легким текстовым форматом обмена данных, основанным на синтаксисе литералов объекта JavaScript (хотя он и не является подгруппой JavaScript).
json предоставляет API, знакомый пользователям стандартных библиотечных модулей marshal и pickle.
Преобразование базовых объектов в Python в json:
Декодирование JSON, преобразование json в объект Python:
Специализированное декодирование объектов в JSON:
Рекомендуется использование json.tool для проверки и красивого вывода:
JSON является подмножеством YAML 1.2 JSON создан с помощью стандартных настроек этого модуля и также является подмножеством YAML 1.0 and 1.1. Этот модуль может использоваться в качестве сериализатора YAML.
До Python 3.7 порядок ключей словаря не сохранялся, поэтому входные и выходные данные, как правило, отличались. Начиная с Python 3.7, порядок ключей стал сохраняться, поэтому больше нет необходимости использовать collections.OrderedDict для парсинга JSON.
Основные методы
Метод json dump
Когда check_circular=False (по умолчанию: True ), тогда проверка циклических ссылок для типов контейнера будет пропущена, а такие ссылки будут вызывать OverflowError (или ошибку серьёзнее).
Изменения в версии 3.2: Допускаются строки для отступа в дополнение к целым числам.
Если sort_keys=True (по умолчанию: False ), ключи выводимого словаря будут отсортированы.
Метод json dumps
Метод json load
Метод json loads
Кодировщики и декодировщики
JSONDecoder
Класс 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 |
| number (int) | int |
| number (real) | float |
| true | True |
| false | False |
| null | None |
decode(s)
Возвращает представление s в Python ( str — содержащий документ JSON). JSONDecodeError будет вызвана, если документ JSON не валидный (или не действительный).
JSONEncoder
Класс json.JSONEncoder (*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)
Расширяемый кодировщик JSON для структур данных Python.
Поддерживает следующие типы данных и объекты по умолчанию:
| Python | JSON |
|---|---|
| dict | object |
| list, tuple | array |
| str | string |
| int, float | number |
| True | true |
| False | false |
| None | null |
Если check_circular=True (по умолчанию), тогда списки, словари и самостоятельно закодированные объекты будут проверяться на циклические ссылки во время кодировки, чтобы предотвратить бесконечную рекурсию (что вызовет OverflowError ). В другом случае, такая проверка не выполняется.
Если sort_keys=True (по умолчанию: False ), выводимый словарь будет отсортирован по именам ключей; это полезно для регрессивного тестирования, чтобы сравнивать сериализацию JSON ежедневно.
default(o)
Внедрите этот метод в подкласс таким образом, чтобы он возвращал сериализуемый объект для o или вызывал базовую реализацию (для повышения TypeError ).
Например, чтобы поддерживать произвольные итераторы, вы можете реализовать default следующим образом:
Модуль json в Python, работа с JSON форматом.
Чтение и парсинг json формата, запись данных в файл.
Информация в формате JSON может быть представлена в двух видах:
Примечания:
Стандартное соответствие и совместимость:
Этот модуль НЕ строго соответствует RFC, реализуя некоторые расширения, которые являются допустимым JavaScript, но не допустимым JSON.
Поскольку RFC позволяет RFC-совместимым синтаксическим анализаторам принимать входные тексты, не соответствующие RFC, десериализатор этого модуля технически RFC-совместим при настройках по умолчанию.
Бесконечные числовые значения и NaN :
Повторяющиеся имена внутри объекта:
RFC указывает, что имена в объекте JSON должны быть уникальными и не повторятся, но не предписывает, как они должны обрабатываться в объектах JSON. По умолчанию этот модуль json не вызывает исключение, вместо этого он игнорирует все, кроме последней пары имя-значение для данного имени:
Параметр object_pairs_hook можно использовать для изменения этого поведения.
Кодировки символов:
RFC требует, чтобы JSON был представлен с использованием UTF-8, UTF-16 или UTF-32, при этом UTF-8 является рекомендуемым значением по умолчанию для максимальной совместимости.
RFC явно не запрещает строки JSON, которые содержат последовательности байтов, которые не соответствуют действительным символам Unicode, например непарные суррогаты UTF-16, но отмечает, что они могут вызывать проблемы взаимодействия. По умолчанию этот модуль принимает и выводит, если присутствует в исходной строке, кодовые точки для таких последовательностей.
Работа с файлами в формате JSON¶
JSON по синтаксису очень похож на Python и достаточно удобен для восприятия.
Как и в случае с CSV, в Python есть модуль, который позволяет легко записывать и читать данные в формате JSON.
Чтение¶
Для чтения в модуле json есть два метода:
json.load ¶
Чтение файла в формате JSON в объект Python (файл json_read_load.py):
json.loads ¶
Считывание строки в формате JSON в объект Python (файл json_read_loads.py):
Результат будет аналогичен предыдущему выводу.
Запись¶
Запись файла в формате JSON также осуществляется достаточно легко.
Для записи информации в формате JSON в модуле json также два метода:
json.dumps ¶
Преобразование объекта в строку в формате JSON (json_write_dumps.py):
Метод json.dumps подходит для ситуаций, когда надо вернуть строку в формате JSON. Например, чтобы передать ее API.
json.dump ¶
Запись объекта Python в файл в формате JSON (файл json_write_dump.py):
Когда нужно записать информацию в формате JSON в файл, лучше использовать метод dump.
Дополнительные параметры методов записи¶
Методам dump и dumps можно передавать дополнительные параметры для управления форматом вывода.
По умолчанию эти методы записывают информацию в компактном представлении. Как правило, когда данные используются другими программами, визуальное представление данных не важно. Если же данные в файле нужно будет считать человеку, такой формат не очень удобно воспринимать.
К счастью, модуль json позволяет управлять подобными вещами.
Передав дополнительные параметры методу dump (или методу dumps), можно получить более удобный для чтения вывод (файл json_write_indent.py):
Теперь содержимое файла sw_templates.json выглядит так:
Изменение типа данных¶
Еще один важный аспект преобразования данных в формат JSON: данные не всегда будут того же типа, что исходные данные в Python.
Например, кортежи при записи в JSON превращаются в списки:
Так происходит из-за того, что в JSON используются другие типы данных и не для всех типов данных Python есть соответствия.
Таблица конвертации данных Python в JSON:
| Python | JSON |
|---|---|
| dict | object |
| list, tuple | array |
| str | string |
| int, float | number |
| True | true |
| False | false |
| None | null |
Таблица конвертации JSON в данные Python:
| JSON | Python |
|---|---|
| object | dict |
| array | list |
| string | str |
| number (int) | int |
| number (real) | float |
| true | True |
| false | False |
| null | None |
Ограничение по типам данных¶
С помощью дополнительного параметра можно игнорировать подобные ключи:
Кроме того, в JSON ключами словаря могут быть только строки. Но, если в словаре Python использовались числа, ошибки не будет. Вместо этого выполнится конвертация чисел в строки:
Работа с модулем JSON в Python
Python предоставляет модуль под названием JSON.
Что такое JSON в Python?
JSON в Python обозначает JavaScript Object Notation, который является широко используемым форматом данных для обмена данными в Интернете. JSON – идеальный формат для организации передачи данных между клиентом и сервером. Его синтаксис аналогичен языку программирования JavaScript.
Основная цель JSON – передавать данные между клиентом и веб-сервером. Это простой в освоении и наиболее эффективный способ обмена данными. Его можно использовать с различными языками программирования, такими как Python, Perl, Java и т. д.
JSON в основном поддерживает 6 типов данных в JavaScript:
JSON построен на двух структурах:
Представление данных JSON похоже на словарь Python. Ниже приведен пример данных JSON:
Работа с Python JSON
Python поддерживает стандартную библиотеку marshal и pickle module, а JSON API ведет себя аналогично этой библиотеке. Python изначально поддерживает функции JSON.
Кодирование данных JSON называется сериализацией. Сериализация – это метод, при котором данные преобразуются в последовательности байтов и передаются по сети. Десериализация – это процесс, обратный декодированию данных, преобразованных в формат JSON. Этот модуль включает в себя множество встроенных функций.
Давайте посмотрим на эти функции:
В этом разделе мы изучим следующие методы:
Сериализация JSON
Сериализация – это метод преобразования объектов Python в JSON. Иногда компьютеру требуется обработать большой объем информации, поэтому рекомендуется сохранить эту информацию в файле. Мы можем хранить данные JSON в файле с помощью функции JSON. Модуль json предоставляет методы dump() и dumps(), которые используются для преобразования объекта Python.
Объекты Python преобразуются в следующие объекты JSON. Список приведен ниже:
| Объекты Python | JSON | |
|---|---|---|
| 1. | Dict | Object |
| 2. | list, tuple | Array |
| 3. | Str | String |
| 4. | int, float | Number |
| 5. | True | true |
| 6. | False | false |
| 7. | None | null |
Функция dump()
Python предоставляет функцию dump() для передачи (кодирования) данных в формате JSON, осуществляет запись данных JSON в файл. Она принимает два позиционных аргумента: первый – это объект данных, который нужно сериализовать, а второй – файловый объект, в который должны быть записаны байты.
Рассмотрим простой пример сериализации:
В приведенной выше программе мы открыли файл с именем data.json в режиме записи. Мы использовали режим записи потому что если файл не существует, он будет создан. Метод json.dump() преобразует словарь в строку JSON.
Функция dumps()
Функция dumps() используется для хранения сериализованных данных в файле Python. Она принимает только один аргумент, который представляет собой данные Python для сериализации. Файловый аргумент не используется, потому что мы не записываем данные на диск. Рассмотрим следующий пример:
JSON поддерживает примитивные типы данных, такие как строки и числа, а также вложенные списки, кортежи и объекты.
Десериализация JSON
Десериализация – это процесс декодирования данных JSON в объекты Python. Модуль json предоставляет два метода load() и loads(), которые используются для преобразования данных JSON в фактическую объектную форму Python. Список приведен ниже:
| JSON | Python | |
|---|---|---|
| 1. | Object | Dict |
| 2. | Array | list |
| 3. | String | str |
| 4. | Number (int) | int |
| 5. | true | True |
| 6. | false | False |
| 7. | null | None |
В приведенной выше таблице показано обратное преобразование сериализованной таблицы, но технически это не идеальное преобразование данных JSON. Это означает, что если мы кодируем объект и снова декодируем его через некоторое время; мы не можем вернуть тот же объект.
Давайте возьмем реальный пример: один человек переводит что-то на китайский язык, а другой переводит обратно на английский, и это может быть неточно переведено. Рассмотрим простой пример:
Функция load()
Функция load() используется для десериализации данных JSON в объект Python из файла. Рассмотрим следующий пример:
В приведенной выше программе мы закодировали объект Python в файле с помощью функции dump(). После этого мы читаем файл JSON с помощью функции load(), где в качестве аргумента мы передали read_file.
Модуль json также предоставляет функцию loads(), которая используется для преобразования данных JSON в объект Python. Она очень похожа на функцию load(). Рассмотрим следующий пример:
Сравнение json.load() и json.loads()
Функция json.load() используется для загрузки файла JSON, тогда как функция json.loads() используется для загрузки строки.
Сравнение json.dump() и json.dumps()
Функция json.dump() используется, когда мы хотим сериализовать объекты Python в файл JSON, а функция json.dumps() используется для преобразования данных JSON в виде строки для анализа и печати.
Python Pretty Print JSON
Иногда нам нужно проанализировать и отладить большой объем данных JSON. Это можно сделать, передав дополнительные аргументы indent и sort_keys в методы json.dumps() и json.dump().
Примечание: обе функции dump() и dumps() принимают аргументы indent и short_keys.
Рассмотрим следующий пример:
В приведенном выше коде мы предоставили 5 пробелов для аргумента отступа, а ключи отсортированы в порядке возрастания. Значение по умолчанию для отступа – Нет, а значение по умолчанию для sort_key – False.
Кодирование и декодирование
Кодирование – это метод преобразования текста или значений в зашифрованную форму. Зашифрованные данные может использовать только предпочтительный пользователь путем их декодирования. Кодирование также называется сериализацией, а декодирование также называется десериализацией. Кодирование и декодирование выполняются для формата JSON (объект). Python предоставляет популярный пакет для таких операций. Мы можем установить его в Windows с помощью следующей команды:
Кодирование – пакет demjson предоставляет функцию encode(), которая используется для преобразования объекта Python в строковое представление JSON. Синтаксис приведен ниже:
1 – Кодирование с использованием пакета demjson:
2 – Декодирование. Модуль demjson предоставляет функцию decode(), которая используется для преобразования объекта JSON в тип формата Python. Синтаксис приведен ниже:
В этом руководстве мы узнали о Python JSON – наиболее эффективном способе передачи данных между клиентом и веб-сервером.
