JSON в Python
Создавайте классы Python по образцу JSON: модели Pydantic или классы данных стандартной библиотеки. Вложенные объекты становятся отдельными классами, объявленными до их использования. Для необязательных полей и полей, допускающих null, используется Optional со значением по умолчанию None, если ключ может отсутствовать; для значений разных типов используется Union. Имена полей преобразуются в snake_case.
Часто задаваемые вопросы
Как называются вложенные объекты?
Каждый вложенный объект становится отдельным типом Python с именем ключа, в котором он содержится, в PascalCase: например, address становится Address. Объекты в массивах получают имя в единственном числе от ключа массива: например, users становится User. Объекты с полностью одинаковыми полями используют общий тип.
Когда поле становится необязательным?
Если массив содержит несколько объектов и в некоторых из них отсутствует ключ, соответствующее поле становится необязательным: его тип оборачивается в Optional, а значением по умолчанию становится None. Ключ, присутствующий во всех образцах, обязателен. Для одного объекта не с чем сравнивать, поэтому все его ключи обязательны.
Как обрабатываются значения null?
Если в некоторых образцах ключ имеет значение null, а в других — значение, он становится Optional соответствующего типа. Если ключ всегда равен null, инструмент не может определить его реальный тип, поэтому он становится Optional[Any]; вставьте образец с реальным значением, чтобы получить точный тип.
Какие типы чисел используются?
Целые числа становятся int, а числа с дробной частью — float. Если поле содержит оба вида значений, оно становится float.
Что происходит с недопустимыми именами ключей?
Имена полей преобразуются в snake_case. Модели Pydantic сохраняют исходный ключ с помощью Field(alias=...), поэтому model_validate читает JSON без изменений. У классов данных нет псевдонимов, поэтому перед созданием класса данных переименуйте ключи вручную, если в JSON есть ключи, не являющиеся допустимыми именами Python. Ключевые слова Python, например class, получают подчёркивание в конце.
Загружается или сохраняется ли мой JSON?
JSON отправляется на сервер только для генерации кода по этому запросу и не сохраняется. Генератор считывает только структуру образца и типы значений, поэтому перед вставкой вы можете заменить конфиденциальные значения заполнителями того же типа.