jsonlib 1.6.1
John Millikin Copyright : This document has been placed in the public domain.
Overview
JSON is a lightweight data-interchange format. It is often used for exchanging data between a web server and user agent.
This module aims to produce a library for serializing and deserializing JSON that conforms strictly to RFC 4627.
For the Python 3 version of jsonlib, see jsonlib-python3.
Other JSON implementations of interest include simplejson (available in the standard library as of Python 2.6) and demjson.
Usage
jsonlib has two functions of interest, read and write . It also defines some exception: ReadError , WriteError , and UnknownSerializerError .
For compatibility with the standard library, read is aliased to loads and write is aliased to dumps . They do not have the same set of advanced parameters, but may be used interchangeably for simple invocations.
Deserialization
To deserialize a JSON expression, call the jsonlib.read function with an instance of unicode or bytes .
>>> import jsonlib >>> jsonlib.read (b'["Hello world!"]') [u'Hello world!']
Floating-point values
By default, jsonlib will parse values such as “1.1” into an instance of decimal.Decimal . To use the built-in value type float instead, set the use_float parameter to True . float values are much faster to construct, so this flag may substantially increase parser performance.
Please note that using float will cause a loss of precision when parsing some values.
>>> jsonlib.read ('[3.14159265358979323846]', use_float = True) [3.1415926535897931]
Serialization
Serialization has more options, but they are set to reasonable defaults. The simplest use is to call jsonlib.write with a Python value.
>>> import jsonlib >>> jsonlib.write (['Hello world!']) '["Hello world!"]'
Pretty-Printing
To “pretty-print” the output, pass a value for the indent parameter.
>>> print (jsonlib.write (['Hello world!'], indent = ' ').decode ('utf8')) [ "Hello world!" ] >>>
Mapping Key Sorting
By default, mapping keys are serialized in whatever order they are stored by Python. To force a consistent ordering (for example, in doctests) use the sort_keys parameter.
>>> jsonlib.write () '' >>> jsonlib.write (, sort_keys = True) ''
Encoding and Unicode
By default, the output is encoded in UTF-8. If you require a different encoding, pass the name of a Python codec as the encoding parameter.
>>> jsonlib.write (['Hello world!'], encoding = 'utf-16-be') '\x00[\x00"\x00H\x00e\x00l\x00l\x00o\x00 \x00w\x00o\x00r\x00l\x00d\x00!\x00"\x00]'
To retrieve an unencoded unicode instance, pass None for the encoding.
>>> jsonlib.write (['Hello world!'], encoding = None) u'["Hello world!"]'
By default, non-ASCII codepoints are forbidden in the output. To include higher codepoints in the output, set ascii_only to False .
>>> jsonlib.write ([u'Hello \u266a'], encoding = None) u'["Hello \\u266a"]' >>> jsonlib.write ([u'Hello \u266a'], encoding = None, ascii_only = False) u'["Hello \u266a"]'
Mapping Key Coercion
Because JSON objects must have string keys, an exception will be raised when non-string keys are encountered in a mapping. It can be useful to coerce mapping keys to strings, so the coerce_keys parameter is available.
>>> jsonlib.write () Traceback (most recent call last): WriteError: Only strings may be used as object keys. >>> jsonlib.write (, coerce_keys = True) ''
Serializing Other Types
If the object implements the iterator or mapping protocol, it will be handled automatically. If the object is intended for use as a basic value, it should subclass one of the supported basic values.
String-like objects that do not inherit from unicode or UserString.UserString will likely be serialized as a list. This will not be changed. If iterating them returns an instance of the same type, the serializer might crash. This (hopefully) will be changed.
To serialize a type not known to jsonlib, use the on_unknown parameter to write :
>>> from datetime import date >>> def unknown_handler (value): . if isinstance (value, date): . return str (value) . raise jsonlib.UnknownSerializerError >>> jsonlib.write ([date (2000, 1, 1)], on_unknown = unknown_handler) '["2000-01-01"]'
Streaming Serializer
When serializing large objects, the use of an in-memory buffer may cause too much memory to be used. For these situations, use the dump function to write objects to a file-like object:
>>> import sys >>> jsonlib.dump (["Written to stdout"], sys.stdout, encoding = None) ["Written to stdout"] >>> with open ("/dev/null", "wb") as out: . jsonlib.dump (["Written to a file"], out) >>>
Exceptions
ReadError
Raised by read if an error was encountered parsing the expression. Will contain the line, column, and character position of the error.
Note that this will report the character, not the byte, of the character that caused the error.
WriteError
Raised by write or dump if an error was encountered serializing the passed value.
UnknownSerializerError
A subclass of WriteError that is raised when a value cannot be serialized. See the on_unknown parameter to write .
Change Log
1.6.1
- Fixed error in write() which could cause output truncation.
1.6
- Performance improvements
- coerce_keys no longer attempts to determine the “JSON” format for a coerced value – it will simply call unicode() .
Модуль для прямого импорта JSON в Python
Вы когда-нибудь просыпались ночью в поту и чувствовали непреодолимое желание брать и импортировать JSON-файлы так, как будто это обычные Python-модули? Теперь это возможно!
Модуль json-sempai позволяет вам написать вот такое безобразие, и оно будет работать:
import some_json_file
и если some_json_file.json существует и доступен, то он подключится так, как будто это обычный Python-модуль.
Использование
Создайте файл tester.json где-нибудь в доступном для Python месте:
Теперь импортируйте jsonsempai и ваш json-файл:
>>> from jsonsempai import magic >>> import tester >>> tester >>> tester.hello u'world' >>> tester.this.can.be u'nested' >>> Можно также использовать контекстный менеджер:
>>> import jsonsempai >>> with jsonsempai.imports(): . import tester >>> tester
Python-пакеты тоже поддерживаются:
$ tree . └── python_package ├── file.json ├── __init__.py └── nested_package ├── __init__.py └── second.json >>> from jsonsempai import magic >>> from python_package import file >>> file >>> import python_package.nested_package.second >>> python_package.nested_package.second Установка
Можно установить через pip:
$ pip install json-sempai
Или клонировать репозиторий и собрать из исходников:
$ python setup.py install
Чтобы удалить этот ужас с вашего компьютера:
$ pip uninstall json-sempai
Отказ от ответственности
На самом деле всё это пример плохого дизайна и лучше никогда так не делайте. Ну разве что только если вы очень ненавидите всех людей вокруг, и, в особенности, своих коллег разработчиков.
Следите за новыми постами по любимым темам
Подпишитесь на интересующие вас теги, чтобы следить за новыми постами и быть в курсе событий.
Работа с JSON-файлами в Python
Бывает такое, что при открытии файлов в них оказываются данные, очень похожие на словари и списки. Или наоборот, вы хотите записать в файл словарь, но не знаете как это сделать. На помощь приходит стандартный модуль json .
JSON — текстовый формат данных, очень похожий на словари и списки. Изначально он пришёл из JavaScript, но сейчас используется повсеместно. Хоть данные и похожи на словари и списки, в файл записан обычный текст. Чтобы превратить его в словари и списки нужна библиотека json .
Прочитать JSON
Пусть есть файл capitals.json с очень похожим на словарь содержимым:
"Россия": "Москва", "Беларусь": "Минск", "Казахстан": "Нур-Султан" > Простое открытие этого файла выглядит так:
with open("capitals.json", "r") as my_file: capitals = my_file.read() Проблема в том, что в capitals будет лежать не словарь, а строка. Если попытаться достать значение по ключу, то случится ошибка:
print(capitals["Россия"]) Traceback (most recent call last): File "", line 1, in module> TypeError: string indices must be integers Чтобы превратить строку в словарь понадобится модуль json . Его не нужно дополнительно устанавливать, он входит в стандартный набор библиотек:
import json with open("capitals.json", "r") as my_file: capitals_json = my_file.read() capitals = json.loads(capitals_json) Функция json.loads взяла строку capitals_json и на основе её данных сделала словарь. Теперь в capitals лежит не строка, а словарь:
print(capitals["Россия"]) # Москва «Девман» — авторская методика обучения программированию на Python. Готовим к работе крутых программистов.
Запись в файл
Если же вам нужно сохранить в файл словарь или список, то это тоже можно легко сделать, по аналогии. Сначала из словаря сделаем строку, затем сохраним её в файл:
import json capitals = "Россия": "Москва", "Беларусь": "Минск", "Казахстан": "Нур-Султан" > capitals_json = json.dumps(capitals) with open("capitals.json", "w") as my_file: my_file.write(capitals_json) Читайте дальше
Попробуйте бесплатные уроки по Python
Получите крутое код-ревью от практикующих программистов с разбором ошибок и рекомендациями, на что обратить внимание — бесплатно.
Переходите на страницу учебных модулей «Девмана» и выбирайте тему.
Модуль json
JSON (JavaScript Object Notation) — простой формат обмена данными, основанный на подмножестве синтаксиса JavaScript. Модуль json позволяет кодировать и декодировать данные в удобном формате.
Кодирование основных объектов Python:
Декодирование (парсинг) JSON:
]'] 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) - сериализует obj как форматированный JSON поток в fp.
Если skipkeys = True, то ключи словаря не базового типа (str, unicode, int, long, float, bool, None) будут проигнорированы, вместо того, чтобы вызывать исключение TypeError.
Если ensure_ascii = True, все не-ASCII символы в выводе будут экранированы последовательностями \uXXXX, и результатом будет строка, содержащая только ASCII символы. Если ensure_ascii = False, строки запишутся как есть.
Если check_circular = False, то проверка циклических ссылок будет пропущена, а такие ссылки будут вызывать OverflowError.
Если allow_nan = False, при попытке сериализовать значение с запятой, выходящее за допустимые пределы, будет вызываться ValueError (nan, inf, -inf) в строгом соответствии со спецификацией JSON, вместо того, чтобы использовать эквиваленты из JavaScript (NaN, Infinity, -Infinity).
Если indent является неотрицательным числом, то массивы и объекты в JSON будут выводиться с этим уровнем отступа. Если уровень отступа 0, отрицательный или "", то вместо этого будут просто использоваться новые строки. Значение по умолчанию None отражает наиболее компактное представление. Если indent - строка, то она и будет использоваться в качестве отступа.
Если sort_keys = True, то ключи выводимого словаря будут отсортированы.
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-формата.
Аргументы имеют то же значение, что и для dump().
Ключи в парах ключ/значение в JSON всегда являются строками. Когда словарь конвертируется в JSON, все ключи словаря преобразовываются в строки. В результате этого, если словарь сначала преобразовать в JSON, а потом обратно в словарь, то можно не получить словарь, идентичный исходному. Другими словами, loads(dumps(x)) != x, если x имеет нестроковые ключи.
json.load(fp, cls=None, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, object_pairs_hook=None, **kw) - десериализует JSON из fp.
object_hook - опциональная функция, которая применяется к результату декодирования объекта (dict). Использоваться будет значение, возвращаемое этой функцией, а не полученный словарь.
object_pairs_hook - опциональная функция, которая применяется к результату декодирования объекта с определённой последовательностью пар ключ/значение. Будет использован результат, возвращаемый функцией, вместо исходного словаря. Если задан так же object_hook, то приоритет отдаётся object_pairs_hook.
parse_float, если определён, будет вызван для каждого значения JSON с плавающей точкой. По умолчанию, это эквивалентно float(num_str).
parse_int, если определён, будет вызван для строки JSON с числовым значением. По умолчанию эквивалентно int(num_str).
parse_constant, если определён, будет вызван для следующих строк: "-Infinity", "Infinity", "NaN". Может быть использовано для возбуждения исключений при обнаружении ошибочных чисел JSON.
Если не удастся десериализовать JSON, будет возбуждено исключение ValueError.
json.loads(s, encoding=None, cls=None, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, object_pairs_hook=None, **kw) - десериализует s (экземпляр str, содержащий документ JSON) в объект Python.
Остальные аргументы аналогичны аргументам в load().
Кодировщики и декодировщики
Класс 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
Он также понимает NaN, Infinity, и -Infinity как соответствующие значения float, которые находятся за пределами спецификации JSON.
Класс 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
Для вставки кода на Python в комментарий заключайте его в теги
- Модуль csv - чтение и запись CSV файлов
- Создаём сайт на Django, используя хорошие практики. Часть 1: создаём проект
- Онлайн-обучение Python: сравнение популярных программ
- Книги о Python
- GUI (графический интерфейс пользователя)
- Курсы Python
- Модули
- Новости мира Python
- NumPy
- Обработка данных
- Основы программирования
- Примеры программ
- Типы данных в Python
- Видео
- Python для Web
- Работа для Python-программистов
- Сделай свой вклад в развитие сайта!
- Самоучитель Python
- Карта сайта
- Отзывы на книги по Python
- Реклама на сайте