JSON у Python
Генеруйте класи Python на основі зразка JSON: моделі Pydantic або класи dataclass зі стандартної бібліотеки. Вкладені об’єкти стають окремими класами, оголошеними перед їх використанням; необов’язкові поля та поля, що допускають 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 без змін. У dataclass немає псевдонімів, тому перейменуйте ключі самостійно, перш ніж створювати dataclass із JSON, ключі якого не є допустимими назвами в Python. Зарезервовані слова Python, як-от class, отримують підкреслення в кінці.
Чи завантажується або зберігається мій JSON?
JSON надсилається на сервер лише для генерації коду для цього запиту й не зберігається. Генератор читає лише структуру та типи значень у вашому зразку, тож перед вставленням ви можете замінити конфіденційні значення на заповнювачі того самого типу.